Microsoft.Web sites/slots/config 'authsettings' 2015-08-01
The sites/slots/config resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
Options for name property
The sites/slots/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: 'authsettings'.
For other options, see:
Template format
To create a Microsoft.Web/sites/slots/config resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.Web/sites/slots/config@2015-08-01' = {
name: 'authsettings'
parent: resourceSymbolicName
aadClientId: 'string'
additionalLoginParams: [
'string'
]
allowedAudiences: [
'string'
]
allowedExternalRedirectUrls: [
'string'
]
clientId: 'string'
clientSecret: 'string'
defaultProvider: 'string'
enabled: bool
facebookAppId: 'string'
facebookAppSecret: 'string'
facebookOAuthScopes: [
'string'
]
googleClientId: 'string'
googleClientSecret: 'string'
googleOAuthScopes: [
'string'
]
httpApiPrefixPath: 'string'
issuer: 'string'
microsoftAccountClientId: 'string'
microsoftAccountClientSecret: 'string'
microsoftAccountOAuthScopes: [
'string'
]
openIdIssuer: 'string'
tokenRefreshExtensionHours: int
tokenStoreEnabled: bool
twitterConsumerKey: 'string'
twitterConsumerSecret: 'string'
unauthenticatedClientAction: 'string'
}
Property values
sites/slots/config-authsettings
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.Web/sites/slots/config' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2015-08-01' |
| name | The resource name See how to set names and types for child resources in Bicep or JSON ARM templates. |
'authsettings' |
| 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: slots |
| aadClientId | string | |
| additionalLoginParams | Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". |
string[] |
| allowedAudiences | Gets or sets a list of allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an allowed audience, regardless of this setting. |
string[] |
| allowedExternalRedirectUrls | Gets or sets a collection of external URLs that can be redirected to as part of logging in or logging out of the web 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. |
string[] |
| clientId | Gets or sets 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 |
string |
| clientSecret | Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
string |
| defaultProvider | Gets or sets 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". |
'AzureActiveDirectory' 'Facebook' 'Google' 'MicrosoftAccount' 'Twitter' |
| enabled | Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. | bool |
| facebookAppId | Gets or sets the App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login |
string |
| facebookAppSecret | Gets or sets the App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login |
string |
| facebookOAuthScopes | Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login |
string[] |
| googleClientId | Gets or sets the OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ |
string |
| googleClientSecret | Gets or sets the client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ |
string |
| googleOAuthScopes | Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ |
string[] |
| httpApiPrefixPath | Gets or sets the relative path prefix used by platform HTTP APIs. Changing this value is not recommended except for compatibility reasons. |
string |
| issuer | Gets or sets 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://sts.windows.net/{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 |
string |
| microsoftAccountClientId | Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm |
string |
| microsoftAccountClientSecret | Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm |
string |
| microsoftAccountOAuthScopes | Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/library/dn631845.aspx |
string[] |
| openIdIssuer | string | |
| tokenRefreshExtensionHours | Gets or sets 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. |
int |
| tokenStoreEnabled | Gets or sets a value indicating whether to durably store platform-specific security tokens obtained during login flows. This capability is disabled by default. |
bool |
| twitterConsumerKey | Gets or sets 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 |
string |
| twitterConsumerSecret | Gets or sets the OAuth 1.0a consumer secret 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 |
string |
| unauthenticatedClientAction | Gets or sets the action to take when an unauthenticated client attempts to access the app. | 'AllowAnonymous' 'RedirectToLoginPage' |