az webapp auth openid-connect

Note

このリファレンスは、Azure CLI (バージョン 2.23.0 以降) の authV2 拡張機能の一部です。 拡張機能は、az webapp auth openid-connect コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

カスタム OpenID Connect ID プロバイダーの Web アプリ認証と承認を管理します。

コマンド

名前	説明	型	Status
az webapp auth openid-connect add	新しいカスタム OpenID Connect ID プロバイダーを構成します。	拡張	GA
az webapp auth openid-connect remove	既存のカスタム OpenID Connect ID プロバイダーを削除します。	拡張	GA
az webapp auth openid-connect show	カスタム OpenID Connect ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth openid-connect update	既存のカスタム OpenID Connect ID プロバイダーのクライアント ID とクライアント シークレット設定名を更新します。	拡張	GA

az webapp auth openid-connect add

新しいカスタム OpenID Connect ID プロバイダーを構成します。

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 Connect ID プロバイダーを構成します。

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 Connect プロバイダーの名前。

省略可能のパラメーター

--client-id

ログインに使用されるアプリのクライアント ID。

--client-secret

ログインに使用されるアプリのアプリケーション シークレット。

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

クライアント シークレットを含むアプリ設定名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 Connect ID プロバイダーを削除します。

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

例

既存のカスタム OpenID Connect ID プロバイダーを削除します。

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

必須のパラメーター

--provider-name

カスタム OpenID Connect プロバイダーの名前。

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 Connect ID プロバイダーの認証設定を表示します。

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

例

カスタム OpenID Connect ID プロバイダーの認証設定を表示します。 (自動生成)

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

必須のパラメーター

--provider-name

カスタム OpenID Connect プロバイダーの名前。

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 Connect ID プロバイダーのクライアント 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 Connect ID プロバイダーのクライアント 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 Connect プロバイダーの名前。

省略可能のパラメーター

--client-id

ログインに使用されるアプリのクライアント ID。

--client-secret

ログインに使用されるアプリのアプリケーション シークレット。

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

クライアント シークレットを含むアプリ設定名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 を使います。