Bicep resource definition
The sites/config resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Options for name property
The sites/config resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'authsettingsV2'
.
For other options, see:
To create a Microsoft.Web/sites/config resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/sites/config@2020-10-01' = {
name: 'authsettingsV2'
kind: 'string'
parent: resourceSymbolicName
properties: {
globalValidation: {
kind: 'string'
properties: {
excludedPaths: [
'string'
]
redirectToProvider: 'string'
requireAuthentication: bool
unauthenticatedClientAction: 'string'
}
}
httpSettings: {
kind: 'string'
properties: {
forwardProxy: {
kind: 'string'
properties: {
convention: 'string'
customHostHeaderName: 'string'
customProtoHeaderName: 'string'
}
}
requireHttps: bool
routes: {
kind: 'string'
properties: {
apiPrefix: 'string'
}
}
}
}
identityProviders: {
kind: 'string'
properties: {
azureActiveDirectory: {
kind: 'string'
properties: {
enabled: bool
isAutoProvisioned: bool
login: {
kind: 'string'
properties: {
disableWWWAuthenticate: bool
loginParameters: [
'string'
]
}
}
registration: {
kind: 'string'
properties: {
clientId: 'string'
clientSecretCertificateThumbprint: 'string'
clientSecretSettingName: 'string'
openIdIssuer: 'string'
}
}
validation: {
kind: 'string'
properties: {
allowedAudiences: [
'string'
]
jwtClaimChecks: {
kind: 'string'
properties: {
allowedClientApplications: [
'string'
]
allowedGroups: [
'string'
]
}
}
}
}
}
}
customOpenIdConnectProviders: {}
facebook: {
kind: 'string'
properties: {
enabled: bool
graphApiVersion: 'string'
login: {
kind: 'string'
properties: {
scopes: [
'string'
]
}
}
registration: {
kind: 'string'
properties: {
appId: 'string'
appSecretSettingName: 'string'
}
}
}
}
gitHub: {
kind: 'string'
properties: {
enabled: bool
login: {
kind: 'string'
properties: {
scopes: [
'string'
]
}
}
registration: {
kind: 'string'
properties: {
clientId: 'string'
clientSecretSettingName: 'string'
}
}
}
}
google: {
kind: 'string'
properties: {
enabled: bool
login: {
kind: 'string'
properties: {
scopes: [
'string'
]
}
}
registration: {
kind: 'string'
properties: {
clientId: 'string'
clientSecretSettingName: 'string'
}
}
validation: {
kind: 'string'
properties: {
allowedAudiences: [
'string'
]
}
}
}
}
twitter: {
kind: 'string'
properties: {
enabled: bool
registration: {
kind: 'string'
properties: {
consumerKey: 'string'
consumerSecretSettingName: 'string'
}
}
}
}
}
}
login: {
kind: 'string'
properties: {
allowedExternalRedirectUrls: [
'string'
]
cookieExpiration: {
kind: 'string'
properties: {
convention: 'string'
timeToExpiration: 'string'
}
}
nonce: {
kind: 'string'
properties: {
nonceExpirationInterval: 'string'
validateNonce: bool
}
}
preserveUrlFragmentsForLogins: bool
routes: {
kind: 'string'
properties: {
logoutEndpoint: 'string'
}
}
tokenStore: {
kind: 'string'
properties: {
azureBlobStorage: {
kind: 'string'
properties: {
sasUrlSettingName: 'string'
}
}
enabled: bool
fileSystem: {
kind: 'string'
properties: {
directory: 'string'
}
}
tokenRefreshExtensionHours: int
}
}
}
}
platform: {
kind: 'string'
properties: {
configFilePath: 'string'
enabled: bool
runtimeVersion: 'string'
}
}
}
}
Property values
sites/config-authsettingsV2
Name |
Description |
Value |
name |
The resource name
See how to set names and types for child resources in Bicep. |
'authsettingsV2' |
kind |
Kind of resource. |
string |
parent |
In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.
For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: sites |
properties |
SiteAuthSettingsV2 resource specific properties |
SiteAuthSettingsV2Properties |
SiteAuthSettingsV2Properties
GlobalValidation
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
GlobalValidation resource specific properties |
GlobalValidationProperties |
GlobalValidationProperties
Name |
Description |
Value |
excludedPaths |
|
string[] |
redirectToProvider |
|
string |
requireAuthentication |
|
bool |
unauthenticatedClientAction |
|
'AllowAnonymous' 'RedirectToLoginPage' 'Return401' 'Return403' |
HttpSettings
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
HttpSettings resource specific properties |
HttpSettingsProperties |
HttpSettingsProperties
ForwardProxy
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
ForwardProxy resource specific properties |
ForwardProxyProperties |
ForwardProxyProperties
Name |
Description |
Value |
convention |
|
'Custom' 'NoProxy' 'Standard' |
customHostHeaderName |
|
string |
customProtoHeaderName |
|
string |
HttpSettingsRoutes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
HttpSettingsRoutes resource specific properties |
HttpSettingsRoutesProperties |
HttpSettingsRoutesProperties
Name |
Description |
Value |
apiPrefix |
|
string |
IdentityProviders
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
IdentityProviders resource specific properties |
IdentityProvidersProperties |
IdentityProvidersProperties
AzureActiveDirectory
AzureActiveDirectoryProperties
AzureActiveDirectoryLogin
AzureActiveDirectoryLoginProperties
Name |
Description |
Value |
disableWWWAuthenticate |
|
bool |
loginParameters |
|
string[] |
AzureActiveDirectoryRegistration
AzureActiveDirectoryRegistrationProperties
Name |
Description |
Value |
clientId |
|
string |
clientSecretCertificateThumbprint |
|
string |
clientSecretSettingName |
|
string |
openIdIssuer |
|
string |
AzureActiveDirectoryValidation
AzureActiveDirectoryValidationProperties
Name |
Description |
Value |
allowedAudiences |
|
string[] |
jwtClaimChecks |
|
JwtClaimChecks |
JwtClaimChecks
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
JwtClaimChecks resource specific properties |
JwtClaimChecksProperties |
JwtClaimChecksProperties
Name |
Description |
Value |
allowedClientApplications |
|
string[] |
allowedGroups |
|
string[] |
Facebook
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Facebook resource specific properties |
FacebookProperties |
FacebookProperties
LoginScopes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
LoginScopes resource specific properties |
LoginScopesProperties |
LoginScopesProperties
Name |
Description |
Value |
scopes |
|
string[] |
AppRegistration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
AppRegistration resource specific properties |
AppRegistrationProperties |
AppRegistrationProperties
Name |
Description |
Value |
appId |
|
string |
appSecretSettingName |
|
string |
GitHub
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
GitHub resource specific properties |
GitHubProperties |
GitHubProperties
ClientRegistration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
ClientRegistration resource specific properties |
ClientRegistrationProperties |
ClientRegistrationProperties
Name |
Description |
Value |
clientId |
|
string |
clientSecretSettingName |
|
string |
Google
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Google resource specific properties |
GoogleProperties |
GoogleProperties
AllowedAudiencesValidation
AllowedAudiencesValidationProperties
Name |
Description |
Value |
allowedAudiences |
|
string[] |
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Twitter resource specific properties |
TwitterProperties |
Name |
Description |
Value |
consumerKey |
|
string |
consumerSecretSettingName |
|
string |
Login
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Login resource specific properties |
LoginProperties |
LoginProperties
CookieExpiration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
CookieExpiration resource specific properties |
CookieExpirationProperties |
CookieExpirationProperties
Name |
Description |
Value |
convention |
|
'FixedTime' 'IdentityProviderDerived' |
timeToExpiration |
|
string |
Nonce
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Nonce resource specific properties |
NonceProperties |
NonceProperties
Name |
Description |
Value |
nonceExpirationInterval |
|
string |
validateNonce |
|
bool |
LoginRoutes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
LoginRoutes resource specific properties |
LoginRoutesProperties |
LoginRoutesProperties
Name |
Description |
Value |
logoutEndpoint |
|
string |
TokenStore
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
TokenStore resource specific properties |
TokenStoreProperties |
TokenStoreProperties
BlobStorageTokenStore
BlobStorageTokenStoreProperties
Name |
Description |
Value |
sasUrlSettingName |
|
string |
FileSystemTokenStore
FileSystemTokenStoreProperties
Name |
Description |
Value |
directory |
|
string |
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
AuthPlatform resource specific properties |
AuthPlatformProperties |
Name |
Description |
Value |
configFilePath |
|
string |
enabled |
|
bool |
runtimeVersion |
|
string |
Quickstart templates
The following quickstart templates deploy this resource type.
Template |
Description |
Airflow Web App with PostgreSQL database on App Services
|
A template for deploying Airflow Web App with PostgreSQL database on App Services |
EPiserverCMS in Azure
|
This template allows you to create resources required for EpiServerCMS deployment in Azure |
Java CI/CD using Jenkins and Azure Web Apps
|
This is a sample for Java CI/CD using Jenkins and Azure Web Apps. |
Orchard CMS Video Portal Web App
|
This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured. |
PubNub Realtime Gateway for Azure Event Hubs
|
The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure! |
Scalable Umbraco CMS Web App
|
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps. |
Simple Umbraco CMS Web App
|
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps. |
WordPress on App Service with MySQL In App
|
This template deploys a WordPress Web App on a Windows App Service with MySQL in app |
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks
|
Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control. |
WebApp consuming a Azure SQL Private Endpoint
|
This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server |
Moesif API Analytics and Monetization
|
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
Call custom APIs from Azure Logic Apps
|
Although Logic Apps provides hundreds of connectors for various services, you might want to call APIs that run your own code. One of the easiest and most scalable ways to host your own web APIs is by using Azure App Service. This template deploys a Web app for your custom API and secures that API by using Azure Active Directory authentication. |
Application Gateway for a Web App with IP Restriction
|
This template creates an application gateway in front of an Azure Web App with IP restriction enabled on the Web App. |
App Service Environment with Azure SQL backend
|
This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment. |
Provision a function app running on an App Service Plan
|
This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site. |
Azure Function App with Event Hub and Managed Identity
|
his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account |
Deploy an Azure Function Premium plan with vnet integration
|
This template allows you to deploy an Azure Function Premium plan with regional virtual network integration enabled to a newly created virtual network. |
Provision a Mobile App with a SQL Database
|
This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub. |
Web App with Private Endpoint
|
This template allows you to create a Web App and expose it through Private Endpoint |
Application Gateway with internal API Management and Web App
|
Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App. |
Create Azure Web app with Blob Storage connection string
|
Creates an Azure Web app with Blob Storage connection string, Template originally authored by Jeff Bowles of Microsoft |
Web App with diagnostics logging to Blob Container
|
Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled. |
Create a web app on Azure with Java 13 and Tomcat 9 enabled
|
This template creates a web app on azure with Java 13 and Tomcat 9 enabled allowing you to run Java applications in Azure. Template was authored by Donovan Brown of Microsoft. |
Web App w/ Application Insights sending to Log Analytics
|
This template will is to help support the new API versions of microsoft.insights/components. Starting with 2020-02-02-preview WorkspaceID will be required when creating Application Inisghts.This template will deploy the App Service Plan, App Service, Application Insights, Log Analytics Workspace and hook it all together. |
Web App with Managed Identity, SQL Server and ΑΙ
|
Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring |
Create a Web App + Redis Cache + SQL DB with a template
|
This template creates an Azure Web App with Redis cache and a SQL Database. |
Provision a Web App with a SQL Database
|
This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database. |
Create a Web App plus Redis Cache using a template
|
This template creates an Azure Web App with Redis cache. |
Web App with custom Deployment slots
|
This template provides an easy way to deploy a web app with custom deployment slots on Azure Web Apps. |
Airflow Docker Web App on Linux with PostgreSQL
|
This template provides a easy way to deploy a puckel/docker-airflow image (latest tag) on a Linux Web App with Azure database for PostgreSQL |
Sonarqube Docker Web App on Linux with Azure SQL
|
This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server. |
Sonarqube Docker Web App on Linux with MySQL
|
This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for MySQL |
Sonarqube Docker Web App on Linux with PostgreSQL
|
This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for PostgreSQL(Preview) |
Web App with Azure database for MySQL
|
This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL. |
Web App on Linux with PostgreSQL
|
This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL. |
Web App with VNet Injection and Private Endpoint
|
This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint |
ARM template resource definition
The sites/config resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Options for name property
The sites/config resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'authsettingsV2'
.
For other options, see:
To create a Microsoft.Web/sites/config resource, add the following JSON to your template.
{
"type": "Microsoft.Web/sites/config",
"apiVersion": "2020-10-01",
"name": "authsettingsV2",
"kind": "string",
"properties": {
"globalValidation": {
"kind": "string",
"properties": {
"excludedPaths": [ "string" ],
"redirectToProvider": "string",
"requireAuthentication": "bool",
"unauthenticatedClientAction": "string"
}
},
"httpSettings": {
"kind": "string",
"properties": {
"forwardProxy": {
"kind": "string",
"properties": {
"convention": "string",
"customHostHeaderName": "string",
"customProtoHeaderName": "string"
}
},
"requireHttps": "bool",
"routes": {
"kind": "string",
"properties": {
"apiPrefix": "string"
}
}
}
},
"identityProviders": {
"kind": "string",
"properties": {
"azureActiveDirectory": {
"kind": "string",
"properties": {
"enabled": "bool",
"isAutoProvisioned": "bool",
"login": {
"kind": "string",
"properties": {
"disableWWWAuthenticate": "bool",
"loginParameters": [ "string" ]
}
},
"registration": {
"kind": "string",
"properties": {
"clientId": "string",
"clientSecretCertificateThumbprint": "string",
"clientSecretSettingName": "string",
"openIdIssuer": "string"
}
},
"validation": {
"kind": "string",
"properties": {
"allowedAudiences": [ "string" ],
"jwtClaimChecks": {
"kind": "string",
"properties": {
"allowedClientApplications": [ "string" ],
"allowedGroups": [ "string" ]
}
}
}
}
}
},
"customOpenIdConnectProviders": {},
"facebook": {
"kind": "string",
"properties": {
"enabled": "bool",
"graphApiVersion": "string",
"login": {
"kind": "string",
"properties": {
"scopes": [ "string" ]
}
},
"registration": {
"kind": "string",
"properties": {
"appId": "string",
"appSecretSettingName": "string"
}
}
}
},
"gitHub": {
"kind": "string",
"properties": {
"enabled": "bool",
"login": {
"kind": "string",
"properties": {
"scopes": [ "string" ]
}
},
"registration": {
"kind": "string",
"properties": {
"clientId": "string",
"clientSecretSettingName": "string"
}
}
}
},
"google": {
"kind": "string",
"properties": {
"enabled": "bool",
"login": {
"kind": "string",
"properties": {
"scopes": [ "string" ]
}
},
"registration": {
"kind": "string",
"properties": {
"clientId": "string",
"clientSecretSettingName": "string"
}
},
"validation": {
"kind": "string",
"properties": {
"allowedAudiences": [ "string" ]
}
}
}
},
"twitter": {
"kind": "string",
"properties": {
"enabled": "bool",
"registration": {
"kind": "string",
"properties": {
"consumerKey": "string",
"consumerSecretSettingName": "string"
}
}
}
}
}
},
"login": {
"kind": "string",
"properties": {
"allowedExternalRedirectUrls": [ "string" ],
"cookieExpiration": {
"kind": "string",
"properties": {
"convention": "string",
"timeToExpiration": "string"
}
},
"nonce": {
"kind": "string",
"properties": {
"nonceExpirationInterval": "string",
"validateNonce": "bool"
}
},
"preserveUrlFragmentsForLogins": "bool",
"routes": {
"kind": "string",
"properties": {
"logoutEndpoint": "string"
}
},
"tokenStore": {
"kind": "string",
"properties": {
"azureBlobStorage": {
"kind": "string",
"properties": {
"sasUrlSettingName": "string"
}
},
"enabled": "bool",
"fileSystem": {
"kind": "string",
"properties": {
"directory": "string"
}
},
"tokenRefreshExtensionHours": "int"
}
}
}
},
"platform": {
"kind": "string",
"properties": {
"configFilePath": "string",
"enabled": "bool",
"runtimeVersion": "string"
}
}
}
}
Property values
sites/config-authsettingsV2
Name |
Description |
Value |
type |
The resource type |
'Microsoft.Web/sites/config' |
apiVersion |
The resource api version |
'2020-10-01' |
name |
The resource name
See how to set names and types for child resources in JSON ARM templates. |
'authsettingsV2' |
kind |
Kind of resource. |
string |
properties |
SiteAuthSettingsV2 resource specific properties |
SiteAuthSettingsV2Properties |
SiteAuthSettingsV2Properties
GlobalValidation
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
GlobalValidation resource specific properties |
GlobalValidationProperties |
GlobalValidationProperties
Name |
Description |
Value |
excludedPaths |
|
string[] |
redirectToProvider |
|
string |
requireAuthentication |
|
bool |
unauthenticatedClientAction |
|
'AllowAnonymous' 'RedirectToLoginPage' 'Return401' 'Return403' |
HttpSettings
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
HttpSettings resource specific properties |
HttpSettingsProperties |
HttpSettingsProperties
ForwardProxy
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
ForwardProxy resource specific properties |
ForwardProxyProperties |
ForwardProxyProperties
Name |
Description |
Value |
convention |
|
'Custom' 'NoProxy' 'Standard' |
customHostHeaderName |
|
string |
customProtoHeaderName |
|
string |
HttpSettingsRoutes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
HttpSettingsRoutes resource specific properties |
HttpSettingsRoutesProperties |
HttpSettingsRoutesProperties
Name |
Description |
Value |
apiPrefix |
|
string |
IdentityProviders
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
IdentityProviders resource specific properties |
IdentityProvidersProperties |
IdentityProvidersProperties
AzureActiveDirectory
AzureActiveDirectoryProperties
AzureActiveDirectoryLogin
AzureActiveDirectoryLoginProperties
Name |
Description |
Value |
disableWWWAuthenticate |
|
bool |
loginParameters |
|
string[] |
AzureActiveDirectoryRegistration
AzureActiveDirectoryRegistrationProperties
Name |
Description |
Value |
clientId |
|
string |
clientSecretCertificateThumbprint |
|
string |
clientSecretSettingName |
|
string |
openIdIssuer |
|
string |
AzureActiveDirectoryValidation
AzureActiveDirectoryValidationProperties
Name |
Description |
Value |
allowedAudiences |
|
string[] |
jwtClaimChecks |
|
JwtClaimChecks |
JwtClaimChecks
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
JwtClaimChecks resource specific properties |
JwtClaimChecksProperties |
JwtClaimChecksProperties
Name |
Description |
Value |
allowedClientApplications |
|
string[] |
allowedGroups |
|
string[] |
Facebook
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Facebook resource specific properties |
FacebookProperties |
FacebookProperties
LoginScopes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
LoginScopes resource specific properties |
LoginScopesProperties |
LoginScopesProperties
Name |
Description |
Value |
scopes |
|
string[] |
AppRegistration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
AppRegistration resource specific properties |
AppRegistrationProperties |
AppRegistrationProperties
Name |
Description |
Value |
appId |
|
string |
appSecretSettingName |
|
string |
GitHub
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
GitHub resource specific properties |
GitHubProperties |
GitHubProperties
ClientRegistration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
ClientRegistration resource specific properties |
ClientRegistrationProperties |
ClientRegistrationProperties
Name |
Description |
Value |
clientId |
|
string |
clientSecretSettingName |
|
string |
Google
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Google resource specific properties |
GoogleProperties |
GoogleProperties
AllowedAudiencesValidation
AllowedAudiencesValidationProperties
Name |
Description |
Value |
allowedAudiences |
|
string[] |
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Twitter resource specific properties |
TwitterProperties |
Name |
Description |
Value |
consumerKey |
|
string |
consumerSecretSettingName |
|
string |
Login
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Login resource specific properties |
LoginProperties |
LoginProperties
CookieExpiration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
CookieExpiration resource specific properties |
CookieExpirationProperties |
CookieExpirationProperties
Name |
Description |
Value |
convention |
|
'FixedTime' 'IdentityProviderDerived' |
timeToExpiration |
|
string |
Nonce
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Nonce resource specific properties |
NonceProperties |
NonceProperties
Name |
Description |
Value |
nonceExpirationInterval |
|
string |
validateNonce |
|
bool |
LoginRoutes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
LoginRoutes resource specific properties |
LoginRoutesProperties |
LoginRoutesProperties
Name |
Description |
Value |
logoutEndpoint |
|
string |
TokenStore
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
TokenStore resource specific properties |
TokenStoreProperties |
TokenStoreProperties
BlobStorageTokenStore
BlobStorageTokenStoreProperties
Name |
Description |
Value |
sasUrlSettingName |
|
string |
FileSystemTokenStore
FileSystemTokenStoreProperties
Name |
Description |
Value |
directory |
|
string |
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
AuthPlatform resource specific properties |
AuthPlatformProperties |
Name |
Description |
Value |
configFilePath |
|
string |
enabled |
|
bool |
runtimeVersion |
|
string |
Quickstart templates
The following quickstart templates deploy this resource type.
Template |
Description |
Airflow Web App with PostgreSQL database on App Services
|
A template for deploying Airflow Web App with PostgreSQL database on App Services |
EPiserverCMS in Azure
|
This template allows you to create resources required for EpiServerCMS deployment in Azure |
Java CI/CD using Jenkins and Azure Web Apps
|
This is a sample for Java CI/CD using Jenkins and Azure Web Apps. |
Orchard CMS Video Portal Web App
|
This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured. |
PubNub Realtime Gateway for Azure Event Hubs
|
The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure! |
Scalable Umbraco CMS Web App
|
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps. |
Simple Umbraco CMS Web App
|
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps. |
WordPress on App Service with MySQL In App
|
This template deploys a WordPress Web App on a Windows App Service with MySQL in app |
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks
|
Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control. |
WebApp consuming a Azure SQL Private Endpoint
|
This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server |
Moesif API Analytics and Monetization
|
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
Call custom APIs from Azure Logic Apps
|
Although Logic Apps provides hundreds of connectors for various services, you might want to call APIs that run your own code. One of the easiest and most scalable ways to host your own web APIs is by using Azure App Service. This template deploys a Web app for your custom API and secures that API by using Azure Active Directory authentication. |
Application Gateway for a Web App with IP Restriction
|
This template creates an application gateway in front of an Azure Web App with IP restriction enabled on the Web App. |
App Service Environment with Azure SQL backend
|
This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment. |
Provision a function app running on an App Service Plan
|
This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site. |
Azure Function App with Event Hub and Managed Identity
|
his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account |
Deploy an Azure Function Premium plan with vnet integration
|
This template allows you to deploy an Azure Function Premium plan with regional virtual network integration enabled to a newly created virtual network. |
Provision a Mobile App with a SQL Database
|
This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub. |
Web App with Private Endpoint
|
This template allows you to create a Web App and expose it through Private Endpoint |
Application Gateway with internal API Management and Web App
|
Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App. |
Create Azure Web app with Blob Storage connection string
|
Creates an Azure Web app with Blob Storage connection string, Template originally authored by Jeff Bowles of Microsoft |
Web App with diagnostics logging to Blob Container
|
Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled. |
Create a web app on Azure with Java 13 and Tomcat 9 enabled
|
This template creates a web app on azure with Java 13 and Tomcat 9 enabled allowing you to run Java applications in Azure. Template was authored by Donovan Brown of Microsoft. |
Web App w/ Application Insights sending to Log Analytics
|
This template will is to help support the new API versions of microsoft.insights/components. Starting with 2020-02-02-preview WorkspaceID will be required when creating Application Inisghts.This template will deploy the App Service Plan, App Service, Application Insights, Log Analytics Workspace and hook it all together. |
Web App with Managed Identity, SQL Server and ΑΙ
|
Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring |
Create a Web App + Redis Cache + SQL DB with a template
|
This template creates an Azure Web App with Redis cache and a SQL Database. |
Provision a Web App with a SQL Database
|
This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database. |
Create a Web App plus Redis Cache using a template
|
This template creates an Azure Web App with Redis cache. |
Web App with custom Deployment slots
|
This template provides an easy way to deploy a web app with custom deployment slots on Azure Web Apps. |
Airflow Docker Web App on Linux with PostgreSQL
|
This template provides a easy way to deploy a puckel/docker-airflow image (latest tag) on a Linux Web App with Azure database for PostgreSQL |
Sonarqube Docker Web App on Linux with Azure SQL
|
This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server. |
Sonarqube Docker Web App on Linux with MySQL
|
This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for MySQL |
Sonarqube Docker Web App on Linux with PostgreSQL
|
This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for PostgreSQL(Preview) |
Web App with Azure database for MySQL
|
This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL. |
Web App on Linux with PostgreSQL
|
This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL. |
Web App with VNet Injection and Private Endpoint
|
This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint |
The sites/config resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Options for name property
The sites/config resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'authsettingsV2'
.
For other options, see:
To create a Microsoft.Web/sites/config resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/sites/config@2020-10-01"
name = "authsettingsV2"
parent_id = "string"
body = jsonencode({
properties = {
globalValidation = {
kind = "string"
properties = {
excludedPaths = [
"string"
]
redirectToProvider = "string"
requireAuthentication = bool
unauthenticatedClientAction = "string"
}
}
httpSettings = {
kind = "string"
properties = {
forwardProxy = {
kind = "string"
properties = {
convention = "string"
customHostHeaderName = "string"
customProtoHeaderName = "string"
}
}
requireHttps = bool
routes = {
kind = "string"
properties = {
apiPrefix = "string"
}
}
}
}
identityProviders = {
kind = "string"
properties = {
azureActiveDirectory = {
kind = "string"
properties = {
enabled = bool
isAutoProvisioned = bool
login = {
kind = "string"
properties = {
disableWWWAuthenticate = bool
loginParameters = [
"string"
]
}
}
registration = {
kind = "string"
properties = {
clientId = "string"
clientSecretCertificateThumbprint = "string"
clientSecretSettingName = "string"
openIdIssuer = "string"
}
}
validation = {
kind = "string"
properties = {
allowedAudiences = [
"string"
]
jwtClaimChecks = {
kind = "string"
properties = {
allowedClientApplications = [
"string"
]
allowedGroups = [
"string"
]
}
}
}
}
}
}
customOpenIdConnectProviders = {}
facebook = {
kind = "string"
properties = {
enabled = bool
graphApiVersion = "string"
login = {
kind = "string"
properties = {
scopes = [
"string"
]
}
}
registration = {
kind = "string"
properties = {
appId = "string"
appSecretSettingName = "string"
}
}
}
}
gitHub = {
kind = "string"
properties = {
enabled = bool
login = {
kind = "string"
properties = {
scopes = [
"string"
]
}
}
registration = {
kind = "string"
properties = {
clientId = "string"
clientSecretSettingName = "string"
}
}
}
}
google = {
kind = "string"
properties = {
enabled = bool
login = {
kind = "string"
properties = {
scopes = [
"string"
]
}
}
registration = {
kind = "string"
properties = {
clientId = "string"
clientSecretSettingName = "string"
}
}
validation = {
kind = "string"
properties = {
allowedAudiences = [
"string"
]
}
}
}
}
twitter = {
kind = "string"
properties = {
enabled = bool
registration = {
kind = "string"
properties = {
consumerKey = "string"
consumerSecretSettingName = "string"
}
}
}
}
}
}
login = {
kind = "string"
properties = {
allowedExternalRedirectUrls = [
"string"
]
cookieExpiration = {
kind = "string"
properties = {
convention = "string"
timeToExpiration = "string"
}
}
nonce = {
kind = "string"
properties = {
nonceExpirationInterval = "string"
validateNonce = bool
}
}
preserveUrlFragmentsForLogins = bool
routes = {
kind = "string"
properties = {
logoutEndpoint = "string"
}
}
tokenStore = {
kind = "string"
properties = {
azureBlobStorage = {
kind = "string"
properties = {
sasUrlSettingName = "string"
}
}
enabled = bool
fileSystem = {
kind = "string"
properties = {
directory = "string"
}
}
tokenRefreshExtensionHours = int
}
}
}
}
platform = {
kind = "string"
properties = {
configFilePath = "string"
enabled = bool
runtimeVersion = "string"
}
}
}
kind = "string"
})
}
Property values
sites/config-authsettingsV2
Name |
Description |
Value |
type |
The resource type |
"Microsoft.Web/sites/config@2020-10-01" |
name |
The resource name |
"authsettingsV2" |
parent_id |
The ID of the resource that is the parent for this resource. |
ID for resource of type: sites |
kind |
Kind of resource. |
string |
properties |
SiteAuthSettingsV2 resource specific properties |
SiteAuthSettingsV2Properties |
SiteAuthSettingsV2Properties
GlobalValidation
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
GlobalValidation resource specific properties |
GlobalValidationProperties |
GlobalValidationProperties
Name |
Description |
Value |
excludedPaths |
|
string[] |
redirectToProvider |
|
string |
requireAuthentication |
|
bool |
unauthenticatedClientAction |
|
"AllowAnonymous" "RedirectToLoginPage" "Return401" "Return403" |
HttpSettings
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
HttpSettings resource specific properties |
HttpSettingsProperties |
HttpSettingsProperties
ForwardProxy
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
ForwardProxy resource specific properties |
ForwardProxyProperties |
ForwardProxyProperties
Name |
Description |
Value |
convention |
|
"Custom" "NoProxy" "Standard" |
customHostHeaderName |
|
string |
customProtoHeaderName |
|
string |
HttpSettingsRoutes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
HttpSettingsRoutes resource specific properties |
HttpSettingsRoutesProperties |
HttpSettingsRoutesProperties
Name |
Description |
Value |
apiPrefix |
|
string |
IdentityProviders
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
IdentityProviders resource specific properties |
IdentityProvidersProperties |
IdentityProvidersProperties
AzureActiveDirectory
AzureActiveDirectoryProperties
AzureActiveDirectoryLogin
AzureActiveDirectoryLoginProperties
Name |
Description |
Value |
disableWWWAuthenticate |
|
bool |
loginParameters |
|
string[] |
AzureActiveDirectoryRegistration
AzureActiveDirectoryRegistrationProperties
Name |
Description |
Value |
clientId |
|
string |
clientSecretCertificateThumbprint |
|
string |
clientSecretSettingName |
|
string |
openIdIssuer |
|
string |
AzureActiveDirectoryValidation
AzureActiveDirectoryValidationProperties
Name |
Description |
Value |
allowedAudiences |
|
string[] |
jwtClaimChecks |
|
JwtClaimChecks |
JwtClaimChecks
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
JwtClaimChecks resource specific properties |
JwtClaimChecksProperties |
JwtClaimChecksProperties
Name |
Description |
Value |
allowedClientApplications |
|
string[] |
allowedGroups |
|
string[] |
Facebook
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Facebook resource specific properties |
FacebookProperties |
FacebookProperties
LoginScopes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
LoginScopes resource specific properties |
LoginScopesProperties |
LoginScopesProperties
Name |
Description |
Value |
scopes |
|
string[] |
AppRegistration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
AppRegistration resource specific properties |
AppRegistrationProperties |
AppRegistrationProperties
Name |
Description |
Value |
appId |
|
string |
appSecretSettingName |
|
string |
GitHub
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
GitHub resource specific properties |
GitHubProperties |
GitHubProperties
ClientRegistration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
ClientRegistration resource specific properties |
ClientRegistrationProperties |
ClientRegistrationProperties
Name |
Description |
Value |
clientId |
|
string |
clientSecretSettingName |
|
string |
Google
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Google resource specific properties |
GoogleProperties |
GoogleProperties
AllowedAudiencesValidation
AllowedAudiencesValidationProperties
Name |
Description |
Value |
allowedAudiences |
|
string[] |
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Twitter resource specific properties |
TwitterProperties |
Name |
Description |
Value |
consumerKey |
|
string |
consumerSecretSettingName |
|
string |
Login
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Login resource specific properties |
LoginProperties |
LoginProperties
CookieExpiration
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
CookieExpiration resource specific properties |
CookieExpirationProperties |
CookieExpirationProperties
Name |
Description |
Value |
convention |
|
"FixedTime" "IdentityProviderDerived" |
timeToExpiration |
|
string |
Nonce
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
Nonce resource specific properties |
NonceProperties |
NonceProperties
Name |
Description |
Value |
nonceExpirationInterval |
|
string |
validateNonce |
|
bool |
LoginRoutes
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
LoginRoutes resource specific properties |
LoginRoutesProperties |
LoginRoutesProperties
Name |
Description |
Value |
logoutEndpoint |
|
string |
TokenStore
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
TokenStore resource specific properties |
TokenStoreProperties |
TokenStoreProperties
BlobStorageTokenStore
BlobStorageTokenStoreProperties
Name |
Description |
Value |
sasUrlSettingName |
|
string |
FileSystemTokenStore
FileSystemTokenStoreProperties
Name |
Description |
Value |
directory |
|
string |
Name |
Description |
Value |
kind |
Kind of resource. |
string |
properties |
AuthPlatform resource specific properties |
AuthPlatformProperties |
Name |
Description |
Value |
configFilePath |
|
string |
enabled |
|
bool |
runtimeVersion |
|
string |