Bicep Module Documentation
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| kind (required) | 'app' 'app,container,windows' 'app,linux' 'app,linux,container' 'app,linux,container,kubernetes' 'app,linux,kubernetes' 'functionapp' 'functionapp,linux' 'functionapp,linux,container,kubernetes' 'functionapp,linux,kubernetes' 'hyperV' |
What kind of App Service to create. |
| identity | identity | Managed service identity |
| clientAffinityEnabled | bool | true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. |
| clientCertEnabled | bool | true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. |
| clientCertExclusionPaths | string | client certificate authentication comma-separated exclusion paths |
| clientCertMode | 'Optional' 'OptionalInteractiveUser' 'Required' |
This composes with ClientCertEnabled setting. ClientCertEnabled: false means ClientCert is ignored. ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. |
| containerSize | int | Size of the function container. |
| dailyMemoryTimeQuota | int | Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
| enabled | bool | true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). |
| hostingEnvironmentProfileId | string | App Service Environment to use for the app. Resource ID of the App Service Environment. |
| hostNamesDisabled | bool | true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. |
| hostNameSslStates | appServiceHostNameSslStates[] | Hostname SSL states are used to manage the SSL bindings for apps hostnames. |
| httpsOnly | bool | HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests |
| functionAppConfig | functionAppConfig | |
| hyperV | bool | Hyper-V sandbox |
| keyVaultReferenceIdentity | string | Identity to use for Key Vault Reference authentication. |
| managedEnvironmentId | string | Azure Resource Manager ID of the customers selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} |
| publicNetworkAccess | 'Disabled' 'Enabled' |
Property to allow or block all public traffic. Allowed Values: Enabled, Disabled or an empty string. (default: Disabled) |
| redundancyMode | 'ActiveActive' 'Failover' 'GeoRedundant' 'Manual' 'None' |
Site redundancy mode |
| reserved | bool | true if reserved; otherwise, false |
| scmSiteAlsoStopped | bool | true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. |
| serverFarmId (required) | string | Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
| siteConfig | siteConfig | Configuration of the app. |
| slots | slots[] | List of deployment slots. Each slot inherits the app's identity, keyVaultReferenceIdentity, httpsOnly, publicNetworkAccess (unless overridden per slot) and VNet integration, and gets its own private endpoint (group id sites- |
| diagnosticSettings | diagnosticSetting[] | Diagnostic Settings for the resource. |
| slotConfigNames | slotConfigNames | |
| storageAccountRequired | bool | Checks if Customer provided storage account is required |
| virtualNetworkSubnetId | string | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} |
| outboundVnetRouting | outboundVnetRouting | Property to configure various outbound traffic routing options over virtual network for a site. |
| privateLink | privateLink | Settings for the private endpoint and private link for this resource |
| hostNameBindings | appServiceHostNameBinding[] | Add hostname(s) to app service |
| sourceControls | sourceControl | Source Controls in the app service |
| authSettingsV2 | appServiceAuthSettingsV2 | Authentication / Authorization (Easy Auth) V2 settings of the app service (Microsoft.Web/sites/config authsettingsV2). |
| 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 |
|---|---|---|
| storageAccountConnectionStringName | string | Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. |
| type (required) | 'StorageAccountConnectionString' 'SystemAssignedIdentity' 'UserAssignedIdentity' |
Property to select authentication type to access the selected storage account. |
| userAssignedIdentityResourceId | string | Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. |
| Property | Value | Description |
|---|---|---|
| authentication (required) | authentication | |
| value (required) | string | |
| type (required) | 'blobContainer' |
| Property | Value | Description |
|---|---|---|
| storage (required) | storage |
| Property | Value | Description |
|---|---|---|
| name (required) | 'custom' 'dotnet-isolated' 'java' 'node' 'powershell' 'python' |
|
| version (required) | string |
| Property | Value | Description |
|---|---|---|
| instanceCount (required) | int | |
| name (required) | string |
| Property | Value | Description |
|---|---|---|
| perInstanceConcurrency (required) | int |
| Property | Value | Description |
|---|---|---|
| http (required) | http |
| Property | Value | Description |
|---|---|---|
| alwaysReady | alwaysReady[] | |
| instanceMemoryMB | int | |
| maximumInstanceCount | int | |
| triggers | triggers |
| Property | Value | Description |
|---|---|---|
| deployment (required) | deployment | |
| runtime (required) | runtime | |
| scaleAndConcurrency | scaleAndConcurrency |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Name of the deployment slot. |
| publicNetworkAccess | 'Disabled' 'Enabled' |
Overrides the app's publicNetworkAccess for this slot, e.g. to test it from a restricted set of IPs (siteConfig.ipSecurityRestrictions) before a swap. |
| siteConfig | siteConfig | Configuration of the deployment slot. |
| Property | Value | Description |
|---|---|---|
| appSettingNames | string[] | Names for application settings to be marked as sticky to the deployment slot and not moved during a swap operation. This is valid for all deployment slots in the app. |
| azureStorageConfigNames | string[] | Names for external Azure storage account configuration identifiers to be marked as sticky to the deployment slot and not moved during a swap operation. This is valid for all deployment slots in the app. |
| connectionStringNames | string[] | Names for connection strings to be marked as sticky to the deployment slot and not moved during a swap operation. This is valid for all deployment slots in the app. |
| Property | Value | Description |
|---|---|---|
| allTraffic | bool | Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. |
| applicationTraffic | bool | This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. |
| backupRestoreTraffic | bool | Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled |
| contentShareTraffic | bool | Enables accessing content over virtual network. Previously called VnetContentShareEnabled |
| imagePullTraffic | bool | Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. |
| Property | Value | Description |
|---|---|---|
| acrUseManagedIdentityCreds | bool | Flag to use Managed Identity Creds for ACR pull |
| acrUserManagedIdentityID | string | If using user managed identity, the user managed identity ClientId |
| alwaysOn | bool | true if Always On is enabled; otherwise, false |
| apiDefinition | apiDefinition | Information about the formal API definition for the app. The URL of the API definition. |
| apiManagementConfig | apiManagementConfig | Azure API management settings linked to the app. APIM-Api Identifier. |
| appCommandLine | string | App command line to launch. |
| appSettings | appServiceAppSettings[] | Application settings |
| autoHealEnabled | bool | true if Auto Heal is enabled; otherwise, false. |
| autoHealRules | autoHealRules | Auto Heal rules. |
| autoSwapSlotName | string | Auto-swap slot name. |
| azureStorageAccounts | object | List o Azure Storage Accounts. |
| connectionStrings | appServiceConnStringInfo[] | Connection strings. |
| cors | cors | Cross-Origin Resource Sharing (CORS) settings. |
| defaultDocuments | string[] | Default Documents. |
| detailedErrorLoggingEnabled | bool | true if detailed error logging is enabled; otherwise, false. |
| documentRoot | string | Document root |
| elasticWebAppScaleLimit | int | Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true |
| ftpsState | 'AllAllowed' 'Disabled' 'FtpsOnly' |
State of FTP / FTPS service (default: disabled) |
| functionAppScaleLimit | int | Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans |
| functionsRuntimeScaleMonitoringEnabled | bool | Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. |
| handlerMappings | appServiceHandlerMappings[] | Handler mappings. |
| healthCheckPath | string | Health check path |
| http20Enabled | bool | Http20Enabled: configures a web site to allow clients to connect over http2.0 |
| http20ProxyFlag | '0' '1' '2' |
Http20ProxyFlag: how HTTP/2 traffic is proxied to the app. 0 = not proxied, 1 = all HTTP/2 traffic, 2 = gRPC only. |
| httpLoggingEnabled | bool | true if HTTP logging is enabled; otherwise, false. |
| ipSecurityRestrictions | appServiceIpSecurityRestrictions[] | IP security restrictions for main. |
| ipSecurityRestrictionsDefaultAction | 'Allow' 'Deny' |
Default action for main access restriction if no rules are matched. |
| javaContainer | string | Java container |
| javaContainerVersion | string | Java container version |
| javaVersion | string | Java version |
| keyVaultReferenceIdentity | string | Identity to use for Key Vault Reference authentication |
| limits | limits | Limits |
| linuxFxVersion | string | Linux App Framework and version |
| loadBalancing | 'LeastRequests' 'LeastResponseTime' 'PerSiteRoundRobin' 'RequestHash' 'WeightedRoundRobin' 'WeightedTotalTraffic' |
Site load balancing |
| localMySqlEnabled | bool | true to enable local MySQL; otherwise, false. |
| logsDirectorySizeLimit | int | HTTP logs directory size limit. |
| managedPipelineMode | 'Classic' 'Integrated' |
Managed pipeline mode. |
| managedServiceIdentityId | int | Managed Service Identity Id |
| metadata | metadata[] | Application metadata. This property cannot be retrieved, since it may contain secrets. |
| minimumElasticInstanceCount | int | Number of minimum instance count for a site. This setting only applies to the Elastic Plans |
| minTlsVersion | '1.0' '1.1' '1.2' '1.3' |
MinTlsVersion: configures the minimum version of TLS required for SSL requests |
| netFrameworkVersion | string | .NET Framework version. |
| nodeVersion | string | Version of Node.js |
| numberOfWorkers | int | Number of workers |
| phpVersion | string | Version of PHP |
| powerShellVersion | string | Version of PowerShell |
| preWarmedInstanceCount | int | Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans |
| publicNetworkAccess | string | Property to allow or block all public traffic |
| publishingUsername | string | Publishing user name |
| pythonVersion | string | Version of Python |
| remoteDebuggingEnabled | bool | true if remote debugging is enabled; otherwise, false |
| remoteDebuggingVersion | string | Remote debugging version |
| requestTracingEnabled | bool | true if request tracing is enabled; otherwise, false |
| requestTracingExpirationTime | string | Request tracing expiration time |
| scmIpSecurityRestrictions | appServiceScmIpSecurityRestrictions[] | IP security restrictions for scm. |
| scmIpSecurityRestrictionsDefaultAction | 'Allow' 'Deny' |
Default action for scm access restriction if no rules are matched |
| scmIpSecurityRestrictionsUseMain | bool | IP security restrictions for scm to use main |
| scmMinTlsVersion | '1.0' '1.1' '1.2' '1.3' |
ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site |
| scmType | 'BitBucketGit' 'BitbucketHg' 'CodePlexGit' 'CodePlexHg' 'Dropbox' 'ExternalGit' 'ExternalHg' 'GitHub' 'LocalGit' 'None' 'OneDrive' 'Tfs' 'VSO' 'VSTSRM' |
SCM type |
| tracingOptions | string | Tracing options |
| use32BitWorkerProcess | bool | true to use 32-bit worker process; otherwise, false |
| virtualApplications | appServiceVirtualApplications[] | Virtual applications. |
| vnetName | string | Virtual Network name |
| vnetPrivatePortsCount | int | The number of private ports assigned to this app. These will be assigned dynamically on runtime |
| vnetRouteAllEnabled | bool | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied |
| websiteTimeZone | string | Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE-SOFTWARE-Microsoft-Windows NT-CurrentVersion-Time Zones |
| webSocketsEnabled | bool | true if WebSocket is enabled; otherwise, false |
| windowsFxVersion | string | Xenon App Framework and version |
| xManagedServiceIdentityId | int | Explicit Managed Service Identity Id |
| Property | Value | Description |
|---|---|---|
| url (required) | string |
| Property | Value | Description |
|---|---|---|
| id (required) | string |
| Property | Value | Description |
|---|---|---|
| actions | appServiceAutoHealRuleActions | Actions to be executed when a rule is triggered. |
| triggers | appServiceAutoHealRuleTriggers | Conditions that describe when to execute the auto-heal actions. |
| Property | Value | Description |
|---|---|---|
| allowedOrigins | string[] | Cross-Origin Resource Sharing (CORS) settings. Gets or sets the list of origins that should be allowed to make cross-origincalls (for example: http://example.com:12345). Use "*" to allow all. |
| supportCredentials | bool | Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. |
| Property | Value | Description |
|---|---|---|
| maxDiskSizeInMb | int | |
| maxMemoryInMb | int | |
| maxPercentageCpu | int |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Pair name |
| value (required) | string | Pair value |
| Property | Value | Description |
|---|---|---|
| hostType | 'Repository' 'Standard' |
Indicates whether the hostname is a standard or repository hostname. |
| name (required) | string | Hostname |
| sslState (required) | 'Disabled' 'IpBasedEnabled' 'SniEnabled' |
SSL type. |
| thumbprint | string | SSL certificate thumbprint. |
| toUpdate | bool | Set to true to update existing hostname. |
| virtualIP | string | Virtual IP address assigned to the hostname if IP based SSL is enabled. |
| Property | Value | Description |
|---|---|---|
| physicalPath | string | Physical path. |
| preloadEnabled | bool | true if preloading is enabled; otherwise, false. |
| virtualDirectories | appServiceVirtualDirectory[] | Virtual directories for virtual application. |
| virtualPath | string | Virtual path. |
| Property | Value | Description |
|---|---|---|
| physicalPath | string | Physical path. |
| virtualPath | string | Path to virtual application. |
| Property | Value | Description |
|---|---|---|
| connectionString (required) | string | Connection string value. |
| name (required) | string | Name of connection string. |
| type (required) | 'ApiHub' 'Custom' 'DocDb' 'EventHub' 'MySql' 'NotificationHub' 'PostgreSQL' 'RedisCache' 'SQLAzure' 'SQLServer' 'ServiceBus' |
Type of database. |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Pair name. |
| value (required) | string | Pair value. |
| Property | Value | Description |
|---|---|---|
| actionType (required) | 'CustomAction' 'LogEvent' 'Recycle' |
Predefined action to be taken. |
| customAction | appServiceAutoHealCustomAction | Custom action to be taken. |
| minProcessExecutionTime (required) | string | Minimum time the process must execute before taking the action |
| Property | Value | Description |
|---|---|---|
| privateBytesInKB | int | A rule based on private bytes. |
| requests | requests | A rule based on total requests. |
| slowRequests | slowRequests | A rule based on request execution time. |
| slowRequestsWithPath | appServiceAutoHealTriggerSlowRequestsWithPath[] | A rule based on multiple Slow Requests Rule with path |
| statusCodes | appServiceAutoHealTriggerStatusCodes[] | A rule based on status codes. |
| statusCodesRange | appServiceAutoHealTriggerStatusCodesRange[] | A rule based on status codes ranges. |
| Property | Value | Description |
|---|---|---|
| count (required) | int | Request Count. |
| timeInterval (required) | string | Time interval. |
| Property | Value | Description |
|---|---|---|
| count (required) | int | Request Count. |
| path (required) | string | Request Path. |
| timeInterval (required) | string | Time interval. |
| timeTaken (required) | string | Time taken. |
| Property | Value | Description |
|---|---|---|
| exe (required) | string | Executable to be run. |
| parameters | string | Parameters for the executable. |
| Property | Value | Description |
|---|---|---|
| count (required) | int | Request Count. |
| path (required) | string | Request path. |
| timeInterval (required) | string | Time interval. |
| timeTaken (required) | string | Time taken. |
| Property | Value | Description |
|---|---|---|
| count (required) | int | Request Count. |
| path (required) | string | Request path. |
| subStatus (required) | int | Request Sub Status. |
| timeInterval (required) | string | Time interval. |
| win32Status (required) | int | Win32 error code. |
| Property | Value | Description |
|---|---|---|
| count (required) | int | Request Count. |
| path (required) | string | Request path. |
| statusCodes (required) | string | HTTP status code. |
| timeInterval (required) | string | Time interval. |
| Property | Value | Description |
|---|---|---|
| arguments (required) | string | Command-line arguments to be passed to the script processor. |
| extension (required) | string | Requests with this extension will be handled using the specified FastCGI application. |
| scriptProcessor (required) | string | The absolute path to the FastCGI application. |
| Property | Value | Description |
|---|---|---|
| action | 'Allow' 'Deny' |
Allow or Deny access for this IP range. |
| description | string | Allow or Deny access for this IP range. |
| headers | object | IP restriction rule headers. |
| ipAddress | string | IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. |
| name | string | IP restriction rule name. |
| priority | int | Priority of IP restriction rule. |
| subnetMask | string | Subnet mask for the range of IP addresses the restriction is valid for. |
| subnetTrafficTag | int | (internal) Subnet traffic tag |
| tag | 'Default' 'ServiceTag' 'XffProxy' |
Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
| vnetSubnetResourceId | string | Virtual network resource id |
| vnetTrafficTag | int | (internal) Vnet traffic tag |
| Property | Value | Description |
|---|---|---|
| action (required) | 'Allow' 'Deny' |
Allow or Deny access for this IP range. |
| description | string | Allow or Deny access for this IP range. |
| headers (required) | object | IP restriction rule headers. |
| ipAddress (required) | string | IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. |
| name (required) | string | IP restriction rule name. |
| priority (required) | int | Priority of IP restriction rule. |
| subnetMask (required) | string | Subnet mask for the range of IP addresses the restriction is valid for. |
| subnetTrafficTag | int | (internal) Subnet traffic tag |
| tag (required) | 'Default' 'ServiceTag' 'XffProxy' |
Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
| vnetSubnetResourceId (required) | string | Virtual network resource id |
| vnetTrafficTag (required) | int | (internal) Vnet traffic tag |
| Property | Value | Description |
|---|---|---|
| hostName (required) | string | Hostname to add (example: www.customer.be) |
| webCertificateName | string | Name of the App Service Plan certificate |
| hostNameType | 'Managed' 'Verified' |
Hostname type. (default: Verified) |
| customHostNameDnsRecordType | 'A' 'CName' |
Custom DNS record type. (default: CName) |
| sslState | 'Disabled' 'IpBasedEnabled' 'SniEnabled' |
SSL type |
| thumbprint | string | SSL certificate thumbprint |
| azureResourceType | 'TrafficManager' 'Website' |
Azure resource type |
| Property | Value | Description |
|---|---|---|
| kind | string | Kind of resource. |
| branch | string | Name of branch to use for deployment. |
| deploymentRollbackEnabled | bool | true to enable deployment rollback; otherwise, false. |
| gitHubActionConfiguration | gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. |
| isGitHubAction | bool | true if this is deployed via GitHub action. |
| isManualIntegration | bool | true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). |
| isMercurial | bool | true for a Mercurial repository; false for a Git repository. |
| repoUrl | string | Repository or source control URL. |
| Property | Value | Description |
|---|---|---|
| runtimeStack | string | Runtime stack is used to determine the workflow file content for code base apps. |
| runtimeVersion | string | Runtime version is used to determine what build version to set in the workflow file. |
| Property | Value | Description |
|---|---|---|
| imageName | string | The image name for the build. |
| password | string | The password used to upload the image to the container registry. |
| serverUrl | string | The server URL for the container registry where the build will be hosted. |
| username | string | The username used to upload the image to the container registry. |
| Property | Value | Description |
|---|---|---|
| codeConfiguration | codeConfiguration | GitHub Action code configuration. |
| containerConfiguration | containerConfiguration | GitHub Action container configuration. |
| generateWorkflowFile | bool | Workflow option to determine whether the workflow file should be generated and written to the repository. |
| isLinux | bool | This will help determine the workflow configuration to select. |
| Property | Value | Description |
|---|---|---|
| platform | appServiceAuthPlatform | The configuration settings of the platform of App Service Authentication/Authorization. |
| globalValidation | appServiceAuthGlobalValidation | The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. |
| identityProviders | appServiceAuthIdentityProviders | The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. |
| login | appServiceAuthLogin | The configuration settings of the login flow of users using App Service Authentication/Authorization. |
| httpSettings | appServiceAuthHttpSettings | The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. |
| runtimeVersion | string | The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. |
| configFilePath | string | The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory. |
| Property | Value | Description |
|---|---|---|
| requireAuthentication | bool | true if the authentication flow is required any request is made; otherwise, false. |
| unauthenticatedClientAction | 'AllowAnonymous' 'RedirectToLoginPage' 'Return401' 'Return403' |
The action to take when an unauthenticated client attempts to access the app. |
| redirectToProvider | string | The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". |
| excludedPaths | string[] | The paths for which unauthenticated flow would not be redirected to the login page. |
| Property | Value | Description |
|---|---|---|
| azureActiveDirectory | appServiceAuthAzureActiveDirectory | The configuration settings of the Azure Active directory provider. |
| appServiceAuthFacebook | The configuration settings of the Facebook provider. | |
| gitHub | appServiceAuthGitHub | The configuration settings of the GitHub provider. |
| appServiceAuthGoogle | The configuration settings of the Google provider. | |
| legacyMicrosoftAccount | appServiceAuthLegacyMicrosoftAccount | The configuration settings of the legacy Microsoft Account provider. |
| appServiceAuthTwitter | The configuration settings of the Twitter provider. | |
| apple | appServiceAuthApple | The configuration settings of the Apple provider. |
| azureStaticWebApps | appServiceAuthAzureStaticWebApps | The configuration settings of the Azure Static Web Apps provider. |
| customOpenIdConnectProviders | object | The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. |
| Property | Value | Description |
|---|---|---|
| routes | appServiceAuthLoginRoutes | The routes that specify the endpoints used for login and logout requests. |
| tokenStore | appServiceAuthTokenStore | The configuration settings of the token store. |
| preserveUrlFragmentsForLogins | bool | true if the fragments from the request are preserved after the login request is made; otherwise, false. |
| allowedExternalRedirectUrls | string[] | External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. |
| cookieExpiration | appServiceAuthCookieExpiration | The configuration settings of the session cookie's expiration. |
| nonce | appServiceAuthNonce | The configuration settings of the nonce used in the login flow. |
| Property | Value | Description |
|---|---|---|
| requireHttps | bool | false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. |
| routes | appServiceAuthHttpSettingsRoutes | The configuration settings of the paths HTTP requests. |
| forwardProxy | appServiceAuthForwardProxy | The configuration settings of a forward proxy used to make the requests. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthAzureActiveDirectoryRegistration | The configuration settings of the Azure Active Directory app registration. |
| login | appServiceAuthAzureActiveDirectoryLogin | The configuration settings of the Azure Active Directory login flow. |
| validation | appServiceAuthAzureActiveDirectoryValidation | The configuration settings of the Azure Active Directory token validation flow. |
| isAutoProvisioned | bool | Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the Facebook provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthAppRegistration | The configuration settings of the app registration for the Facebook provider. |
| graphApiVersion | string | The version of the Facebook api to be used while logging in. |
| login | appServiceAuthLoginScopes | The configuration settings of the login flow. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the GitHub provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthClientRegistration | The configuration settings of the app registration for the GitHub provider. |
| login | appServiceAuthLoginScopes | The configuration settings of the login flow. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the Google provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthClientRegistration | The configuration settings of the app registration for the Google provider. |
| login | appServiceAuthLoginScopes | The configuration settings of the login flow. |
| validation | appServiceAuthAllowedAudiencesValidation | The configuration settings of the Azure Active Directory token validation flow. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthClientRegistration | The configuration settings of the app registration for the legacy Microsoft Account provider. |
| login | appServiceAuthLoginScopes | The configuration settings of the login flow. |
| validation | appServiceAuthAllowedAudiencesValidation | The configuration settings of the legacy Microsoft Account provider token validation flow. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the Twitter provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthTwitterRegistration | The configuration settings of the app registration for the Twitter provider. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the Apple provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthAppleRegistration | The configuration settings of the Apple registration. |
| login | appServiceAuthLoginScopes | The configuration settings of the login flow. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. |
| registration | appServiceAuthAzureStaticWebAppsRegistration | The configuration settings of the Azure Static Web Apps registration. |
| Property | Value | Description |
|---|---|---|
| logoutEndpoint | string | The endpoint at which a logout request should be made. |
| Property | Value | Description |
|---|---|---|
| enabled | bool | true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. |
| tokenRefreshExtensionHours | int | The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. |
| fileSystem | appServiceAuthFileSystemTokenStore | The configuration settings of the storage of the tokens if a file system is used. |
| azureBlobStorage | appServiceAuthBlobStorageTokenStore | The configuration settings of the storage of the tokens if blob storage is used. |
| Property | Value | Description |
|---|---|---|
| convention | 'FixedTime' 'IdentityProviderDerived' |
The convention used when determining the session cookie's expiration. |
| timeToExpiration | string | The time after the request is made when the session cookie should expire. |
| Property | Value | Description |
|---|---|---|
| validateNonce | bool | false if the nonce should not be validated while completing the login flow; otherwise, true. |
| nonceExpirationInterval | string | The time after the request is made when the nonce should expire. |
| Property | Value | Description |
|---|---|---|
| apiPrefix | string | The prefix that should precede all the authentication/authorization paths. |
| Property | Value | Description |
|---|---|---|
| convention | 'Custom' 'NoProxy' 'Standard' |
The convention used to determine the url of the request made. |
| customHostHeaderName | string | The name of the header containing the host of the request. |
| customProtoHeaderName | string | The name of the header containing the scheme of the request. |
| Property | Value | Description |
|---|---|---|
| openIdIssuer | string | The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html |
| clientId | string | The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
| clientSecretSettingName | string | The app setting name that contains the client secret of the relying party application. |
| clientSecretCertificateThumbprint | string | An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. |
| clientSecretCertificateSubjectAlternativeName | string | An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. |
| clientSecretCertificateIssuer | string | An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. |
| Property | Value | Description |
|---|---|---|
| loginParameters | string[] | Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". |
| disableWWWAuthenticate | bool | true if the www-authenticate provider should be omitted from the request; otherwise, false. |
| Property | Value | Description |
|---|---|---|
| jwtClaimChecks | appServiceAuthJwtClaimChecks | The configuration settings of the checks that should be made while validating the JWT Claims. |
| allowedAudiences | string[] | The list of audiences that can make successful authentication/authorization requests. |
| defaultAuthorizationPolicy | appServiceAuthDefaultAuthorizationPolicy | The configuration settings of the default authorization policy. |
| Property | Value | Description |
|---|---|---|
| appId | string | The App ID of the app used for login. |
| appSecretSettingName | string | The app setting name that contains the app secret. |
| Property | Value | Description |
|---|---|---|
| scopes | string[] | A list of the scopes that should be requested while authenticating. |
| Property | Value | Description |
|---|---|---|
| clientId | string | The Client ID of the app used for login. |
| clientSecretSettingName | string | The app setting name that contains the client secret. |
| Property | Value | Description |
|---|---|---|
| allowedAudiences | string[] | The configuration settings of the allowed list of audiences from which to validate the JWT token. |
| Property | Value | Description |
|---|---|---|
| consumerKey | string | The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in |
| consumerSecretSettingName | string | The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. |
| Property | Value | Description |
|---|---|---|
| clientId | string | The Client ID of the app used for login. |
| clientSecretSettingName | string | The app setting name that contains the client secret. |
| Property | Value | Description |
|---|---|---|
| clientId | string | The Client ID of the app used for login. |
| Property | Value | Description |
|---|---|---|
| directory | string | The directory in which the tokens will be stored. |
| Property | Value | Description |
|---|---|---|
| sasUrlSettingName | string | The name of the app setting containing the SAS URL of the blob storage containing the tokens. |
| Property | Value | Description |
|---|---|---|
| allowedGroups | string[] | The list of the allowed groups. |
| allowedClientApplications | string[] | The list of the allowed client applications. |
| Property | Value | Description |
|---|---|---|
| allowedPrincipals | appServiceAuthAllowedPrincipals | The configuration settings of the Azure Active Directory allowed principals. |
| allowedApplications | string[] | The configuration settings of the Azure Active Directory allowed applications. |
| Property | Value | Description |
|---|---|---|
| groups | string[] | The list of the allowed groups. |
| identities | string[] | The list of the allowed identities. |
Set the resourceType property to specify the type of object.
For Custom, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'Custom' | |
| category | string | Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
| categoryGroup | string | Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
| enabled | bool | a value indicating whether this log is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this log. |
Set the resourceType property to specify the type of object.
For App Service Plan, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'App Service Plan' |
Set the resourceType property to specify the type of object.
For Azure Firewall, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'Azure Firewall' | |
| category | 'AZFWApplicationRule' 'AZFWApplicationRuleAggregation' 'AZFWDnsQuery' 'AZFWFatFlow' 'AZFWFlowTrace' 'AZFWFqdnResolveFailure' 'AZFWIdpsSignature' 'AZFWNatRule' 'AZFWNatRuleAggregation' 'AZFWNetworkRule' 'AZFWNetworkRuleAggregation' 'AZFWThreatIntel' 'AzureFirewallApplicationRule' 'AzureFirewallDnsProxy' 'AzureFirewallNetworkRule' |
Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
| categoryGroup | string | Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
| enabled | bool | a value indicating whether this log is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this log. |
Set the resourceType property to specify the type of object.
For Application Gateway, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'Application Gateway' | |
| category | 'ApplicationGatewayAccessLog' 'ApplicationGatewayFirewallLog' 'ApplicationGatewayPerformanceLog' |
Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
| categoryGroup | string | Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
| enabled | bool | a value indicating whether this log is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this log. |
| Property | Value | Description |
|---|---|---|
| days (required) | int | the number of days for the retention in days. A value of 0 will retain the events indefinitely. |
| enabled (required) | bool | a value indicating whether the retention policy is enabled. |
Set the resourceType property to specify the type of object.
For Custom, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'Custom' | |
| category | string | Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. |
| enabled (required) | bool | a value indicating whether this category is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this category. |
| timeGrain | string | the timegrain of the metric in ISO8601 format. |
Set the resourceType property to specify the type of object.
For App Service Plan, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'App Service Plan' | |
| category (required) | 'AllMetrics' | Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. |
| enabled | bool | a value indicating whether this category is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this category. |
| timeGrain | string | the timegrain of the metric in ISO8601 format. |
Set the resourceType property to specify the type of object.
For Azure Firewall, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'Azure Firewall' | |
| category (required) | 'AllMetrics' | Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. |
| enabled | bool | a value indicating whether this category is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this category. |
| timeGrain | string | the timegrain of the metric in ISO8601 format. |
Set the resourceType property to specify the type of object.
For Application Gateway, use:
| Property | Value | Description |
|---|---|---|
| resourceType (required) | 'Application Gateway' | |
| category (required) | 'AllMetrics' | Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. |
| enabled | bool | a value indicating whether this category is enabled. (default: Enabled) |
| retentionPolicy | retentionPolicy | the retention policy for this category. |
| timeGrain | string | the timegrain of the metric in ISO8601 format. |
| 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 |
|---|---|---|
| name (required) | string | The resource name |
| eventHubAuthorizationRuleId | string | The resource Id for the event hub authorization rule. |
| eventHubName | string | The name of the event hub. If none is specified, the default event hub will be selected. |
| logAnalyticsDestinationType | string | A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: {normalized service identity}_{normalized category name}. Possible values are: Dedicated and null (null is default.) |
| logs | diagnosticLogSettings[] | The list of logs settings. |
| marketplacePartnerId | string | The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. |
| metrics | diagnosticMetricSettings[] | The list of metric settings. |
| serviceBusRuleId | string | The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. |
| storageAccountId | string | The resource ID of the storage account to which you would like to send Diagnostic Logs. |
| workspaceId | string | The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
| 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 | string[] | List of DNS zone ids that need to be linked. Not needed when using Azure Policy to auto link private endpoints to DNS zones. |
| 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 |
targetScope = 'subscription'
var sharedNaming = {
nameFormat: [
'abbreviation'
'location'
'function'
'environment'
]
location: 'we'
function: 'placeholder'
}
module appService 'ts/ArxusModules:app-service:12.3.1' = {
params: {
resourceObject: {
general: {
location: 'westeurope'
resourceGroupName: 'rg-we-prd-app'
naming: {
function: 'app'
environment: 'prd'
}
sharedNaming: sharedNaming
}
kind: 'app,linux'
serverFarmId: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-we-prd-app/providers/Microsoft.Web/serverfarms/asp-we-prd-app'
}
}
}