Skip to content

Commit fed892a

Browse files
feat: API Management - Updated UDTs to pending specs (#4122)
## Description Updated user-defined types with pending Azure/Azure-Verified-Modules#1738 & #4098. ## Pipeline Reference <!-- Insert your Pipeline Status Badge below --> | Pipeline | | -------- | | [![avm.res.api-management.service](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.api-management.service.yml/badge.svg?branch=users%2Falsehr%2FapiManagement_udt&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.api-management.service.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
1 parent 059c1c1 commit fed892a

File tree

19 files changed

+320
-372
lines changed

19 files changed

+320
-372
lines changed

avm/res/api-management/service/README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This module deploys an API Management Service. The default deployment is set to
88
- [Usage examples](#Usage-examples)
99
- [Parameters](#Parameters)
1010
- [Outputs](#Outputs)
11+
- [Cross-referenced modules](#Cross-referenced-modules)
1112
- [Notes](#Notes)
1213
- [Data Collection](#Data-Collection)
1314

@@ -1921,7 +1922,7 @@ The diagnostic settings of the service.
19211922
| [`logCategoriesAndGroups`](#parameter-diagnosticsettingslogcategoriesandgroups) | array | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to `[]` to disable log collection. |
19221923
| [`marketplacePartnerResourceId`](#parameter-diagnosticsettingsmarketplacepartnerresourceid) | string | The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. |
19231924
| [`metricCategories`](#parameter-diagnosticsettingsmetriccategories) | array | The name of metrics that will be streamed. "allMetrics" includes all possible metrics for the resource. Set to `[]` to disable metric collection. |
1924-
| [`name`](#parameter-diagnosticsettingsname) | string | The name of diagnostic setting. |
1925+
| [`name`](#parameter-diagnosticsettingsname) | string | The name of the diagnostic setting. |
19251926
| [`storageAccountResourceId`](#parameter-diagnosticsettingsstorageaccountresourceid) | string | Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. |
19261927
| [`workspaceResourceId`](#parameter-diagnosticsettingsworkspaceresourceid) | string | Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. |
19271928

@@ -2031,7 +2032,7 @@ Enable or disable the category explicitly. Default is `true`.
20312032

20322033
### Parameter: `diagnosticSettings.name`
20332034

2034-
The name of diagnostic setting.
2035+
The name of the diagnostic setting.
20352036

20362037
- Required: No
20372038
- Type: string
@@ -2154,7 +2155,7 @@ The managed identity definition for this resource.
21542155
| Parameter | Type | Description |
21552156
| :-- | :-- | :-- |
21562157
| [`systemAssigned`](#parameter-managedidentitiessystemassigned) | bool | Enables system assigned managed identity on the resource. |
2157-
| [`userAssignedResourceIds`](#parameter-managedidentitiesuserassignedresourceids) | array | The resource ID(s) to assign to the resource. |
2158+
| [`userAssignedResourceIds`](#parameter-managedidentitiesuserassignedresourceids) | array | The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption. |
21582159

21592160
### Parameter: `managedIdentities.systemAssigned`
21602161

@@ -2165,7 +2166,7 @@ Enables system assigned managed identity on the resource.
21652166

21662167
### Parameter: `managedIdentities.userAssignedResourceIds`
21672168

2168-
The resource ID(s) to assign to the resource.
2169+
The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption.
21692170

21702171
- Required: No
21712172
- Type: array
@@ -2429,6 +2430,14 @@ A list of availability zones denoting where the resource needs to come from. Onl
24292430
| `resourceId` | string | The resource ID of the API management service. |
24302431
| `systemAssignedMIPrincipalId` | string | The principal ID of the system assigned identity. |
24312432

2433+
## Cross-referenced modules
2434+
2435+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
2436+
2437+
| Reference | Type |
2438+
| :-- | :-- |
2439+
| `br/public:avm/utl/types/avm-common-types:0.4.1` | Remote reference |
2440+
24322441
## Notes
24332442

24342443
The latest version of this module only includes supported versions of the API Management resource. All unsupported versions of API Management have been removed from the related parameters. See the [API Management stv1 platform retirement](https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/stv1-platform-retirement-august-2024) article for more details.

avm/res/api-management/service/api-version-set/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"metadata": {
55
"_generator": {
66
"name": "bicep",
7-
"version": "0.31.34.60546",
8-
"templateHash": "4169716301128870956"
7+
"version": "0.32.4.45862",
8+
"templateHash": "2984286284615323058"
99
},
1010
"name": "API Management Service API Version Sets",
1111
"description": "This module deploys an API Management Service API Version Set.",

avm/res/api-management/service/api/diagnostics/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"metadata": {
55
"_generator": {
66
"name": "bicep",
7-
"version": "0.31.34.60546",
8-
"templateHash": "5353729184860596208"
7+
"version": "0.32.4.45862",
8+
"templateHash": "12634911878831297857"
99
},
1010
"name": "API Management Service APIs Diagnostics.",
1111
"description": "This module deploys an API Management Service API Diagnostics.",

avm/res/api-management/service/api/main.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"metadata": {
66
"_generator": {
77
"name": "bicep",
8-
"version": "0.31.34.60546",
9-
"templateHash": "79502668979653596"
8+
"version": "0.32.4.45862",
9+
"templateHash": "18387862600358779253"
1010
},
1111
"name": "API Management Service APIs",
1212
"description": "This module deploys an API Management Service API.",
@@ -280,8 +280,8 @@
280280
"metadata": {
281281
"_generator": {
282282
"name": "bicep",
283-
"version": "0.31.34.60546",
284-
"templateHash": "7084313641171504315"
283+
"version": "0.32.4.45862",
284+
"templateHash": "907926791460586140"
285285
},
286286
"name": "API Management Service APIs Policies",
287287
"description": "This module deploys an API Management Service API Policy.",
@@ -427,8 +427,8 @@
427427
"metadata": {
428428
"_generator": {
429429
"name": "bicep",
430-
"version": "0.31.34.60546",
431-
"templateHash": "5353729184860596208"
430+
"version": "0.32.4.45862",
431+
"templateHash": "12634911878831297857"
432432
},
433433
"name": "API Management Service APIs Diagnostics.",
434434
"description": "This module deploys an API Management Service API Diagnostics.",

avm/res/api-management/service/api/policy/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"metadata": {
55
"_generator": {
66
"name": "bicep",
7-
"version": "0.31.34.60546",
8-
"templateHash": "7084313641171504315"
7+
"version": "0.32.4.45862",
8+
"templateHash": "907926791460586140"
99
},
1010
"name": "API Management Service APIs Policies",
1111
"description": "This module deploys an API Management Service API Policy.",

avm/res/api-management/service/authorization-server/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"metadata": {
55
"_generator": {
66
"name": "bicep",
7-
"version": "0.31.34.60546",
8-
"templateHash": "7143680740173420481"
7+
"version": "0.32.4.45862",
8+
"templateHash": "524425489707629463"
99
},
1010
"name": "API Management Service Authorization Servers",
1111
"description": "This module deploys an API Management Service Authorization Server.",

avm/res/api-management/service/backend/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"metadata": {
66
"_generator": {
77
"name": "bicep",
8-
"version": "0.31.34.60546",
9-
"templateHash": "8388368953433969607"
8+
"version": "0.32.4.45862",
9+
"templateHash": "2165388618911761186"
1010
},
1111
"name": "API Management Service Backends",
1212
"description": "This module deploys an API Management Service Backend.",

avm/res/api-management/service/cache/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"metadata": {
66
"_generator": {
77
"name": "bicep",
8-
"version": "0.31.34.60546",
9-
"templateHash": "11909687365337883274"
8+
"version": "0.32.4.45862",
9+
"templateHash": "11874790944759917192"
1010
},
1111
"name": "API Management Service Caches",
1212
"description": "This module deploys an API Management Service Cache.",

avm/res/api-management/service/identity-provider/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"metadata": {
66
"_generator": {
77
"name": "bicep",
8-
"version": "0.31.34.60546",
9-
"templateHash": "11902978823059118045"
8+
"version": "0.32.4.45862",
9+
"templateHash": "5753800904617438816"
1010
},
1111
"name": "API Management Service Identity Providers",
1212
"description": "This module deploys an API Management Service Identity Provider.",

avm/res/api-management/service/logger/main.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"metadata": {
55
"_generator": {
66
"name": "bicep",
7-
"version": "0.31.34.60546",
8-
"templateHash": "11518344218995825129"
7+
"version": "0.32.4.45862",
8+
"templateHash": "18266779272587485714"
99
},
1010
"name": "API Management Service Loggers",
1111
"description": "This module deploys an API Management Service Logger.",

0 commit comments

Comments
 (0)