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

Web Apps - Update Auth Settings V2 Slot

Service:

App Service

API Version:

2023-12-01

汇报站点通过 V2 格式对应用的身份验证/授权设置的说明

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
name	path	True	string	Web 应用的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
slot	path	True	string	Web 应用槽的名称。 如果未指定，则默认为生产槽。
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

请求正文

名称	类型	说明
kind	string	资源类型。
properties.globalValidation	GlobalValidation	使用App 服务身份验证/授权确定用户的验证流的配置设置。
properties.httpSettings	HttpSettings	针对身份验证/授权的 HTTP 请求的配置设置和针对App 服务身份验证/授权发出的授权请求。
properties.identityProviders	IdentityProviders	用于配置身份验证/授权的每个标识提供者的配置设置App 服务。
properties.login	Login	使用 App 服务 身份验证/授权的用户登录流的配置设置。
properties.platform	AuthPlatform	App 服务身份验证/授权平台的配置设置。

响应

名称	类型	说明
200 OK	SiteAuthSettingsV2	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

定义

名称	说明
AllowedAudiencesValidation	允许的访问群体验证流的配置设置。
AllowedPrincipals	Azure Active Directory 允许的主体的配置设置。
Apple	Apple 提供程序的配置设置。
AppleRegistration	Apple 提供程序注册的配置设置
AppRegistration	具有应用 ID 和应用机密的提供程序的应用注册配置设置
AuthPlatform	App 服务身份验证/授权平台的配置设置。
AzureActiveDirectory	Azure Active Directory 提供程序的配置设置。
AzureActiveDirectoryLogin	Azure Active Directory 登录流的配置设置。
AzureActiveDirectoryRegistration	Azure Active Directory 应用注册的配置设置。
AzureActiveDirectoryValidation	Azure Active Directory 令牌验证流的配置设置。
AzureStaticWebApps	Azure Static Web Apps提供程序的配置设置。
AzureStaticWebAppsRegistration	Azure Static Web Apps提供程序注册的配置设置
BlobStorageTokenStore	如果使用 Blob 存储，则为令牌存储的配置设置。
ClientCredentialMethod	应用于对用户进行身份验证的方法。
ClientRegistration	具有客户端 ID 和客户端密码的提供程序的应用注册配置设置
CookieExpiration	会话 Cookie 过期的配置设置。
CookieExpirationConvention	确定会话 Cookie 的过期时使用的约定。
CustomOpenIdConnectProvider	自定义 Open ID Connect 提供程序的配置设置。
DefaultAuthorizationPolicy	Azure Active Directory 默认授权策略的配置设置。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
Facebook	Facebook提供程序的配置设置。
FileSystemTokenStore	如果使用文件系统，则为令牌存储的配置设置。
ForwardProxy	用于发出请求的转发代理的配置设置。
ForwardProxyConvention	用于确定所发出请求的 URL 的约定。
GitHub	GitHub 提供程序的配置设置。
GlobalValidation	使用App 服务身份验证/授权确定用户的验证流的配置设置。
Google	Google 提供程序的配置设置。
HttpSettings	针对身份验证/授权的 HTTP 请求的配置设置和针对App 服务身份验证/授权发出的授权请求。
HttpSettingsRoutes	路径 HTTP 请求的配置设置。
IdentityProviders	用于配置身份验证/授权的每个标识提供者的配置设置App 服务。
JwtClaimChecks	验证 JWT 声明时应进行的检查的配置设置。
LegacyMicrosoftAccount	旧版 Microsoft 帐户提供程序的配置设置。
Login	使用 App 服务 身份验证/授权的用户登录流的配置设置。
LoginRoutes	指定用于登录和注销请求的终结点的路由。
LoginScopes	登录流的配置设置，包括应请求的范围。
Nonce	登录流中使用的 nonce 的配置设置。
OpenIdConnectClientCredential	自定义 Open ID Connect 提供程序的身份验证客户端凭据。
OpenIdConnectConfig	用于自定义 Open ID Connect 提供程序的终结点的配置设置。
OpenIdConnectLogin	自定义 Open ID Connect 提供程序的登录流的配置设置。
OpenIdConnectRegistration	自定义 Open ID Connect 提供程序的应用注册的配置设置。
SiteAuthSettingsV2	Azure 应用服务身份验证/授权 V2 功能的配置设置。
TokenStore	令牌存储的配置设置。
Twitter	Twitter 提供程序的配置设置。
TwitterRegistration	Twitter 提供程序的应用注册的配置设置。
UnauthenticatedClientActionV2	未经身份验证的客户端尝试访问应用时要执行的操作。

AllowedAudiencesValidation

允许的访问群体验证流的配置设置。

名称	类型	说明
allowedAudiences	string[]	要从中验证 JWT 令牌的访问群体的允许列表的配置设置。

AllowedPrincipals

Azure Active Directory 允许的主体的配置设置。

名称	类型	说明
groups	string[]	允许的组的列表。
identities	string[]	允许的标识的列表。

Apple

Apple 提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果尽管设置了注册，但不应启用 Apple 提供程序;否则为 true。
login	LoginScopes	登录流的配置设置。
registration	AppleRegistration	Apple 注册的配置设置。

AppleRegistration

Apple 提供程序注册的配置设置

名称	类型	说明
clientId	string	用于登录的应用的客户端 ID。
clientSecretSettingName	string	包含客户端密码的应用设置名称。

AppRegistration

具有应用 ID 和应用机密的提供程序的应用注册配置设置

名称	类型	说明
appId	string	用于登录的应用的应用 ID。
appSecretSettingName	string	包含应用机密的应用设置名称。

AuthPlatform

App 服务身份验证/授权平台的配置设置。

名称	类型	说明
configFilePath	string	包含身份验证设置的配置文件的路径（如果它们来自文件）。 如果路径是相对路径，则 base 将用于站点的根目录。
enabled	boolean	true 如果为当前应用启用了身份验证/授权功能，则为 ;否则为 false。
runtimeVersion	string	用于当前应用的身份验证/授权功能的 RuntimeVersion。 此值中的设置可以控制身份验证/授权模块中某些功能的行为。

AzureActiveDirectory

Azure Active Directory 提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果尽管设置了注册，但不应启用 Azure Active Directory 提供程序，则为 ;否则为 true。
isAutoProvisioned	boolean	获取一个值，该值指示是否使用第一方工具自动预配 Azure AD 配置。 这是一个内部标志，主要用于支持 Azure 管理门户。 用户不应读取或写入此属性。
login	AzureActiveDirectoryLogin	Azure Active Directory 登录流的配置设置。
registration	AzureActiveDirectoryRegistration	Azure Active Directory 应用注册的配置设置。
validation	AzureActiveDirectoryValidation	Azure Active Directory 令牌验证流的配置设置。

AzureActiveDirectoryLogin

Azure Active Directory 登录流的配置设置。

名称	类型	说明
disableWWWAuthenticate	boolean	true 如果请求中应省略 www-authenticate 提供程序，则为 ;否则为 false。
loginParameters	string[]	用户登录时要发送到 OpenID Connect 授权终结点的登录参数。 每个参数必须采用“key=value”格式。

AzureActiveDirectoryRegistration

Azure Active Directory 应用注册的配置设置。

名称	类型	说明
clientId	string	此信赖方应用程序的客户端 ID，称为client_id。 若要使用 Azure Active Directory 或其他第三方 OpenID Connect 提供程序启用 OpenID 连接身份验证，则需要此设置。 有关 OpenID Connect 的详细信息： http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	客户端机密指纹的替代方法，即用于签名的证书的颁发者。 此属性充当客户端机密证书指纹的替代项。 这也是可选的。
clientSecretCertificateSubjectAlternativeName	string	客户端机密指纹的替代方法，即用于签名的证书的使用者可选名称。 此属性充当客户端机密证书指纹的替代项。 这也是可选的。
clientSecretCertificateThumbprint	string	客户端密码的替代方法，即用于签名的证书的指纹。 此属性充当客户端密码的替代项。 这也是可选的。
clientSecretSettingName	string	包含信赖方应用程序的客户端密码的应用设置名称。
openIdIssuer	string	OpenID Connect 颁发者 URI，表示为此应用程序颁发访问令牌的实体。 使用 Azure Active Directory 时，此值是目录租户的 URI，例如 https://login.microsoftonline.com/v2.0/{tenant-guid}/。 此 URI 是令牌颁发者的区分大小写的标识符。 有关 OpenID Connect 发现的详细信息： http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Azure Active Directory 令牌验证流的配置设置。

名称	类型	说明
allowedAudiences	string[]	可以成功发出身份验证/授权请求的访问群体列表。
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	默认授权策略的配置设置。
jwtClaimChecks	JwtClaimChecks	验证 JWT 声明时应进行的检查的配置设置。

AzureStaticWebApps

Azure Static Web Apps提供程序的配置设置。

名称	类型	说明
enabled	boolean	false如果尽管设置了注册，但不应启用Azure Static Web Apps提供程序，则为 ;否则为 true。
registration	AzureStaticWebAppsRegistration	Azure Static Web Apps注册的配置设置。

AzureStaticWebAppsRegistration

Azure Static Web Apps提供程序注册的配置设置

名称	类型	说明
clientId	string	用于登录的应用的客户端 ID。

BlobStorageTokenStore

如果使用 Blob 存储，则为令牌存储的配置设置。

名称	类型	说明
sasUrlSettingName	string	包含包含令牌的 Blob 存储的 SAS URL 的应用设置的名称。

ClientCredentialMethod

应用于对用户进行身份验证的方法。

名称	类型	说明
ClientSecretPost	string

ClientRegistration

具有客户端 ID 和客户端密码的提供程序的应用注册配置设置

名称	类型	说明
clientId	string	用于登录的应用的客户端 ID。
clientSecretSettingName	string	包含客户端密码的应用设置名称。

CookieExpiration

会话 Cookie 过期的配置设置。

名称	类型	说明
convention	CookieExpirationConvention	确定会话 Cookie 的过期时使用的约定。
timeToExpiration	string	发出请求后会话 Cookie 应过期的时间。

CookieExpirationConvention

确定会话 Cookie 的过期时使用的约定。

名称	类型	说明
FixedTime	string
IdentityProviderDerived	string

CustomOpenIdConnectProvider

自定义 Open ID Connect 提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果不应启用自定义 Open ID 提供程序，则为 ;否则为 true。
login	OpenIdConnectLogin	自定义 Open ID Connect 提供程序的登录流的配置设置。
registration	OpenIdConnectRegistration	自定义 Open ID Connect 提供程序的应用注册的配置设置。

DefaultAuthorizationPolicy

Azure Active Directory 默认授权策略的配置设置。

名称	类型	说明
allowedApplications	string[]	Azure Active Directory 允许的应用程序的配置设置。
allowedPrincipals	AllowedPrincipals	Azure Active Directory 允许的主体的配置设置。

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Facebook

Facebook提供程序的配置设置。

名称	类型	说明
enabled	boolean	false如果尽管设置了注册，但不应启用Facebook提供程序，则为 ;否则为 true。
graphApiVersion	string	登录时要使用的Facebook API 的版本。
login	LoginScopes	登录流的配置设置。
registration	AppRegistration	Facebook提供程序的应用注册的配置设置。

FileSystemTokenStore

如果使用文件系统，则为令牌存储的配置设置。

名称	类型	说明
directory	string	将存储令牌的目录。

ForwardProxy

用于发出请求的转发代理的配置设置。

名称	类型	说明
convention	ForwardProxyConvention	用于确定所发出请求的 URL 的约定。
customHostHeaderName	string	包含请求主机的标头的名称。
customProtoHeaderName	string	包含请求方案的标头的名称。

ForwardProxyConvention

用于确定所发出请求的 URL 的约定。

名称	类型	说明
Custom	string
NoProxy	string
Standard	string

GitHub

GitHub 提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果尽管设置了注册，但不应启用 GitHub 提供程序，否则为 true。
login	LoginScopes	登录流的配置设置。
registration	ClientRegistration	GitHub 提供程序的应用注册的配置设置。

GlobalValidation

使用App 服务身份验证/授权确定用户的验证流的配置设置。

名称	类型	说明
excludedPaths	string[]	未经身份验证的流不会重定向到登录页的路径。
redirectToProvider	string	配置多个提供程序时要使用的默认身份验证提供程序。 仅当配置了多个提供程序并且未经身份验证的客户端操作设置为“RedirectToLoginPage”时，才需要此设置。
requireAuthentication	boolean	true 如果需要身份验证流，则发出任何请求;否则为 false。
unauthenticatedClientAction	UnauthenticatedClientActionV2	未经身份验证的客户端尝试访问应用时要执行的操作。

Google

Google 提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果尽管设置了注册，但不应启用 Google 提供程序，则为 ;否则为 true。
login	LoginScopes	登录流的配置设置。
registration	ClientRegistration	Google 提供程序的应用注册的配置设置。
validation	AllowedAudiencesValidation	Azure Active Directory 令牌验证流的配置设置。

HttpSettings

针对身份验证/授权的 HTTP 请求的配置设置和针对App 服务身份验证/授权发出的授权请求。

名称	类型	说明
forwardProxy	ForwardProxy	用于发出请求的转发代理的配置设置。
requireHttps	boolean	false 如果允许没有 HTTPS 方案的身份验证/授权响应，则为 ;否则为 true。
routes	HttpSettingsRoutes	路径 HTTP 请求的配置设置。

HttpSettingsRoutes

路径 HTTP 请求的配置设置。

名称	类型	说明
apiPrefix	string	应在所有身份验证/授权路径之前的前缀。

IdentityProviders

用于配置身份验证/授权的每个标识提供者的配置设置App 服务。

名称	类型	说明
apple	Apple	Apple 提供程序的配置设置。
azureActiveDirectory	AzureActiveDirectory	Azure Active Directory 提供程序的配置设置。
azureStaticWebApps	AzureStaticWebApps	Azure Static Web Apps提供程序的配置设置。
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	每个自定义 Open ID Connect 提供程序的别名名称映射到自定义 Open ID Connect 提供程序的配置设置。
facebook	Facebook	Facebook提供程序的配置设置。
gitHub	GitHub	GitHub 提供程序的配置设置。
google	Google	Google 提供程序的配置设置。
legacyMicrosoftAccount	LegacyMicrosoftAccount	旧版 Microsoft 帐户提供程序的配置设置。
twitter	Twitter	Twitter 提供程序的配置设置。

JwtClaimChecks

验证 JWT 声明时应进行的检查的配置设置。

名称	类型	说明
allowedClientApplications	string[]	允许的客户端应用程序的列表。
allowedGroups	string[]	允许的组的列表。

LegacyMicrosoftAccount

旧版 Microsoft 帐户提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果不应启用旧版 Microsoft 帐户提供程序（尽管已设置注册）;否则为 true。
login	LoginScopes	登录流的配置设置。
registration	ClientRegistration	旧版 Microsoft 帐户提供程序的应用注册的配置设置。
validation	AllowedAudiencesValidation	旧版 Microsoft 帐户提供程序令牌验证流的配置设置。

Login

使用 App 服务 身份验证/授权的用户登录流的配置设置。

名称	类型	说明
allowedExternalRedirectUrls	string[]	可在登录或注销应用时重定向到的外部 URL。 请注意，将忽略 URL 的查询字符串部分。 这是一种高级设置，通常只有 Windows 应用商店应用程序后端才需要。 请注意，始终隐式允许当前域中的 URL。
cookieExpiration	CookieExpiration	会话 Cookie 过期的配置设置。
nonce	Nonce	登录流中使用的 nonce 的配置设置。
preserveUrlFragmentsForLogins	boolean	true 如果在发出登录请求后保留请求中的片段，则为 ;否则为 false。
routes	LoginRoutes	指定用于登录和注销请求的终结点的路由。
tokenStore	TokenStore	令牌存储的配置设置。

LoginRoutes

指定用于登录和注销请求的终结点的路由。

名称	类型	说明
logoutEndpoint	string	应在其中发出注销请求的终结点。

LoginScopes

登录流的配置设置，包括应请求的范围。

名称	类型	说明
scopes	string[]	身份验证时应请求的范围列表。

Nonce

登录流中使用的 nonce 的配置设置。

名称	类型	说明
nonceExpirationInterval	string	发出请求后，nonce 应过期的时间。
validateNonce	boolean	false 如果在完成登录流时不应验证 nonce，则为 ;否则为 true。

OpenIdConnectClientCredential

自定义 Open ID Connect 提供程序的身份验证客户端凭据。

名称	类型	说明
clientSecretSettingName	string	包含自定义 Open ID Connect 提供程序的客户端密码的应用设置。
method	ClientCredentialMethod	应用于对用户进行身份验证的方法。

OpenIdConnectConfig

用于自定义 Open ID Connect 提供程序的终结点的配置设置。

名称	类型	说明
authorizationEndpoint	string	用于发出授权请求的终结点。
certificationUri	string	提供验证令牌所需的密钥的终结点。
issuer	string	颁发令牌的终结点。
tokenEndpoint	string	用于请求令牌的终结点。
wellKnownOpenIdConfiguration	string	包含提供程序的所有配置终结点的终结点。

OpenIdConnectLogin

自定义 Open ID Connect 提供程序的登录流的配置设置。

名称	类型	说明
nameClaimType	string	包含用户名的声明的名称。
scopes	string[]	身份验证时应请求的范围列表。

OpenIdConnectRegistration

自定义 Open ID Connect 提供程序的应用注册的配置设置。

名称	类型	说明
clientCredential	OpenIdConnectClientCredential	自定义 Open ID Connect 提供程序的身份验证凭据。
clientId	string	自定义 Open ID Connect 提供程序的客户端 ID。
openIdConnectConfiguration	OpenIdConnectConfig	用于自定义 Open ID Connect 提供程序的终结点的配置设置。

SiteAuthSettingsV2

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

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.globalValidation	GlobalValidation	使用App 服务身份验证/授权确定用户的验证流的配置设置。
properties.httpSettings	HttpSettings	针对身份验证/授权的 HTTP 请求的配置设置和针对App 服务身份验证/授权发出的授权请求。
properties.identityProviders	IdentityProviders	用于配置身份验证/授权的每个标识提供者的配置设置App 服务。
properties.login	Login	使用 App 服务 身份验证/授权的用户登录流的配置设置。
properties.platform	AuthPlatform	App 服务身份验证/授权平台的配置设置。
type	string	资源类型。

TokenStore

令牌存储的配置设置。

名称	类型	说明
azureBlobStorage	BlobStorageTokenStore	如果使用 Blob 存储，则为令牌存储的配置设置。
enabled	boolean	true 用于持久存储登录流期间获取的平台特定安全令牌;否则为 false。 默认为 false。
fileSystem	FileSystemTokenStore	使用文件系统时令牌存储的配置设置。
tokenRefreshExtensionHours	number	会话令牌过期后的小时数，会话令牌可用于调用令牌刷新 API。 默认值为 72 小时。

Twitter

Twitter 提供程序的配置设置。

名称	类型	说明
enabled	boolean	false 如果尽管设置了注册，但不应启用 Twitter 提供程序;否则为 true。
registration	TwitterRegistration	Twitter 提供程序的应用注册的配置设置。

TwitterRegistration

Twitter 提供程序的应用注册的配置设置。

名称	类型	说明
consumerKey	string	用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者密钥。 此设置是启用 Twitter 登录所必需的。 Twitter Sign-In 文档： https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	应用设置名称，其中包含用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。

UnauthenticatedClientActionV2

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

名称	类型	说明
AllowAnonymous	string
RedirectToLoginPage	string
Return401	string
Return403	string