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

az webapp auth

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展，使其受益于其扩展功能。 详细了解扩展。

管理 Web 应用身份验证和授权。 若要使用 v2 身份验证命令，请运行“az extension add --name authV2”以添加 authV2 CLI 扩展。

命令

名称	说明	类型	状态
az webapp auth apple	管理 Apple 标识提供者的 Webapp 身份验证和授权。	分机	GA
az webapp auth apple show	显示 Apple 标识提供者的身份验证设置。	分机	GA
az webapp auth apple update	更新 Apple 标识提供者的客户端 ID 和客户端密码。	扩展	GA
az webapp auth config-version	管理 Web 应用身份验证设置的配置版本的状态。 配置版本 v1 是指 /auth设置 终结点，而 v2 引用 /auth设置V2 终结点。	分机	GA
az webapp auth config-version revert	将 Web 应用的身份验证设置的配置版本从 v2 还原到 v1（经典）。	分机	GA
az webapp auth config-version show	显示 Web 应用的身份验证设置的配置版本。 配置版本 v1 是指 /auth设置 终结点，而 v2 引用 /auth设置V2 终结点。	扩展	GA
az webapp auth config-version upgrade	将 Web 应用的身份验证设置的配置版本从 v1（经典）升级到 v2。	分机	GA
az webapp auth facebook	管理 Facebook 标识提供者的 Webapp 身份验证和授权。	分机	GA
az webapp auth facebook show	显示 Facebook 标识提供者的身份验证设置。	分机	GA
az webapp auth facebook update	更新 Facebook 标识提供者的应用 ID 和应用机密。	分机	GA
az webapp auth github	管理 GitHub 标识提供者的 Webapp 身份验证和授权。	扩展	GA
az webapp auth github show	显示 GitHub 标识提供者的身份验证设置。	分机	GA
az webapp auth github update	更新 GitHub 标识提供者的客户端 ID 和客户端密码。	分机	GA
az webapp auth google	管理 Google 标识提供者的 Webapp 身份验证和授权。	扩展	GA
az webapp auth google show	显示 Google 标识提供者的身份验证设置。	扩展	GA
az webapp auth google update	更新 Google 标识提供者的客户端 ID 和客户端密码。	分机	GA
az webapp auth microsoft	管理 Microsoft 标识提供者的 Web 应用身份验证和授权。	扩展	GA
az webapp auth microsoft show	显示 Azure Active Directory 标识提供者的身份验证设置。	分机	GA
az webapp auth microsoft update	更新 Azure Active Directory 标识提供者的客户端 ID 和客户端密码。	分机	GA
az webapp auth openid-connect	管理自定义 OpenID 连接标识提供者的 Web 应用身份验证和授权。	分机	GA
az webapp auth openid-connect add	配置新的自定义 OpenID 连接标识提供者。	分机	GA
az webapp auth openid-connect remove	删除现有的自定义 OpenID 连接标识提供者。	扩展	GA
az webapp auth openid-connect show	显示自定义 OpenID 连接标识提供者的身份验证设置。	扩展	GA
az webapp auth openid-connect update	更新现有自定义 OpenID 连接标识提供者的客户端 ID 和客户端密码设置名称。	分机	GA
az webapp auth set	设置 v2 格式的 Web 应用的身份验证设置，覆盖任何现有设置。	分机	GA
az webapp auth show	显示 Web 应用的身份验证设置。	核心	GA
az webapp auth show (authV2 扩展)	以 v2 格式显示 Web 应用的身份验证设置。	分机	GA
az webapp auth twitter	管理 Twitter 标识提供者的 Webapp 身份验证和授权。	分机	GA
az webapp auth twitter show	显示 Twitter 标识提供者的身份验证设置。	分机	GA
az webapp auth twitter update	更新 Twitter 标识提供者的使用者密钥和使用者机密。	分机	GA
az webapp auth update	更新 Web 应用的身份验证设置。	核心	GA
az webapp auth update (authV2 扩展)	以 v2 格式更新 Web 应用的身份验证设置。	扩展	GA

az webapp auth set

设置 v2 格式的 Web 应用的身份验证设置，覆盖任何现有设置。

az webapp auth set [--body]
                   [--ids]
                   [--name]
                   [--resource-group]
                   [--slot]
                   [--subscription]

示例

将保存在文件 auth.json 中的 json 设置为 Web 应用的身份验证设置，覆盖任何现有设置。

az webapp auth set -g myResourceGroup --name MyWebApp --body @auth.json

可选参数

--body -b

Azure App 服务身份验证/授权 V2 功能的配置设置的 JSON 表示形式。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

Web 应用的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--slot -s

槽的名称。 如果未指定，则默认为生产槽。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az webapp auth show

显示 Web 应用的身份验证设置。

az webapp auth show [--ids]
                    [--name]
                    [--resource-group]
                    [--slot]
                    [--subscription]

示例

显示 Web 应用的身份验证设置。 （自动生成）

az webapp auth show --name MyWebApp --resource-group MyResourceGroup

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

Web 应用的名称。 如果未指定，则会随机生成名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults web=<name>。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--slot -s

槽的名称。 如果未指定，则默认为生产槽。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az webapp auth show (authV2 扩展)

以 v2 格式显示 Web 应用的身份验证设置。

az webapp auth show [--ids]
                    [--name]
                    [--resource-group]
                    [--slot]
                    [--subscription]

示例

显示 Web 应用的身份验证设置。 （自动生成）

az webapp auth show --name MyWebApp --resource-group MyResourceGroup

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

Web 应用的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--slot -s

槽的名称。 如果未指定，则默认为生产槽。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az webapp auth update

更新 Web 应用的身份验证设置。

az webapp auth update [--aad-allowed-token-audiences]
                      [--aad-client-id]
                      [--aad-client-secret]
                      [--aad-client-secret-certificate-thumbprint]
                      [--aad-token-issuer-url]
                      [--action {AllowAnonymous, LoginWithAzureActiveDirectory, LoginWithFacebook, LoginWithGoogle, LoginWithMicrosoftAccount, LoginWithTwitter}]
                      [--allowed-external-redirect-urls]
                      [--enabled {false, true}]
                      [--facebook-app-id]
                      [--facebook-app-secret]
                      [--facebook-oauth-scopes]
                      [--google-client-id]
                      [--google-client-secret]
                      [--google-oauth-scopes]
                      [--ids]
                      [--microsoft-account-client-id]
                      [--microsoft-account-client-secret]
                      [--microsoft-account-oauth-scopes]
                      [--name]
                      [--resource-group]
                      [--runtime-version]
                      [--slot]
                      [--subscription]
                      [--token-refresh-extension-hours]
                      [--token-store {false, true}]
                      [--twitter-consumer-key]
                      [--twitter-consumer-secret]

示例

通过启用身份验证和设置 AAD 关联的参数来启用 AAD。 默认提供程序设置为 AAD。 必须事先创建 AAD 服务主体。

az webapp auth update  -g myResourceGroup -n myUniqueApp --enabled true \
  --action LoginWithAzureActiveDirectory \
  --aad-allowed-token-audiences https://webapp_name.azurewebsites.net/.auth/login/aad/callback \
  --aad-client-id ecbacb08-df8b-450d-82b3-3fced03f2b27 --aad-client-secret very_secret_password \
  --aad-token-issuer-url https://sts.windows.net/54826b22-38d6-4fb2-bad9-b7983a3e9c5a/

通过设置 FB 关联的参数并打开公共配置文件和电子邮件范围，允许 Facebook 身份验证;允许匿名用户

az webapp auth update -g myResourceGroup -n myUniqueApp --action AllowAnonymous \
  --facebook-app-id my_fb_id --facebook-app-secret my_fb_secret \
  --facebook-oauth-scopes public_profile email

可选参数

--aad-allowed-token-audiences

一个或多个令牌访问群体（逗号分隔）。

--aad-client-id

将 AAD 组织帐户登录集成到 Web 应用的应用程序 ID。

--aad-client-secret

AAD 应用程序机密。

--aad-client-secret-certificate-thumbprint --thumbprint

替代 AAD 客户端密码，用于签名的证书指纹。

--aad-token-issuer-url

可以在使用 tenantID 从 Active Directory 终结点返回的 JSON 输出中找到此 URL。 可以从“endpoints.activeDirectory”查询 az cloud show 终结点。 可以使用 找到 az account showtenantID。 在 //.known/openid-configuration 中从 JSON 获取“颁发者”。

--action

接受的值: AllowAnonymous, LoginWithAzureActiveDirectory, LoginWithFacebook, LoginWithGoogle, LoginWithMicrosoftAccount, LoginWithTwitter

--allowed-external-redirect-urls

一个或多个 URL（空格分隔）。

--enabled

接受的值: false, true

--facebook-app-id

将 Facebook 登录集成到 Web 应用中的应用程序 ID。

--facebook-app-secret

Facebook 应用程序客户端机密。

--facebook-oauth-scopes

一个或多个 facebook 身份验证范围（逗号分隔）。

--google-client-id

将 Google 登录集成到 Web 应用中的应用程序 ID。

--google-client-secret

Google Application 客户端机密。

--google-oauth-scopes

一个或多个 Google 身份验证范围（空格分隔）。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--microsoft-account-client-id

AAD V2 应用程序 ID，用于将 Microsoft 帐户登录集成到 Web 应用中。

--microsoft-account-client-secret

AAD V2 应用程序客户端密码。

--microsoft-account-oauth-scopes

一个或多个 Microsoft 身份验证范围（逗号分隔）。

--name -n

Web 应用的名称。 如果未指定，则会随机生成名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults web=<name>。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--runtime-version

用于当前应用的身份验证/授权功能的运行时版本。

--slot -s

槽的名称。 如果未指定，则默认为生产槽。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--token-refresh-extension-hours

小时数必须可格式化为浮点数。

--token-store

使用App 服务令牌存储。

接受的值: false, true

--twitter-consumer-key

将 Twitter 登录集成到 Web 应用中的应用程序 ID。

--twitter-consumer-secret

Twitter 应用程序客户端机密。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az webapp auth update (authV2 扩展)

以 v2 格式更新 Web 应用的身份验证设置。

az webapp auth update [--action {AllowAnonymous, RedirectToLoginPage, Return401, Return403, Return404}]
                      [--config-file-path]
                      [--custom-host-header]
                      [--custom-proto-header]
                      [--enable-token-store {false, true}]
                      [--enabled {false, true}]
                      [--excluded-paths]
                      [--ids]
                      [--name]
                      [--proxy-convention {Custom, NoProxy, Standard}]
                      [--redirect-provider]
                      [--require-https {false, true}]
                      [--resource-group]
                      [--runtime-version]
                      [--set]
                      [--slot]
                      [--subscription]

示例

更新已配置的 AAD 提供程序的客户端 ID

az webapp auth update -g myResourceGroup --name MyWebApp --set identityProviders.azureActiveDirectory.registration.clientId=my-client-id

将应用的运行时版本固定到 1.4.7

az webapp auth update -g myResourceGroup --name MyWebApp --runtime-version 1.4.7

通过设置配置文件路径，使用基于文件的身份验证配置应用

az webapp auth update -g myResourceGroup --name MyWebApp --config-file-path D:\home\site\wwwroot\auth.json

将应用配置为允许未经身份验证的请求命中应用。

az webapp auth update -g myResourceGroup --name MyWebApp --unauthenticated-client-action AllowAnonymous

将应用配置为将未经身份验证的请求重定向到 Facebook 提供程序

az webapp auth update -g myResourceGroup --name MyWebApp --redirect-provider Facebook

将应用配置为侦听转发标头 X-FORWARDED-HOST 和 X-FORWARDED-PROTO

az webapp auth update -g myResourceGroup --name MyWebApp --proxy-convention Standard

可选参数

--action --unauthenticated-client-action

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

接受的值: AllowAnonymous, RedirectToLoginPage, Return401, Return403, Return404

--config-file-path

包含身份验证设置的配置文件的路径（如果它们来自文件）。

--custom-host-header --proxy-custom-host-header

包含请求主机的标头的名称。

--custom-proto-header --proxy-custom-proto-header

包含请求方案的标头的名称。

--enable-token-store

如此 可持久存储登录流期间获取的平台特定的安全令牌;否则为 false。

接受的值: false, true

--enabled

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

接受的值: false, true

--excluded-paths

应从身份验证规则中排除的路径列表。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

Web 应用的名称。

--proxy-convention

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

接受的值: Custom, NoProxy, Standard

--redirect-provider

配置多个提供程序时要使用的默认身份验证提供程序。

--require-https

如果不允许使用 HTTPS 方案的身份验证/授权响应，则为 False;否则为 true。

接受的值: false, true

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--runtime-version

用于当前应用的身份验证/授权功能的 RuntimeVersion。

--set

Azure App 服务身份验证/授权 V2 功能配置设置中特定字段的值。

--slot -s

槽的名称。 如果未指定，则默认为生产槽。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。