Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Run the Set-AVMModule script to update the files of ptn module azd/apim-api #3256

Merged
merged 4 commits into from
Sep 12, 2024
Merged

fix: Run the Set-AVMModule script to update the files of ptn module azd/apim-api #3256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee7515c
update
jianingwang123 Sep 12, 2024
b7df89b
update
jianingwang123 Sep 12, 2024
d9383a9
remove
jianingwang123 Sep 12, 2024
9668de6
Merge branch 'main' into fix/new
jianingwang123 Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions avm/ptn/azd/apim-api/README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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