Skip to content

Commit 72f2207

Browse files
feat: Web-Static-Site - Updated UDTs to pending specs (#4100)
## Description Updated user-defined types with pending Azure/Azure-Verified-Modules#1738 & #4098. ## Pipeline Reference <!-- Insert your Pipeline Status Badge below --> | Pipeline | | -------- | [![avm.res.web.static-site](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.web.static-site.yml/badge.svg?branch=users%2Falsehr%2Favm.res.web.static-site_udt&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.res.web.static-site.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 b985d5f commit 72f2207

File tree

9 files changed

+412
-519
lines changed

9 files changed

+412
-519
lines changed

avm/res/web/static-site/README.md

Lines changed: 26 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,7 @@ This instance deploys the module with the minimum set of required parameters.
4949
module staticSite 'br/public:avm/res/web/static-site:<version>' = {
5050
name: 'staticSiteDeployment'
5151
params: {
52-
// Required parameters
5352
name: 'wssmin001'
54-
// Non-required parameters
55-
location: '<location>'
5653
}
5754
}
5855
```
@@ -69,13 +66,8 @@ module staticSite 'br/public:avm/res/web/static-site:<version>' = {
6966
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
7067
"contentVersion": "1.0.0.0",
7168
"parameters": {
72-
// Required parameters
7369
"name": {
7470
"value": "wssmin001"
75-
},
76-
// Non-required parameters
77-
"location": {
78-
"value": "<location>"
7971
}
8072
}
8173
}
@@ -91,10 +83,7 @@ module staticSite 'br/public:avm/res/web/static-site:<version>' = {
9183
```bicep-params
9284
using 'br/public:avm/res/web/static-site:<version>'
9385
94-
// Required parameters
9586
param name = 'wssmin001'
96-
// Non-required parameters
97-
param location = '<location>'
9887
```
9988

10089
</details>
@@ -445,11 +434,6 @@ module staticSite 'br/public:avm/res/web/static-site:<version>' = {
445434
linkedBackend: {
446435
resourceId: '<resourceId>'
447436
}
448-
location: '<location>'
449-
lock: {
450-
kind: 'CanNotDelete'
451-
name: 'myCustomLockName'
452-
}
453437
privateEndpoints: [
454438
{
455439
privateDnsZoneGroup: {
@@ -518,15 +502,6 @@ module staticSite 'br/public:avm/res/web/static-site:<version>' = {
518502
"resourceId": "<resourceId>"
519503
}
520504
},
521-
"location": {
522-
"value": "<location>"
523-
},
524-
"lock": {
525-
"value": {
526-
"kind": "CanNotDelete",
527-
"name": "myCustomLockName"
528-
}
529-
},
530505
"privateEndpoints": {
531506
"value": [
532507
{
@@ -589,11 +564,6 @@ param functionAppSettings = {
589564
param linkedBackend = {
590565
resourceId: '<resourceId>'
591566
}
592-
param location = '<location>'
593-
param lock = {
594-
kind: 'CanNotDelete'
595-
name: 'myCustomLockName'
596-
}
597567
param privateEndpoints = [
598568
{
599569
privateDnsZoneGroup: {
@@ -799,7 +769,7 @@ The managed identity definition for this resource.
799769
| Parameter | Type | Description |
800770
| :-- | :-- | :-- |
801771
| [`systemAssigned`](#parameter-managedidentitiessystemassigned) | bool | Enables system assigned managed identity on the resource. |
802-
| [`userAssignedResourceIds`](#parameter-managedidentitiesuserassignedresourceids) | array | The resource ID(s) to assign to the resource. |
772+
| [`userAssignedResourceIds`](#parameter-managedidentitiesuserassignedresourceids) | array | The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption. |
803773

804774
### Parameter: `managedIdentities.systemAssigned`
805775

@@ -810,7 +780,7 @@ Enables system assigned managed identity on the resource.
810780

811781
### Parameter: `managedIdentities.userAssignedResourceIds`
812782

813-
The resource ID(s) to assign to the resource.
783+
The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption.
814784

815785
- Required: No
816786
- Type: array
@@ -832,22 +802,22 @@ Configuration details for private endpoints. For security reasons, it is recomme
832802

833803
| Parameter | Type | Description |
834804
| :-- | :-- | :-- |
835-
| [`applicationSecurityGroupResourceIds`](#parameter-privateendpointsapplicationsecuritygroupresourceids) | array | Application security groups in which the private endpoint IP configuration is included. |
805+
| [`applicationSecurityGroupResourceIds`](#parameter-privateendpointsapplicationsecuritygroupresourceids) | array | Application security groups in which the Private Endpoint IP configuration is included. |
836806
| [`customDnsConfigs`](#parameter-privateendpointscustomdnsconfigs) | array | Custom DNS configurations. |
837-
| [`customNetworkInterfaceName`](#parameter-privateendpointscustomnetworkinterfacename) | string | The custom name of the network interface attached to the private endpoint. |
807+
| [`customNetworkInterfaceName`](#parameter-privateendpointscustomnetworkinterfacename) | string | The custom name of the network interface attached to the Private Endpoint. |
838808
| [`enableTelemetry`](#parameter-privateendpointsenabletelemetry) | bool | Enable/Disable usage telemetry for module. |
839-
| [`ipConfigurations`](#parameter-privateendpointsipconfigurations) | array | A list of IP configurations of the private endpoint. This will be used to map to the First Party Service endpoints. |
809+
| [`ipConfigurations`](#parameter-privateendpointsipconfigurations) | array | A list of IP configurations of the Private Endpoint. This will be used to map to the first-party Service endpoints. |
840810
| [`isManualConnection`](#parameter-privateendpointsismanualconnection) | bool | If Manual Private Link Connection is required. |
841-
| [`location`](#parameter-privateendpointslocation) | string | The location to deploy the private endpoint to. |
811+
| [`location`](#parameter-privateendpointslocation) | string | The location to deploy the Private Endpoint to. |
842812
| [`lock`](#parameter-privateendpointslock) | object | Specify the type of lock. |
843813
| [`manualConnectionRequestMessage`](#parameter-privateendpointsmanualconnectionrequestmessage) | string | A message passed to the owner of the remote resource with the manual connection request. |
844-
| [`name`](#parameter-privateendpointsname) | string | The name of the private endpoint. |
845-
| [`privateDnsZoneGroup`](#parameter-privateendpointsprivatednszonegroup) | object | The private DNS zone group to configure for the private endpoint. |
814+
| [`name`](#parameter-privateendpointsname) | string | The name of the Private Endpoint. |
815+
| [`privateDnsZoneGroup`](#parameter-privateendpointsprivatednszonegroup) | object | The private DNS Zone Group to configure for the Private Endpoint. |
846816
| [`privateLinkServiceConnectionName`](#parameter-privateendpointsprivatelinkserviceconnectionname) | string | The name of the private link connection to create. |
847-
| [`resourceGroupName`](#parameter-privateendpointsresourcegroupname) | string | Specify if you want to deploy the Private Endpoint into a different resource group than the main resource. |
817+
| [`resourceGroupResourceId`](#parameter-privateendpointsresourcegroupresourceid) | string | The resource ID of the Resource Group the Private Endpoint will be created in. If not specified, the Resource Group of the provided Virtual Network Subnet is used. |
848818
| [`roleAssignments`](#parameter-privateendpointsroleassignments) | array | Array of role assignments to create. |
849-
| [`service`](#parameter-privateendpointsservice) | string | The subresource to deploy the private endpoint for. For example "vault", "mysqlServer" or "dataFactory". |
850-
| [`tags`](#parameter-privateendpointstags) | object | Tags to be applied on all resources/resource groups in this deployment. |
819+
| [`service`](#parameter-privateendpointsservice) | string | The subresource to deploy the Private Endpoint for. For example "vault" for a Key Vault Private Endpoint. |
820+
| [`tags`](#parameter-privateendpointstags) | object | Tags to be applied on all resources/Resource Groups in this deployment. |
851821

852822
### Parameter: `privateEndpoints.subnetResourceId`
853823

@@ -858,7 +828,7 @@ Resource ID of the subnet where the endpoint needs to be created.
858828

859829
### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds`
860830

861-
Application security groups in which the private endpoint IP configuration is included.
831+
Application security groups in which the Private Endpoint IP configuration is included.
862832

863833
- Required: No
864834
- Type: array
@@ -898,7 +868,7 @@ FQDN that resolves to private endpoint IP address.
898868

899869
### Parameter: `privateEndpoints.customNetworkInterfaceName`
900870

901-
The custom name of the network interface attached to the private endpoint.
871+
The custom name of the network interface attached to the Private Endpoint.
902872

903873
- Required: No
904874
- Type: string
@@ -912,7 +882,7 @@ Enable/Disable usage telemetry for module.
912882

913883
### Parameter: `privateEndpoints.ipConfigurations`
914884

915-
A list of IP configurations of the private endpoint. This will be used to map to the First Party Service endpoints.
885+
A list of IP configurations of the Private Endpoint. This will be used to map to the first-party Service endpoints.
916886

917887
- Required: No
918888
- Type: array
@@ -976,7 +946,7 @@ If Manual Private Link Connection is required.
976946

977947
### Parameter: `privateEndpoints.location`
978948

979-
The location to deploy the private endpoint to.
949+
The location to deploy the Private Endpoint to.
980950

981951
- Required: No
982952
- Type: string
@@ -1026,14 +996,14 @@ A message passed to the owner of the remote resource with the manual connection
1026996

1027997
### Parameter: `privateEndpoints.name`
1028998

1029-
The name of the private endpoint.
999+
The name of the Private Endpoint.
10301000

10311001
- Required: No
10321002
- Type: string
10331003

10341004
### Parameter: `privateEndpoints.privateDnsZoneGroup`
10351005

1036-
The private DNS zone group to configure for the private endpoint.
1006+
The private DNS Zone Group to configure for the Private Endpoint.
10371007

10381008
- Required: No
10391009
- Type: object
@@ -1042,7 +1012,7 @@ The private DNS zone group to configure for the private endpoint.
10421012

10431013
| Parameter | Type | Description |
10441014
| :-- | :-- | :-- |
1045-
| [`privateDnsZoneGroupConfigs`](#parameter-privateendpointsprivatednszonegroupprivatednszonegroupconfigs) | array | The private DNS zone groups to associate the private endpoint. A DNS zone group can support up to 5 DNS zones. |
1015+
| [`privateDnsZoneGroupConfigs`](#parameter-privateendpointsprivatednszonegroupprivatednszonegroupconfigs) | array | The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group can support up to 5 DNS zones. |
10461016

10471017
**Optional parameters**
10481018

@@ -1052,7 +1022,7 @@ The private DNS zone group to configure for the private endpoint.
10521022

10531023
### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs`
10541024

1055-
The private DNS zone groups to associate the private endpoint. A DNS zone group can support up to 5 DNS zones.
1025+
The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group can support up to 5 DNS zones.
10561026

10571027
- Required: Yes
10581028
- Type: array
@@ -1067,7 +1037,7 @@ The private DNS zone groups to associate the private endpoint. A DNS zone group
10671037

10681038
| Parameter | Type | Description |
10691039
| :-- | :-- | :-- |
1070-
| [`name`](#parameter-privateendpointsprivatednszonegroupprivatednszonegroupconfigsname) | string | The name of the private DNS zone group config. |
1040+
| [`name`](#parameter-privateendpointsprivatednszonegroupprivatednszonegroupconfigsname) | string | The name of the private DNS Zone Group config. |
10711041

10721042
### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.privateDnsZoneResourceId`
10731043

@@ -1078,7 +1048,7 @@ The resource id of the private DNS zone.
10781048

10791049
### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name`
10801050

1081-
The name of the private DNS zone group config.
1051+
The name of the private DNS Zone Group config.
10821052

10831053
- Required: No
10841054
- Type: string
@@ -1097,9 +1067,9 @@ The name of the private link connection to create.
10971067
- Required: No
10981068
- Type: string
10991069

1100-
### Parameter: `privateEndpoints.resourceGroupName`
1070+
### Parameter: `privateEndpoints.resourceGroupResourceId`
11011071

1102-
Specify if you want to deploy the Private Endpoint into a different resource group than the main resource.
1072+
The resource ID of the Resource Group the Private Endpoint will be created in. If not specified, the Resource Group of the provided Virtual Network Subnet is used.
11031073

11041074
- Required: No
11051075
- Type: string
@@ -1214,14 +1184,14 @@ The principal type of the assigned principal ID.
12141184

12151185
### Parameter: `privateEndpoints.service`
12161186

1217-
The subresource to deploy the private endpoint for. For example "vault", "mysqlServer" or "dataFactory".
1187+
The subresource to deploy the Private Endpoint for. For example "vault" for a Key Vault Private Endpoint.
12181188

12191189
- Required: No
12201190
- Type: string
12211191

12221192
### Parameter: `privateEndpoints.tags`
12231193

1224-
Tags to be applied on all resources/resource groups in this deployment.
1194+
Tags to be applied on all resources/Resource Groups in this deployment.
12251195

12261196
- Required: No
12271197
- Type: object
@@ -1416,6 +1386,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
14161386
| Reference | Type |
14171387
| :-- | :-- |
14181388
| `br/public:avm/res/network/private-endpoint:0.7.1` | Remote reference |
1389+
| `br/public:avm/utl/types/avm-common-types:0.5.1` | Remote reference |
14191390

14201391
## Data Collection
14211392

avm/res/web/static-site/config/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.29.47.4906",
8-
"templateHash": "6259766574135261184"
7+
"version": "0.32.4.45862",
8+
"templateHash": "12417882875937943110"
99
},
1010
"name": "Static Web App Site Config",
1111
"description": "This module deploys a Static Web App Site Config.",

avm/res/web/static-site/custom-domain/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.29.47.4906",
8-
"templateHash": "4543869723891386084"
7+
"version": "0.32.4.45862",
8+
"templateHash": "17822583666603036855"
99
},
1010
"name": "Static Web App Site Custom Domains",
1111
"description": "This module deploys a Static Web App Site Custom Domain.",

avm/res/web/static-site/linked-backend/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.29.47.4906",
8-
"templateHash": "12808204824131403769"
7+
"version": "0.32.4.45862",
8+
"templateHash": "14348367227898397100"
99
},
1010
"name": "Static Web App Site Linked Backends",
1111
"description": "This module deploys a Custom Function App into a Static Web App Site using the Linked Backends property.",

0 commit comments

Comments
 (0)