你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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

Bicep 资源定义

可以使用面向以下操作部署 sites/slots/config 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

名称属性的选项

sites/slots/config 资源根据 name 属性的值接受不同的属性。 本文介绍设置 name: 'authsettingsV2'时可用的属性。

有关其他选项,请参阅:

资源格式

若要创建 Microsoft.Web/sites/slots/config 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Web/sites/slots/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'
      }
    }
  }
}

属性值

sites/slots/config-authsettingsV2

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
“authsettingsV2”
kind 资源类型。 string
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为:的资源的符号名称
properties SiteAuthSettingsV2 资源特定的属性 SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

名称 说明
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
登录 登录
平台 AuthPlatform

GlobalValidation

名称 说明
kind 资源类型。 string
properties GlobalValidation 资源特定的属性 GlobalValidationProperties

GlobalValidationProperties

名称 说明
excludedPaths string[]
redirectToProvider 字符串
requireAuthentication bool
unauthenticatedClientAction “AllowAnonymous”
“RedirectToLoginPage”
“Return401”
“Return403”

HttpSettings

名称 说明
kind 资源类型。 string
properties HttpSettings 资源特定的属性 HttpSettingsProperties

HttpSettingsProperties

名称 说明
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

ForwardProxy

名称 说明
kind 资源类型。 string
properties ForwardProxy 资源特定的属性 ForwardProxyProperties

ForwardProxyProperties

名称 说明
公约 “Custom”
“NoProxy”
“Standard”
customHostHeaderName string
customProtoHeaderName 字符串

HttpSettingsRoutes

名称 说明
kind 资源类型。 string
properties HttpSettingsRoutes 资源特定的属性 HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

名称 说明
apiPrefix 字符串

IdentityProviders

名称 说明
kind 资源类型。 string
properties IdentityProviders 资源特定的属性 IdentityProvidersProperties

IdentityProvidersProperties

名称 说明
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders {CustomOpenIdConnectProvider} 的字典 对象 (object)
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

AzureActiveDirectory

名称 说明
kind 资源类型。 string
properties AzureActiveDirectory 资源特定的属性 AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

名称 说明
enabled bool
isAutoProvisioned bool
登录 AzureActiveDirectoryLogin
注册 AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryLogin 资源特定的属性 AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

名称 说明
disableWWWAuthenticate bool
loginParameters string[]

AzureActiveDirectoryRegistration

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryRegistration 资源特定的属性 AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

名称 说明
clientId string
clientSecretCertificateThumbprint 字符串
clientSecretSettingName 字符串
openIdIssuer 字符串

AzureActiveDirectoryValidation

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryValidation 资源特定的属性 AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

名称 说明
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

名称 说明
kind 资源类型。 string
properties JwtClaimChecks 资源特定的属性 JwtClaimChecksProperties

JwtClaimChecksProperties

名称 说明
allowedClientApplications string[]
allowedGroups string[]

Facebook

名称 说明
kind 资源类型。 string
properties Facebook 资源特定的属性 FacebookProperties

FacebookProperties

名称 说明
enabled bool
graphApiVersion 字符串
登录 LoginScopes
注册 AppRegistration

LoginScopes

名称 说明
kind 资源类型。 string
properties LoginScopes 资源特定的属性 LoginScopesProperties

LoginScopesProperties

名称 说明
范围 string[]

AppRegistration

名称 说明
kind 资源类型。 string
properties AppRegistration 资源特定的属性 AppRegistrationProperties

AppRegistrationProperties

名称 说明
appId string
appSecretSettingName 字符串

GitHub

名称 说明
kind 资源类型。 string
properties GitHub 资源特定的属性 GitHubProperties

GitHubProperties

名称 说明
enabled bool
登录 LoginScopes
注册 ClientRegistration

ClientRegistration

名称 说明
kind 资源类型。 string
properties ClientRegistration 资源特定的属性 ClientRegistrationProperties

ClientRegistrationProperties

名称 说明
clientId 字符串
clientSecretSettingName 字符串

Google

名称 说明
kind 资源类型。 string
properties Google 资源特定的属性 GoogleProperties

GoogleProperties

名称 说明
enabled bool
登录 LoginScopes
注册 ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

名称 说明
kind 资源类型。 string
properties AllowedAudiencesValidation 资源特定的属性 AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

名称 说明
allowedAudiences string[]

Twitter

名称 说明
kind 资源类型。 string
properties Twitter 资源特定的属性 TwitterProperties

TwitterProperties

名称 说明
enabled bool
注册 TwitterRegistration

TwitterRegistration

名称 说明
kind 资源类型。 string
properties TwitterRegistration 资源特定的属性 TwitterRegistrationProperties

TwitterRegistrationProperties

名称 说明
consumerKey 字符串
consumerSecretSettingName 字符串

登录

名称 说明
kind 资源类型。 string
properties 登录资源特定的属性 LoginProperties

LoginProperties

名称 说明
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

CookieExpiration

名称 说明
kind 资源类型。 string
properties CookieExpiration 资源特定的属性 CookieExpirationProperties

CookieExpirationProperties

名称 说明
公约 “FixedTime”
“IdentityProviderDerived”
timeToExpiration 字符串

Nonce

名称 说明
kind 资源类型。 string
properties Nonce 资源特定的属性 NonceProperties

NonceProperties

名称 说明
nonceExpirationInterval string
validateNonce bool

LoginRoutes

名称 说明
kind 资源类型。 string
properties LoginRoutes 资源特定的属性 LoginRoutesProperties

LoginRoutesProperties

名称 说明
logoutEndpoint 字符串

TokenStore

名称 说明
kind 资源类型。 string
properties TokenStore 资源特定的属性 TokenStoreProperties

TokenStoreProperties

名称 说明
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

BlobStorageTokenStore

名称 说明
kind 资源类型。 string
properties BlobStorageTokenStore 资源特定的属性 BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

名称 说明
sasUrlSettingName string

FileSystemTokenStore

名称 说明
kind 资源类型。 string
properties FileSystemTokenStore 资源特定的属性 FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

名称 说明 Value
目录 string

AuthPlatform

名称 说明
kind 资源类型。 string
properties AuthPlatform 资源特定的属性 AuthPlatformProperties

AuthPlatformProperties

名称 说明
configFilePath string
enabled bool
runtimeVersion string

ARM 模板资源定义

可以使用面向以下操作部署 sites/slots/config 资源类型:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

名称属性的选项

sites/slots/config 资源根据 name 属性的值接受不同的属性。 本文介绍设置 name: 'authsettingsV2'时可用的属性。

有关其他选项,请参阅:

资源格式

若要创建 Microsoft.Web/sites/slots/config 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Web/sites/slots/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"
      }
    }
  }
}

属性值

sites/slots/config-authsettingsV2

名称 说明 Value
type 资源类型 “Microsoft.Web/sites/slots/config”
apiVersion 资源 API 版本 '2020-10-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
“authsettingsV2”
kind 资源类型。 string
properties SiteAuthSettingsV2 资源特定的属性 SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

名称 说明
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
登录 登录
平台 AuthPlatform

GlobalValidation

名称 说明
kind 资源类型。 string
properties GlobalValidation 资源特定的属性 GlobalValidationProperties

GlobalValidationProperties

名称 说明
excludedPaths string[]
redirectToProvider 字符串
requireAuthentication bool
unauthenticatedClientAction “AllowAnonymous”
“RedirectToLoginPage”
“Return401”
“Return403”

HttpSettings

名称 说明
kind 资源类型。 string
properties HttpSettings 资源特定的属性 HttpSettingsProperties

HttpSettingsProperties

名称 说明
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

ForwardProxy

名称 说明
kind 资源类型。 string
properties ForwardProxy 资源特定的属性 ForwardProxyProperties

ForwardProxyProperties

名称 说明
公约 “Custom”
“NoProxy”
'Standard'
customHostHeaderName 字符串
customProtoHeaderName 字符串

HttpSettingsRoutes

名称 说明
kind 资源类型。 string
properties HttpSettingsRoutes 资源特定的属性 HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

名称 说明
apiPrefix 字符串

IdentityProviders

名称 说明
kind 资源类型。 string
properties IdentityProviders 资源特定的属性 IdentityProvidersProperties

IdentityProvidersProperties

名称 说明
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders {CustomOpenIdConnectProvider} 的字典 对象 (object)
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

AzureActiveDirectory

名称 说明
kind 资源类型。 string
properties AzureActiveDirectory 资源特定的属性 AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

名称 说明
enabled bool
isAutoProvisioned bool
登录 AzureActiveDirectoryLogin
注册 AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryLogin 资源特定的属性 AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

名称 说明
disableWWWAuthenticate bool
loginParameters string[]

AzureActiveDirectoryRegistration

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryRegistration 资源特定的属性 AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

名称 说明
clientId 字符串
clientSecretCertificateThumbprint string
clientSecretSettingName 字符串
openIdIssuer 字符串

AzureActiveDirectoryValidation

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryValidation 资源特定的属性 AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

名称 说明
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

名称 说明
kind 资源类型。 string
properties JwtClaimChecks 资源特定的属性 JwtClaimChecksProperties

JwtClaimChecksProperties

名称 说明
allowedClientApplications string[]
allowedGroups string[]

Facebook

名称 说明
kind 资源类型。 string
properties Facebook 资源特定的属性 FacebookProperties

FacebookProperties

名称 说明
enabled bool
graphApiVersion 字符串
登录 LoginScopes
注册 AppRegistration

LoginScopes

名称 说明
kind 资源类型。 string
properties LoginScopes 资源特定的属性 LoginScopesProperties

LoginScopesProperties

名称 说明
范围 string[]

AppRegistration

名称 说明
kind 资源类型。 string
properties AppRegistration 资源特定的属性 AppRegistrationProperties

AppRegistrationProperties

名称 说明
appId string
appSecretSettingName 字符串

GitHub

名称 说明
kind 资源类型。 string
properties GitHub 资源特定的属性 GitHubProperties

GitHubProperties

名称 说明
enabled bool
登录 LoginScopes
注册 ClientRegistration

ClientRegistration

名称 说明
kind 资源类型。 string
properties ClientRegistration 资源特定的属性 ClientRegistrationProperties

ClientRegistrationProperties

名称 说明
clientId 字符串
clientSecretSettingName 字符串

Google

名称 说明
kind 资源类型。 string
properties Google 资源特定的属性 GoogleProperties

GoogleProperties

名称 说明
enabled bool
登录 LoginScopes
注册 ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

名称 说明
kind 资源类型。 string
properties AllowedAudiencesValidation 资源特定属性 AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

名称 说明
allowedAudiences string[]

Twitter

名称 说明
kind 资源类型。 string
properties Twitter 资源特定的属性 TwitterProperties

TwitterProperties

名称 说明
enabled bool
注册 TwitterRegistration

TwitterRegistration

名称 说明
kind 资源类型。 string
properties TwitterRegistration 资源特定的属性 TwitterRegistrationProperties

TwitterRegistrationProperties

名称 说明
consumerKey string
consumerSecretSettingName 字符串

登录

名称 说明
kind 资源类型。 string
properties 登录资源特定的属性 LoginProperties

LoginProperties

名称 说明
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

CookieExpiration

名称 说明
kind 资源类型。 string
properties CookieExpiration 资源特定的属性 CookieExpirationProperties

CookieExpirationProperties

名称 说明
公约 “FixedTime”
“IdentityProviderDerived”
timeToExpiration string

Nonce

名称 说明
kind 资源类型。 string
properties Nonce 资源特定的属性 NonceProperties

NonceProperties

名称 说明
nonceExpirationInterval string
validateNonce bool

LoginRoutes

名称 说明
kind 资源类型。 string
properties LoginRoutes 资源特定的属性 LoginRoutesProperties

LoginRoutesProperties

名称 说明
logoutEndpoint string

TokenStore

名称 说明
kind 资源类型。 string
properties TokenStore 资源特定的属性 TokenStoreProperties

TokenStoreProperties

名称 说明
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

BlobStorageTokenStore

名称 说明
kind 资源类型。 string
properties BlobStorageTokenStore 资源特定的属性 BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

名称 说明
sasUrlSettingName 字符串

FileSystemTokenStore

名称 说明
kind 资源类型。 string
properties FileSystemTokenStore 资源特定的属性 FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

名称 说明 Value
目录 string

AuthPlatform

名称 说明
kind 资源类型。 string
properties AuthPlatform 资源特定的属性 AuthPlatformProperties

AuthPlatformProperties

名称 说明
configFilePath 字符串
enabled bool
runtimeVersion string

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 sites/slots/config 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

名称属性的选项

sites/slots/config 资源根据 name 属性的值接受不同的属性。 本文介绍设置 name: 'authsettingsV2'时可用的属性。

有关其他选项,请参阅:

资源格式

若要创建 Microsoft.Web/sites/slots/config 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots/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"
  })
}

属性值

sites/slots/config-authsettingsV2

名称 说明 Value
type 资源类型 “Microsoft.Web/sites/slots/config@2020-10-01”
name 资源名称 “authsettingsV2”
parent_id 此资源的父资源 ID。 类型为“”的资源的 ID
kind 资源类型。 string
properties SiteAuthSettingsV2 资源特定的属性 SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

名称 说明
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
登录 登录
平台 AuthPlatform

GlobalValidation

名称 说明
kind 资源类型。 string
properties GlobalValidation 资源特定的属性 GlobalValidationProperties

GlobalValidationProperties

名称 说明
excludedPaths string[]
redirectToProvider 字符串
requireAuthentication bool
unauthenticatedClientAction “AllowAnonymous”
“RedirectToLoginPage”
“Return401”
“Return403”

HttpSettings

名称 说明
kind 资源类型。 string
properties HttpSettings 资源特定的属性 HttpSettingsProperties

HttpSettingsProperties

名称 说明
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

ForwardProxy

名称 说明
kind 资源类型。 string
properties ForwardProxy 资源特定的属性 ForwardProxyProperties

ForwardProxyProperties

名称 说明
公约 “Custom”
“NoProxy”
“Standard”
customHostHeaderName 字符串
customProtoHeaderName 字符串

HttpSettingsRoutes

名称 说明
kind 资源类型。 string
properties HttpSettingsRoutes 资源特定的属性 HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

名称 说明
apiPrefix string

IdentityProviders

名称 说明
kind 资源类型。 string
properties IdentityProviders 资源特定的属性 IdentityProvidersProperties

IdentityProvidersProperties

名称 说明
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders {CustomOpenIdConnectProvider} 的字典 对象 (object)
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

AzureActiveDirectory

名称 说明
kind 资源类型。 string
properties AzureActiveDirectory 资源特定的属性 AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

名称 说明
enabled bool
isAutoProvisioned bool
登录 AzureActiveDirectoryLogin
注册 AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryLogin 资源特定的属性 AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

名称 说明
disableWWWAuthenticate bool
loginParameters string[]

AzureActiveDirectoryRegistration

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryRegistration 资源特定的属性 AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

名称 说明
clientId 字符串
clientSecretCertificateThumbprint 字符串
clientSecretSettingName 字符串
openIdIssuer 字符串

AzureActiveDirectoryValidation

名称 说明
kind 资源类型。 string
properties AzureActiveDirectoryValidation 资源特定的属性 AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

名称 说明
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

名称 说明
kind 资源类型。 string
properties JwtClaimChecks 资源特定的属性 JwtClaimChecksProperties

JwtClaimChecksProperties

名称 说明
allowedClientApplications string[]
allowedGroups string[]

Facebook

名称 说明
kind 资源类型。 string
properties Facebook 资源特定的属性 FacebookProperties

FacebookProperties

名称 说明
enabled bool
graphApiVersion 字符串
登录 LoginScopes
注册 AppRegistration

LoginScopes

名称 说明
kind 资源类型。 string
properties LoginScopes 资源特定的属性 LoginScopesProperties

LoginScopesProperties

名称 说明
范围 string[]

AppRegistration

名称 说明
kind 资源类型。 string
properties 特定于 AppRegistration 资源的属性 AppRegistrationProperties

AppRegistrationProperties

名称 说明
appId string
appSecretSettingName 字符串

GitHub

名称 说明
kind 资源类型。 string
properties GitHub 资源特定的属性 GitHubProperties

GitHubProperties

名称 说明
enabled bool
登录 LoginScopes
注册 ClientRegistration

ClientRegistration

名称 说明
kind 资源类型。 string
properties ClientRegistration 资源特定的属性 ClientRegistrationProperties

ClientRegistrationProperties

名称 说明
clientId 字符串
clientSecretSettingName 字符串

Google

名称 说明
kind 资源类型。 string
properties Google 资源特定的属性 GoogleProperties

GoogleProperties

名称 说明
enabled bool
登录 LoginScopes
注册 ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

名称 说明
kind 资源类型。 string
properties AllowedAudiencesValidation 资源特定的属性 AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

名称 说明
allowedAudiences string[]

Twitter

名称 说明
kind 资源类型。 string
properties Twitter 资源特定的属性 TwitterProperties

TwitterProperties

名称 说明
enabled bool
注册 TwitterRegistration

TwitterRegistration

名称 说明
kind 资源类型。 string
properties TwitterRegistration 资源特定的属性 TwitterRegistrationProperties

TwitterRegistrationProperties

名称 说明
consumerKey 字符串
consumerSecretSettingName string

登录

名称 说明
kind 资源类型。 string
properties 登录资源特定的属性 LoginProperties

LoginProperties

名称 说明
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

CookieExpiration

名称 说明
kind 资源类型。 string
properties CookieExpiration 资源特定的属性 CookieExpirationProperties

CookieExpirationProperties

名称 说明
公约 “FixedTime”
“IdentityProviderDerived”
timeToExpiration string

Nonce

名称 说明
kind 资源类型。 string
properties Nonce 资源特定的属性 NonceProperties

NonceProperties

名称 说明
nonceExpirationInterval 字符串
validateNonce bool

LoginRoutes

名称 说明
kind 资源类型。 string
properties LoginRoutes 资源特定的属性 LoginRoutesProperties

LoginRoutesProperties

名称 说明
logoutEndpoint 字符串

TokenStore

名称 说明
kind 资源类型。 string
properties TokenStore 资源特定的属性 TokenStoreProperties

TokenStoreProperties

名称 说明
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

BlobStorageTokenStore

名称 说明
kind 资源类型。 string
properties BlobStorageTokenStore 资源特定的属性 BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

名称 说明
sasUrlSettingName string

FileSystemTokenStore

名称 说明
kind 资源类型。 string
properties FileSystemTokenStore 资源特定的属性 FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

名称 说明 Value
目录 string

AuthPlatform

名称 说明
kind 资源类型。 string
properties AuthPlatform 资源特定的属性 AuthPlatformProperties

AuthPlatformProperties

名称 说明
configFilePath string
enabled bool
runtimeVersion 字符串