Bicep Module Documentation
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| identity | identity | Managed service identity |
| sku (required) | 'Free' 'Standard' |
|
| allowConfigFileUpdates | bool | Set to false if config file is locked for this static web app, otherwise set to true. (default: true) |
| branch | string | The target branch in the repository. |
| buildProperties | buildProperties | Build properties to configure on the repository. |
| enterpriseGradeCdnStatus | 'Disabled' 'Enabled' |
State indicating the status of the enterprise grade CDN serving traffic to the static web app. (default: Disabled) |
| publicNetworkAccess | 'Disabled' 'Enabled' |
State indicating whether public traffic is allowed or not to the static web app. (default: Enabled) |
| repositoryToken | string | A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. |
| repositoryUrl | string | URL for the repository of the static site. |
| stagingEnvironmentPolicy | 'Disabled' 'Enabled' |
State indicating whether staging environments are allowed or not allowed for a static web app. (default: Enabled) |
| templateProperties | templateProperties | Template options for generating a new repository. |
| privateLink | privateLink |
| Property | Value | Description |
|---|---|---|
| type | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
The types of identities associated with this resource. (default: none) |
| userAssignedIdentities | string[] | Resource IDs of User Assigned Identities to associate with this resource |
| Property | Value | Description |
|---|---|---|
| apiBuildCommand | string | A custom command to run during deployment of the Azure Functions API application. |
| apiLocation | string | The path to the api code within the repository. |
| appBuildCommand | string | A custom command to run during deployment of the static content application. |
| appLocation | string | The path to the app code within the repository. |
| githubActionSecretNameOverride | string | Github Action secret name override. |
| outputLocation | string | The output path of the app after building. |
| skipGithubActionWorkflowGeneration | bool | Skip Github Action workflow generation. |
| Property | Value | Description |
|---|---|---|
| description | string | Description of the newly generated repository. |
| isPrivate | bool | Whether or not the newly generated repository is a private repository. (default: false) |
| owner | string | Owner of the newly generated repository. |
| repositoryName | string | Name of the newly generated repository. |
| templateRepositoryUrl | string | URL of the template repository. The newly generated repository will be based on this one. |
| Property | Value | Description |
|---|---|---|
| forceFunctionAsFullName | bool | Use the function value as the full name of the resource |
| abbreviation | string | Override the abbreviation of this resource with this parameter |
| environment | string | The resource environment (for example: dev, tst, acc, prd) |
| location | string | The resource location (for example: weu, we, westeurope) |
| customer | string | The name of the customer |
| delimiter | string | The delimiter between resources (default: -) |
| nameFormat | Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName' |
The order of the array defines the order of elements in the naming scheme |
| param1 | string | Extra parameter self defined |
| param2 | string | Extra parameter self defined |
| param3 | string | Extra parameter self defined |
| function (required) | string | Function of the resource [can be app, db, security,...] |
| useCaseName | string | Name of the use case [can be hub, spoke,...] |
| suffix | string | Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...] |
| forceDefaultNaming | bool | Force the CAF naming instead of default company naming |
| Property | Value | Description |
|---|---|---|
| name | string | Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period. |
| level (required) | 'CanNotDelete' 'ReadOnly' |
The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again |
| notes | string | Notes about the lock. Maximum of 512 characters. |
| owners | resourceLockOwner[] | The owners of the lock |
| Property | Value | Description |
|---|---|---|
| applicationId (required) | string | The application ID of the lock owner. |
| Property | Value | Description |
|---|---|---|
| principalId (required) | string | The principal ID |
| roleDefinitionId (required) | string | The role definition ID, data file can be used for this |
| condition | string | Condition on the role assignment |
| conditionVersion | string | Version of the condition. Currently the only accepted value is "2.0" |
| delegatedManagedIdentityResourceId | string | Id of the delegated managed identity resource |
| description | string | Description of role assignment |
| Property | Value | Description |
|---|---|---|
| tags | object | Tags of the resource [hashtable] |
| location (required) | string | Location of the resource |
| naming (required) | naming | Naming module of the resource |
| resourceGroupName (required) | string | Name of the resource group where the resource should be located |
| sharedNaming (required) | naming | Reference to the default naming |
| roleAssignments | roleAssignment[] | Role assignments on the resource |
| resourceLocks | resourceLock[] | Resource Locks on the resource |
| Property | Value | Description |
|---|---|---|
| pepNaming | naming | Name of the private endpoint |
| nicNaming | naming | Name of the network interface of the private endpoint |
| privateLinkNaming | naming | Name of the private link connection |
| subnets (required) | subnets[] | Id of the subnets and optionally the name of the resourcegroup in which the private endpoint should be created |
| dnsZoneIds (required) | string[] | List of DNS zone ids that need to be linked |
| Property | Value | Description |
|---|---|---|
| resourceGroupName | string | Resourcegroup (default: resourcegroup defined here => resourceGroup of pep resource => resourceGroup of subnet) |
| id (required) | string | Id of the subnet |
| location | string | Location if Vnet is in different location |