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

SiteAuthSettings interface

包:

@azure/arm-appservice

Azure 应用服务身份验证/授权功能的配置设置。

扩展

ProxyOnlyResource

属性

aadClaimsAuthorization	获取包含 Azure AD Acl 设置的 JSON 字符串。
additionalLoginParams	用户登录时要发送到 OpenID Connect 授权终结点的登录参数。 每个参数必须采用“key=value”格式。
allowedAudiences	允许访问群体值在验证 Azure Active Directory 颁发的 JSON Web 令牌时考虑。 请注意，无论此设置如何，ClientID 值始终被视为允许的受众。
allowedExternalRedirectUrls	作为登录或注销应用的一部分，可重定向到的外部 URL。 请注意，将忽略 URL 的查询字符串部分。 这是 Windows 应用商店应用程序后端通常需要的高级设置。 请注意，始终允许当前域中的 URL。
authFilePath	包含身份验证设置的配置文件的路径。 如果路径是相对路径，则站点的根目录将为基目录。
clientId	此信赖方应用程序的客户端 ID，称为client_id。 若要使用 Azure Active Directory 或其他第三方 OpenID Connect 提供程序启用 OpenID 连接身份验证，则需要此设置。 有关 OpenID Connect 的详细信息：http://openid.net/specs/openid-connect-core-1_0.html
clientSecret	此信赖方应用程序的客户端密码（在 Azure Active Directory 中，也称为密钥）。 此设置是可选的。 如果未配置客户端密码，则 OpenID Connect 隐式身份验证流用于对最终用户进行身份验证。 否则，OpenID Connect 授权代码流用于对最终用户进行身份验证。 有关 OpenID Connect 的详细信息：http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateThumbprint	客户端机密的替代方法，即用于签名的证书的指纹。 此属性充当客户端机密的替代项。 它也是可选的。
clientSecretSettingName	包含信赖方应用程序的客户端密码的应用设置名称。
configVersion	用于当前应用的身份验证/授权功能的 ConfigVersion。 此值中的设置可以控制身份验证/授权的控制平面的行为。
defaultProvider	配置多个提供程序时要使用的默认身份验证提供程序。 仅当配置了多个提供程序并且未经身份验证的客户端作设置为“RedirectToLoginPage”时，才需要此设置。
enabled	如果为当前应用启用了身份验证/授权功能，则 true;否则，false。
facebookAppId	用于登录的 Facebook 应用的应用 ID。 启用 Facebook 登录需要此设置。 Facebook 登录文档：https://developers.facebook.com/docs/facebook-login
facebookAppSecret	用于 Facebook 登录的 Facebook 应用的应用机密。 启用 Facebook 登录需要此设置。 Facebook 登录文档：https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	包含用于 Facebook 登录的应用机密的应用设置名称。
facebookOAuthScopes	将作为 Facebook 登录身份验证的一部分请求的 OAuth 2.0 范围。 此设置是可选的。 Facebook 登录文档：https://developers.facebook.com/docs/facebook-login
gitHubClientId	用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置
gitHubClientSecret	用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。
gitHubClientSecretSettingName	包含用于 GitHub 登录的 Github 应用的客户端机密的应用设置名称。
gitHubOAuthScopes	将作为 GitHub 登录身份验证的一部分请求的 OAuth 2.0 范围。 此设置是可选的
googleClientId	Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 Google 登录需要此设置。 Google Sign-In 文档：https://developers.google.com/identity/sign-in/web/
googleClientSecret	与 Google Web 应用程序关联的客户端密码。 启用 Google 登录需要此设置。 Google Sign-In 文档：https://developers.google.com/identity/sign-in/web/
googleClientSecretSettingName	包含与 Google Web 应用程序关联的客户端密码的应用设置名称。
googleOAuthScopes	将在 Google Sign-In 身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定，则使用“openid”、“profile”和“email”作为默认范围。 Google Sign-In 文档：https://developers.google.com/identity/sign-in/web/
isAuthFromFile	如果应从文件读取身份验证配置设置，则为“true”，否则为“false”
issuer	OpenID Connect 颁发者 URI，表示颁发此应用程序的访问令牌的实体。 使用 Azure Active Directory 时，此值是目录租户的 URI，例如 https://sts.windows.net/{tenant-guid}/。 此 URI 是令牌颁发者的区分大小写的标识符。 有关 OpenID Connect 发现的详细信息：http://openid.net/specs/openid-connect-discovery-1_0.html
microsoftAccountClientId	为用于身份验证的应用创建的 OAuth 2.0 客户端 ID。 启用Microsoft帐户身份验证需要此设置。 Microsoft帐户 OAuth 文档：https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	为用于身份验证的应用创建的 OAuth 2.0 客户端密码。 启用Microsoft帐户身份验证需要此设置。 Microsoft帐户 OAuth 文档：https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	包含为用于身份验证的应用创建的 OAuth 2.0 客户端密码的应用设置名称。
microsoftAccountOAuthScopes	将在Microsoft帐户身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定，则使用“wl.basic”作为默认范围。 Microsoft帐户范围和权限文档：https://msdn.microsoft.com/en-us/library/dn631845.aspx
runtimeVersion	用于当前应用的身份验证/授权功能的 RuntimeVersion。 此值中的设置可以控制身份验证/授权模块中某些功能的行为。
tokenRefreshExtensionHours	会话令牌过期后的小时数，会话令牌可用于调用令牌刷新 API。 默认值为 72 小时。
tokenStoreEnabled	true 持久存储登录流期间获取的平台特定的安全令牌;否则，false。 默认值为 false。
twitterConsumerKey	用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者密钥。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档：https://dev.twitter.com/web/sign-in
twitterConsumerSecret	用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档：https://dev.twitter.com/web/sign-in
twitterConsumerSecretSettingName	包含用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密的应用设置名称。
unauthenticatedClientAction	未经身份验证的客户端尝试访问应用时要执行的作。
validateIssuer	获取一个值，该值指示颁发者是否应为有效的 HTTPS URL，并按如下所示进行验证。

继承属性

id	资源 ID。注意：此属性不会序列化。 它只能由服务器填充。
kind	资源类型。
name	资源名称。 注意：此属性不会序列化。 它只能由服务器填充。
type	资源类型。 注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

aadClaimsAuthorization

获取包含 Azure AD Acl 设置的 JSON 字符串。

aadClaimsAuthorization?: string

属性值

string

additionalLoginParams

用户登录时要发送到 OpenID Connect 授权终结点的登录参数。 每个参数必须采用“key=value”格式。

additionalLoginParams?: string[]

属性值

string[]

allowedAudiences

允许访问群体值在验证 Azure Active Directory 颁发的 JSON Web 令牌时考虑。 请注意，无论此设置如何，ClientID 值始终被视为允许的受众。

allowedAudiences?: string[]

属性值

string[]

allowedExternalRedirectUrls

作为登录或注销应用的一部分，可重定向到的外部 URL。 请注意，将忽略 URL 的查询字符串部分。 这是 Windows 应用商店应用程序后端通常需要的高级设置。 请注意，始终允许当前域中的 URL。

allowedExternalRedirectUrls?: string[]

属性值

string[]

authFilePath

包含身份验证设置的配置文件的路径。 如果路径是相对路径，则站点的根目录将为基目录。

authFilePath?: string

属性值

string

clientId

此信赖方应用程序的客户端 ID，称为client_id。 若要使用 Azure Active Directory 或其他第三方 OpenID Connect 提供程序启用 OpenID 连接身份验证，则需要此设置。 有关 OpenID Connect 的详细信息：http://openid.net/specs/openid-connect-core-1_0.html

clientId?: string

属性值

string

clientSecret

此信赖方应用程序的客户端密码（在 Azure Active Directory 中，也称为密钥）。 此设置是可选的。 如果未配置客户端密码，则 OpenID Connect 隐式身份验证流用于对最终用户进行身份验证。 否则，OpenID Connect 授权代码流用于对最终用户进行身份验证。 有关 OpenID Connect 的详细信息：http://openid.net/specs/openid-connect-core-1_0.html

clientSecret?: string

属性值

string

clientSecretCertificateThumbprint

客户端机密的替代方法，即用于签名的证书的指纹。 此属性充当客户端机密的替代项。 它也是可选的。

clientSecretCertificateThumbprint?: string

属性值

string

clientSecretSettingName

包含信赖方应用程序的客户端密码的应用设置名称。

clientSecretSettingName?: string

属性值

string

configVersion

用于当前应用的身份验证/授权功能的 ConfigVersion。 此值中的设置可以控制身份验证/授权的控制平面的行为。

configVersion?: string

属性值

string

defaultProvider

配置多个提供程序时要使用的默认身份验证提供程序。 仅当配置了多个提供程序并且未经身份验证的客户端作设置为“RedirectToLoginPage”时，才需要此设置。

defaultProvider?: BuiltInAuthenticationProvider

属性值

BuiltInAuthenticationProvider

enabled

如果为当前应用启用了身份验证/授权功能，则 true;否则，false。

enabled?: boolean

属性值

boolean

facebookAppId

用于登录的 Facebook 应用的应用 ID。 启用 Facebook 登录需要此设置。 Facebook 登录文档：https://developers.facebook.com/docs/facebook-login

facebookAppId?: string

属性值

string

facebookAppSecret

用于 Facebook 登录的 Facebook 应用的应用机密。 启用 Facebook 登录需要此设置。 Facebook 登录文档：https://developers.facebook.com/docs/facebook-login

facebookAppSecret?: string

属性值

string

facebookAppSecretSettingName

包含用于 Facebook 登录的应用机密的应用设置名称。

facebookAppSecretSettingName?: string

属性值

string

facebookOAuthScopes

将作为 Facebook 登录身份验证的一部分请求的 OAuth 2.0 范围。 此设置是可选的。 Facebook 登录文档：https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

属性值

string[]

gitHubClientId

用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置

gitHubClientId?: string

属性值

string

gitHubClientSecret

用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。

gitHubClientSecret?: string

属性值

string

gitHubClientSecretSettingName

包含用于 GitHub 登录的 Github 应用的客户端机密的应用设置名称。

gitHubClientSecretSettingName?: string

属性值

string

gitHubOAuthScopes

将作为 GitHub 登录身份验证的一部分请求的 OAuth 2.0 范围。 此设置是可选的

gitHubOAuthScopes?: string[]

属性值

string[]

googleClientId

Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 Google 登录需要此设置。 Google Sign-In 文档：https://developers.google.com/identity/sign-in/web/

googleClientId?: string

属性值

string

googleClientSecret

与 Google Web 应用程序关联的客户端密码。 启用 Google 登录需要此设置。 Google Sign-In 文档：https://developers.google.com/identity/sign-in/web/

googleClientSecret?: string

属性值

string

googleClientSecretSettingName

包含与 Google Web 应用程序关联的客户端密码的应用设置名称。

googleClientSecretSettingName?: string

属性值

string

googleOAuthScopes

将在 Google Sign-In 身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定，则使用“openid”、“profile”和“email”作为默认范围。 Google Sign-In 文档：https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: string[]

属性值

string[]

isAuthFromFile

如果应从文件读取身份验证配置设置，则为“true”，否则为“false”

isAuthFromFile?: string

属性值

string

issuer

OpenID Connect 颁发者 URI，表示颁发此应用程序的访问令牌的实体。 使用 Azure Active Directory 时，此值是目录租户的 URI，例如 https://sts.windows.net/{tenant-guid}/。 此 URI 是令牌颁发者的区分大小写的标识符。 有关 OpenID Connect 发现的详细信息：http://openid.net/specs/openid-connect-discovery-1_0.html

issuer?: string

属性值

string

microsoftAccountClientId

为用于身份验证的应用创建的 OAuth 2.0 客户端 ID。 启用Microsoft帐户身份验证需要此设置。 Microsoft帐户 OAuth 文档：https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

属性值

string

microsoftAccountClientSecret

为用于身份验证的应用创建的 OAuth 2.0 客户端密码。 启用Microsoft帐户身份验证需要此设置。 Microsoft帐户 OAuth 文档：https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

属性值

string

microsoftAccountClientSecretSettingName

包含为用于身份验证的应用创建的 OAuth 2.0 客户端密码的应用设置名称。

microsoftAccountClientSecretSettingName?: string

属性值

string

microsoftAccountOAuthScopes

将在Microsoft帐户身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定，则使用“wl.basic”作为默认范围。 Microsoft帐户范围和权限文档：https://msdn.microsoft.com/en-us/library/dn631845.aspx

microsoftAccountOAuthScopes?: string[]

属性值

string[]

runtimeVersion

用于当前应用的身份验证/授权功能的 RuntimeVersion。 此值中的设置可以控制身份验证/授权模块中某些功能的行为。

runtimeVersion?: string

属性值

string

tokenRefreshExtensionHours

会话令牌过期后的小时数，会话令牌可用于调用令牌刷新 API。 默认值为 72 小时。

tokenRefreshExtensionHours?: number

属性值

number

tokenStoreEnabled

true 持久存储登录流期间获取的平台特定的安全令牌;否则，false。 默认值为 false。

tokenStoreEnabled?: boolean

属性值

boolean

twitterConsumerKey

用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者密钥。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档：https://dev.twitter.com/web/sign-in

twitterConsumerKey?: string

属性值

string

twitterConsumerSecret

用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档：https://dev.twitter.com/web/sign-in

twitterConsumerSecret?: string

属性值

string

twitterConsumerSecretSettingName

包含用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密的应用设置名称。

twitterConsumerSecretSettingName?: string

属性值

string

unauthenticatedClientAction

未经身份验证的客户端尝试访问应用时要执行的作。

unauthenticatedClientAction?: UnauthenticatedClientAction

属性值

UnauthenticatedClientAction

validateIssuer

获取一个值，该值指示颁发者是否应为有效的 HTTPS URL，并按如下所示进行验证。

validateIssuer?: boolean

属性值

boolean

继承属性详细信息

id

资源 ID。注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 ProxyOnlyResource.id 的

kind

资源类型。

kind?: string

属性值

string

继承自ProxyOnlyResource.kind

name

资源名称。 注意：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 ProxyOnlyResource.name 的

type

资源类型。 注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ProxyOnlyResource.type