Microsoft.Web sites/slots/config 'authsettingsV2' 2020-09-01

  • مقالة
  • قراءة خلال 8 دقائق

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: 'authsettingsV2'.

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@2020-09-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/slots/config-authsettingsV2

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

See how to set names and types for child resources in Bicep or JSON ARM templates.		 '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: slots
properties SiteAuthSettingsV2 resource specific properties SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

Name Description Value
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
login Login
platform AuthPlatform

GlobalValidation

Name Description Value
kind Kind of resource. string
properties GlobalValidation resource specific properties GlobalValidationProperties

GlobalValidationProperties

Name Description Value
excludedPaths Array of GlobalValidationPropertiesExcludedPathsItem 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

Name Description Value
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

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

Name Description Value
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders Dictionary of {CustomOpenIdConnectProvider} object
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

AzureActiveDirectory

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectory resource specific properties AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

Name Description Value
enabled bool
isAutoProvisioned bool
login AzureActiveDirectoryLogin
registration AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryLogin resource specific properties AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

Name Description Value
disableWWWAuthenticate bool
loginParameters Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem string[]

AzureActiveDirectoryRegistration

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryRegistration resource specific properties AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

Name Description Value
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryValidation resource specific properties AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

Name Description Value
allowedAudiences Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

Name Description Value
kind Kind of resource. string
properties JwtClaimChecks resource specific properties JwtClaimChecksProperties

JwtClaimChecksProperties

Name Description Value
allowedClientApplications Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem string[]
allowedGroups Array of JwtClaimChecksPropertiesAllowedGroupsItem string[]

Facebook

Name Description Value
kind Kind of resource. string
properties Facebook resource specific properties FacebookProperties

FacebookProperties

Name Description Value
enabled bool
graphApiVersion string
login LoginScopes
registration AppRegistration

LoginScopes

Name Description Value
kind Kind of resource. string
properties LoginScopes resource specific properties LoginScopesProperties

LoginScopesProperties

Name Description Value
scopes Array of LoginScopesPropertiesScopesItem 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

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration

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

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

Name Description Value
kind Kind of resource. string
properties AllowedAudiencesValidation resource specific properties AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

Name Description Value
allowedAudiences Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem string[]

Twitter

Name Description Value
kind Kind of resource. string
properties Twitter resource specific properties TwitterProperties

TwitterProperties

Name Description Value
enabled bool
registration TwitterRegistration

TwitterRegistration

Name Description Value
kind Kind of resource. string
properties TwitterRegistration resource specific properties TwitterRegistrationProperties

TwitterRegistrationProperties

Name Description Value
consumerKey string
consumerSecretSettingName string

Login

Name Description Value
kind Kind of resource. string
properties Login resource specific properties LoginProperties

LoginProperties

Name Description Value
allowedExternalRedirectUrls Array of LoginPropertiesAllowedExternalRedirectUrlsItem string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

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

Name Description Value
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

BlobStorageTokenStore

Name Description Value
kind Kind of resource. string
properties BlobStorageTokenStore resource specific properties BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

Name Description Value
sasUrlSettingName string

FileSystemTokenStore

Name Description Value
kind Kind of resource. string
properties FileSystemTokenStore resource specific properties FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

Name Description Value
directory string

AuthPlatform

Name Description Value
kind Kind of resource. string
properties AuthPlatform resource specific properties AuthPlatformProperties

AuthPlatformProperties

Name Description Value
configFilePath string
enabled bool
runtimeVersion string