az webapp auth

リファレンス

Note

このコマンドグループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。各拡張機能をインストールして、拡張機能を活用します。拡張機能の詳細をご覧ください。

Web アプリの認証と承認を管理します。 v2 認証コマンドを使用するには、"az extension add --name authV2" を実行して authV2 CLI 拡張機能を追加します。

コマンド

名前	説明	型	状態
az webapp auth apple	Apple ID プロバイダーの Web アプリの認証と承認を管理します。	拡張	GA
az webapp auth apple show	Apple ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth apple update	Apple ID プロバイダーのクライアント 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 ID プロバイダーの Web アプリの認証と承認を管理します。	拡張	GA
az webapp auth facebook show	Facebook ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth facebook update	Facebook ID プロバイダーのアプリ ID とアプリシークレットを更新します。	拡張	GA
az webapp auth github	GitHub ID プロバイダーの Web アプリの認証と承認を管理します。	拡張	GA
az webapp auth github show	GitHub ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth github update	GitHub ID プロバイダーのクライアント ID とクライアントシークレットを更新します。	拡張	GA
az webapp auth google	Google ID プロバイダーの Web アプリの認証と承認を管理します。	拡張	GA
az webapp auth google show	Google ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth google update	Google ID プロバイダーのクライアント ID とクライアントシークレットを更新します。	拡張	GA
az webapp auth microsoft	Microsoft ID プロバイダーの Web アプリの認証と承認を管理します。	拡張	GA
az webapp auth microsoft show	Azure Active Directory ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth microsoft update	Azure Active Directory ID プロバイダーのクライアント ID とクライアントシークレットを更新します。	拡張	GA
az webapp auth openid-connect	カスタム OpenID Connect ID プロバイダーの Web アプリ認証と承認を管理します。	拡張	GA
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 set	Web アプリの認証設定を v2 形式で設定し、既存の設定を上書きします。	拡張	GA
az webapp auth show	Web アプリの認証設定を表示します。	コア	GA
az webapp auth show (authV2 拡張機能)	Web アプリの認証設定を v2 形式で表示します。	拡張	GA
az webapp auth twitter	Twitter ID プロバイダーの Web アプリの認証と承認を管理します。	拡張	GA
az webapp auth twitter show	Twitter ID プロバイダーの認証設定を表示します。	拡張	GA
az webapp auth twitter update	Twitter ID プロバイダーのコンシューマーキーとコンシューマーシークレットを更新します。	拡張	GA
az webapp auth update	Web アプリの認証設定を更新します。	コア	GA
az webapp auth update (authV2 拡張機能)	v2 形式で Web アプリの認証設定を更新します。	拡張	GA

az webapp auth set

Web アプリの認証設定を v2 形式で設定し、既存の設定を上書きします。

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 アプリサービス認証/承認 V2 機能の構成設定の JSON 表記。

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

Web アプリの認証設定を表示します。

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

例

Web アプリの認証設定を表示します。 (自動生成)

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

省略可能のパラメーター

--ids

--name -n

Web アプリの名前。指定しない場合、名前がランダムに生成されます。を使用して 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 拡張機能)

Web アプリの認証設定を v2 形式で表示します。

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

例

Web アプリの認証設定を表示します。 (自動生成)

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

省略可能のパラメーター

--ids

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

1 つ以上のトークン対象ユーザー (コンマ区切り)。

--aad-client-id

AAD 組織アカウントのサインインを Web アプリに統合するためのアプリケーション ID。

--aad-client-secret

AAD アプリケーションシークレット。

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

AAD クライアントシークレットの代わりに、署名目的で使用される証明書の拇印。

--aad-token-issuer-url

この URL は、tenantID を使用して Active Directory エンドポイントから返される JSON 出力にあります。エンドポイントは、"endpoints.activeDirectory" から az cloud show 照会できます。 tenantID は次を使用して az account show見つけることができます。 JSON (//.well-known/openid-configuration) から "issuer" を取得します。

--action

指定可能な値: AllowAnonymous, LoginWithAzureActiveDirectory, LoginWithFacebook, LoginWithGoogle, LoginWithMicrosoftAccount, LoginWithTwitter

--allowed-external-redirect-urls

1 つ以上の URL (スペース区切り)。

--enabled

指定可能な値: false, true

--facebook-app-id

Facebook サインインを Web アプリに統合するためのアプリケーション ID。

--facebook-app-secret

Facebook アプリケーションクライアントシークレット。

--facebook-oauth-scopes

1 つ以上の facebook 認証スコープ (コンマ区切り)。

--google-client-id

Google サインインを Web アプリに統合するためのアプリケーション ID。

--google-client-secret

Google アプリケーションクライアントシークレット。

--google-oauth-scopes

1 つ以上の Google 認証スコープ (スペース区切り)。

--ids

--microsoft-account-client-id

Microsoft アカウントサインインを Web アプリに統合するための AAD V2 アプリケーション ID。

--microsoft-account-client-secret

AAD V2 アプリケーションクライアントシークレット。

--microsoft-account-oauth-scopes

1 つ以上の Microsoft 認証スコープ (コンマ区切り)。

--name -n

Web アプリの名前。指定しない場合、名前がランダムに生成されます。を使用して 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 Service トークンストアを使用します。

指定可能な値: 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

True を指定すると、ログインフロー中に取得されるプラットフォーム固有のセキュリティトークンが永続的に格納されます。それ以外の場合は false。

指定可能な値: false, true

--enabled

現在のアプリで認証/承認機能が有効になっている場合は True。それ以外の場合は false。

指定可能な値: false, true

--excluded-paths

認証規則から除外する必要があるパスの一覧。

--ids

--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 アプリサービス認証/承認 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 を使います。

次の方法で共有

az webapp auth

コマンド

az webapp auth set

例

省略可能のパラメーター

az webapp auth show

例

省略可能のパラメーター

az webapp auth show (authV2 拡張機能)

例

省略可能のパラメーター

az webapp auth update

例

省略可能のパラメーター

az webapp auth update (authV2 拡張機能)

例

省略可能のパラメーター

その他のリソース