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

az webapp auth openid-connect

参考

注意

此参考是 Azure CLI（版本 2.23.0 或更高版本）的 authV2 扩展的一部分。该扩展将在首次运行 az webapp auth openid-connect 命令时自动安装。详细了解扩展。

管理自定义 OpenID 连接标识提供者的 Web 应用身份验证和授权。

命令

名称	说明	类型	Status
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 openid-connect add

配置新的自定义 OpenID 连接标识提供者。

az webapp auth openid-connect add --provider-name
                                  [--client-id]
                                  [--client-secret]
                                  [--client-secret-setting-name]
                                  [--ids]
                                  [--name]
                                  [--openid-configuration]
                                  [--resource-group]
                                  [--scopes]
                                  [--slot]
                                  [--subscription]
                                  [--yes]

示例

配置新的自定义 OpenID 连接标识提供者。

az webapp auth openid-connect add -g myResourceGroup --name MyWebApp \
  --provider-name myOpenIdConnectProvider --client-id my-client-id \
  --client-secret-setting-name MY_SECRET_APP_SETTING \
  --openid-configuration https://myopenidprovider.net/.well-known/openid-configuration

必需参数

--provider-name

自定义 OpenID 连接提供程序的名称。

可选参数

--client-id

用于登录的应用的客户端 ID。

--client-secret

用于登录的应用的应用程序机密。

--client-secret-setting-name --secret-setting

包含客户端密码的应用设置名称。

--ids

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

--name -n

Web 应用的名称。

--openid-configuration

包含提供程序的所有配置终结点的终结点。

--resource-group -g

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

--scopes

身份验证时应请求的范围列表。

--slot -s

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--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 openid-connect remove

删除现有的自定义 OpenID 连接标识提供者。

az webapp auth openid-connect remove --provider-name
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--slot]
                                     [--subscription]

示例

删除现有的自定义 OpenID 连接标识提供者。

az webapp auth openid-connect remove --name MyWebApp --resource-group MyResourceGroup \
  --provider-name myOpenIdConnectProvider

必需参数

--provider-name

自定义 OpenID 连接提供程序的名称。

可选参数

--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 openid-connect show

显示自定义 OpenID 连接标识提供者的身份验证设置。

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

示例

显示自定义 OpenID 连接标识提供者的身份验证设置。（自动生成）

az webapp auth openid-connect show --name MyWebApp --resource-group MyResourceGroup \ --provider-name myOpenIdConnectProvider

必需参数

--provider-name

自定义 OpenID 连接提供程序的名称。

可选参数

--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 openid-connect update

更新现有自定义 OpenID 连接标识提供者的客户端 ID 和客户端密码设置名称。

az webapp auth openid-connect update --provider-name
                                     [--client-id]
                                     [--client-secret]
                                     [--client-secret-setting-name]
                                     [--ids]
                                     [--name]
                                     [--openid-configuration]
                                     [--resource-group]
                                     [--scopes]
                                     [--slot]
                                     [--subscription]
                                     [--yes]

示例

更新现有自定义 OpenID 连接标识提供者的客户端 ID 和客户端密码设置名称。

az webapp auth openid-connect update -g myResourceGroup --name MyWebApp \
  --provider-name myOpenIdConnectProvider --client-id my-client-id \
  --client-secret-setting-name MY_SECRET_APP_SETTING

必需参数

--provider-name

自定义 OpenID 连接提供程序的名称。

可选参数

--client-id

用于登录的应用的客户端 ID。

--client-secret

用于登录的应用的应用程序机密。

--client-secret-setting-name --secret-setting

包含客户端密码的应用设置名称。

--ids

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

--name -n

Web 应用的名称。

--openid-configuration

包含提供程序的所有配置终结点的终结点。

--resource-group -g

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

--scopes

身份验证时应请求的范围列表。

--slot -s

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--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 openid-connect

命令

az webapp auth openid-connect add

示例

必需参数

可选参数

az webapp auth openid-connect remove

示例

必需参数

可选参数

az webapp auth openid-connect show

示例

必需参数

可选参数

az webapp auth openid-connect update

示例

必需参数

可选参数

其他资源