Microsoft.Web sites/slots/config 'authsettings' 2021-01-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@2021-01-01' = {
  name: 'authsettings'
  kind: 'string'
  parent: parentSymbolicName
  properties: {
    aadClaimsAuthorization: 'string'
    additionalLoginParams: [ 'string' ]
    allowedAudiences: [ 'string' ]
    allowedExternalRedirectUrls: [ 'string' ]
    authFilePath: 'string'
    clientId: 'string'
    clientSecret: 'string'
    clientSecretCertificateThumbprint: 'string'
    clientSecretSettingName: 'string'
    configVersion: 'string'
    defaultProvider: 'string'
    enabled: bool
    facebookAppId: 'string'
    facebookAppSecret: 'string'
    facebookAppSecretSettingName: 'string'
    facebookOAuthScopes: [ 'string' ]
    gitHubClientId: 'string'
    gitHubClientSecret: 'string'
    gitHubClientSecretSettingName: 'string'
    gitHubOAuthScopes: [ 'string' ]
    googleClientId: 'string'
    googleClientSecret: 'string'
    googleClientSecretSettingName: 'string'
    googleOAuthScopes: [ 'string' ]
    isAuthFromFile: 'string'
    issuer: 'string'
    microsoftAccountClientId: 'string'
    microsoftAccountClientSecret: 'string'
    microsoftAccountClientSecretSettingName: 'string'
    microsoftAccountOAuthScopes: [ 'string' ]
    runtimeVersion: 'string'
    tokenRefreshExtensionHours: int
    tokenStoreEnabled: bool
    twitterConsumerKey: 'string'
    twitterConsumerSecret: 'string'
    twitterConsumerSecretSettingName: 'string'
    unauthenticatedClientAction: 'string'
    validateIssuer: bool
  }
}

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.
'2021-01-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
'authsettings'
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.
parentSymbolicName
properties SiteAuthSettings resource specific properties SiteAuthSettingsProperties

SiteAuthSettingsProperties

Name Description Value
aadClaimsAuthorization Gets a JSON string containing the Azure AD Acl settings. string
additionalLoginParams 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 Allowed audience values to consider when validating JWTs issued by
Azure Active Directory. Note that the {code}ClientID{/code} value is always considered an
allowed audience, regardless of this setting.
string[]
allowedExternalRedirectUrls 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.
string[]
authFilePath The path of the config file containing auth settings.
If the path is relative, base will the site's root directory.
string
clientId 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 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
clientSecretCertificateThumbprint 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.
string
clientSecretSettingName The app setting name that contains the client secret of the relying party application. string
configVersion The ConfigVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of the control plane for Authentication / Authorization.
string
defaultProvider 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'
'Github'
'Google'
'MicrosoftAccount'
'Twitter'
enabled {code}true{/code} if the Authentication / Authorization feature is enabled for the current app; otherwise, {code}false{/code}. bool
facebookAppId 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 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
facebookAppSecretSettingName The app setting name that contains the app secret used for Facebook Login. string
facebookOAuthScopes 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[]
gitHubClientId The Client Id of the GitHub app used for login.
This setting is required for enabling Github login
string
gitHubClientSecret The Client Secret of the GitHub app used for Github Login.
This setting is required for enabling Github login.
string
gitHubClientSecretSettingName The app setting name that contains the client secret of the Github
app used for GitHub Login.
string
gitHubOAuthScopes The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
This setting is optional
string[]
googleClientId 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 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
googleClientSecretSettingName The app setting name that contains the client secret associated with
the Google web application.
string
googleOAuthScopes 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[]
isAuthFromFile "true" if the auth config settings should be read from a file,
"false" otherwise
string
issuer 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 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 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
microsoftAccountClientSecretSettingName The app setting name containing the OAuth 2.0 client secret that was created for the
app used for authentication.
string
microsoftAccountOAuthScopes 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[]
runtimeVersion 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.
string
tokenRefreshExtensionHours 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 {code}true{/code} to durably store platform-specific security tokens that are obtained during login flows; otherwise, {code}false{/code}.
The default is {code}false{/code}.
bool
twitterConsumerKey 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 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
twitterConsumerSecretSettingName The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
application used for sign-in.
string
unauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. bool