az webapp auth openid-connect

參考

注意

此參考是 Azure CLI 的 authV2 延伸模組的一部分 （2.23.0 版或更高版本）。擴充功能會在您第一次執行 az webapp auth openid-connect 命令時自動安裝。深入了解擴充功能。

管理自訂 OpenID 連線識別提供者的 Webapp 驗證和授權。

命令

名稱	Description	類型	狀態
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 連線識別提供者的用戶端識別碼和用戶端密碼設定名稱。	擴充	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

用於登入之應用程式的用戶端識別碼。

--client-secret

用於登入之應用程式的應用程式秘密。

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

包含用戶端密碼的應用程式設定名稱。

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源識別碼」引數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

Web 應用程式的名稱。

--openid-configuration

包含提供者所有組態端點的端點。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

--scopes

驗證時應要求的範圍清單。

--slot -s

位置的名稱。如果未指定，則預設為生產位置。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源識別碼」引數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

Web 應用程式的名稱。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

--slot -s

位置的名稱。如果未指定，則預設為生產位置。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源識別碼」引數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

Web 應用程式的名稱。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

--slot -s

位置的名稱。如果未指定，則預設為生產位置。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az webapp auth openid-connect update

更新現有自訂 OpenID 連線識別提供者的用戶端識別碼和用戶端密碼設定名稱。

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 連線識別提供者的用戶端識別碼和用戶端密碼設定名稱。

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

用於登入之應用程式的用戶端識別碼。

--client-secret

用於登入之應用程式的應用程式秘密。

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

包含用戶端密碼的應用程式設定名稱。

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源識別碼」引數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

Web 應用程式的名稱。

--openid-configuration

包含提供者所有組態端點的端點。

--resource-group -g

資源組名。您可以使用來設定預設群組 az configure --defaults group=<name> 。

--scopes

驗證時應要求的範圍清單。

--slot -s

位置的名稱。如果未指定，則預設為生產位置。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

範例

必要參數

選擇性參數

其他資源