Skip to content

Commit

Permalink
fix: Run the Set-AVMModule script to update the files of ptn module…
Browse files Browse the repository at this point in the history
… `azd/apim-api` (#3256)

## Description
Fixes
[comment](#3206 (comment))
adout static test failed of ptn modules `azd/apim-api`.
<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes #123
Fixes #456
Closes #123
Closes #456
-->

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.ptn.azd.apim-api](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml/badge.svg?branch=fix%2Fnew)](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml)
|

## Type of Change

<!-- Use the checkboxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utilities (Non-module affecting
changes)
- [x] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to date with the contribution guide at
https://aka.ms/avm/contribute/bicep -->
@jongio for notification.
  • Loading branch information
jianingwang123 authored Sep 12, 2024
1 parent dc730bd commit 5e3198e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 12 deletions.
11 changes: 2 additions & 9 deletions avm/ptn/azd/apim-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Creates and configure an API within an API Management service instance.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -104,7 +103,6 @@ module apimApi 'br/public:avm/ptn/azd/apim-api:<version>' = {
</details>
<p>


## Parameters

**Required parameters**
Expand All @@ -117,7 +115,7 @@ module apimApi 'br/public:avm/ptn/azd/apim-api:<version>' = {
| [`apiName`](#parameter-apiname) | string | Resource name to uniquely identify this API within the API Management service instance. |
| [`apiPath`](#parameter-apipath) | string | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. |
| [`name`](#parameter-name) | string | Name of the API Management service instance. |
| [`webFrontendUrl`](#parameter-webfrontendurl) | string | Absolute URL of the web frontend. |
| [`webFrontendUrl`](#parameter-webfrontendurl) | string | Absolute URL of web frontend. |

**Optional parameters**

Expand Down Expand Up @@ -171,7 +169,7 @@ Name of the API Management service instance.

### Parameter: `webFrontendUrl`

Absolute URL of the web frontend.
Absolute URL of web frontend.

- Required: Yes
- Type: string
Expand Down Expand Up @@ -200,18 +198,13 @@ Location for all Resources.
- Type: string
- Default: `[resourceGroup().location]`


## Outputs

| Output | Type | Description |
| :-- | :-- | :-- |
| `resourceGroupName` | string | The name of the resource group. |
| `serviceApiUri` | string | The complete URL for accessing the API. |

## Cross-referenced modules

_None_

## Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
2 changes: 1 addition & 1 deletion avm/ptn/azd/apim-api/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ param apiDescription string
@minLength(1)
param apiPath string

@description('Required. Absolute URL of the web frontend.')
@description('Required. Absolute URL of web frontend.')
param webFrontendUrl string

@description('Optional. Location for all Resources.')
Expand Down
4 changes: 2 additions & 2 deletions avm/ptn/azd/apim-api/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"_generator": {
"name": "bicep",
"version": "0.29.47.4906",
"templateHash": "7935494033060946539"
"templateHash": "1542387667896789833"
},
"name": "avm/ptn/azd/apim-api",
"description": "Creates and configure an API within an API Management service instance.\n\n**Note:** This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case.",
Expand Down Expand Up @@ -50,7 +50,7 @@
"webFrontendUrl": {
"type": "string",
"metadata": {
"description": "Required. Absolute URL of the web frontend."
"description": "Required. Absolute URL of web frontend."
}
},
"location": {
Expand Down

0 comments on commit 5e3198e

Please sign in to comment.