az afd endpoint

Note

このリファレンスは、Azure CLI (バージョン 2.85.0 以降) の cdn 拡張機能の一部です。 拡張機能は、 az afd endpoint コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

指定したプロファイル内の AFD エンドポイントを管理します。 エンドポイントは、ドメインとそれに関連する構成の論理的なグループです。

コマンド

名前	説明	型	状態
az afd endpoint create	指定したサブスクリプション、リソース グループ、およびプロファイルの下に、指定したエンドポイント名を持つ新しい AzureFrontDoor エンドポイントを作成します。	拡張	GA
az afd endpoint delete	指定したサブスクリプション、リソース グループ、およびプロファイルの下で、指定したエンドポイント名を持つ既存の AzureFrontDoor エンドポイントを削除します。	拡張	GA
az afd endpoint list	既存の AzureFrontDoor エンドポイントを一覧表示します。	拡張	GA
az afd endpoint purge	AzureFrontDoor からコンテンツを削除します。	拡張	GA
az afd endpoint show	指定したサブスクリプション、リソース グループ、およびプロファイルの下に、指定したエンドポイント名を持つ既存の AzureFrontDoor エンドポイントを取得します。	拡張	GA
az afd endpoint update	新しい AzureFrontDoor エンドポイントを、指定したサブスクリプション、リソース グループ、およびプロファイルの下の指定したエンドポイント名で更新します。	拡張	GA
az afd endpoint wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA

az afd endpoint create

指定したサブスクリプション、リソース グループ、およびプロファイルの下に、指定したエンドポイント名を持つ新しい AzureFrontDoor エンドポイントを作成します。

az afd endpoint create --endpoint-name --name
                       --profile-name
                       --resource-group
                       [--acquire-policy-token]
                       [--change-reference]
                       [--enabled-state {Disabled, Enabled}]
                       [--enforce-mtls {Disabled, Enabled}]
                       [--name-reuse-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--tags]

例

AFDEndpoints_Create

az afd endpoint create --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --location global --name-reuse-scope TenantReuse --enabled-state Enabled --enforce-mtls Disabled --tags "{}"

必須のパラメーター

--endpoint-name --name -n

グローバルに一意であるプロファイルの下のエンドポイントの名前。

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--enabled-state

この規則の使用を有効にするかどうかを指定します。 使用できる値は 、'Enabled' または 'Disabled' です。

プロパティ	値
パラメーター グループ:	Properties Arguments
指定可能な値:	Disabled, Enabled

--enforce-mtls

既定では [無効] に設定されています。 [有効] に設定すると、mTLS が有効になっているカスタム ドメインのみを子ルート リソースに追加できます。

プロパティ	値
パラメーター グループ:	Properties Arguments
指定可能な値:	Disabled, Enabled

--name-reuse-scope

エンドポイント名の再利用スコープを示します。 既定値は TenantReuse です。

プロパティ	値
パラメーター グループ:	Properties Arguments
指定可能な値:	NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ	値
パラメーター グループ:	Endpoint Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az afd endpoint delete

指定したサブスクリプション、リソース グループ、およびプロファイルの下で、指定したエンドポイント名を持つ既存の AzureFrontDoor エンドポイントを削除します。

az afd endpoint delete [--acquire-policy-token]
                       [--change-reference]
                       [--endpoint-name --name]
                       [--ids]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--profile-name]
                       [--resource-group]
                       [--subscription]
                       [--yes]

例

AFDEndpoints_Delete

az afd endpoint delete --resource-group RG --profile-name profile1 --endpoint-name endpoint1

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--endpoint-name --name -n

グローバルに一意であるプロファイルの下のエンドポイントの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az afd endpoint list

既存の AzureFrontDoor エンドポイントを一覧表示します。

az afd endpoint list --profile-name
                     --resource-group
                     [--max-items]
                     [--next-token]

例

AFDEndpoints_ListByProfile

az afd endpoint list --resource-group RG --profile-name profile1

必須のパラメーター

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ	値
パラメーター グループ:	Pagination Arguments

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

プロパティ	値
パラメーター グループ:	Pagination Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az afd endpoint purge

AzureFrontDoor からコンテンツを削除します。

az afd endpoint purge --content-paths
                      [--acquire-policy-token]
                      [--change-reference]
                      [--domains]
                      [--endpoint-name]
                      [--ids]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--profile-name]
                      [--resource-group]
                      [--subscription]

例

AFDEndpoints_PurgeContent

az afd endpoint purge --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --content-paths "[/folder1]" --domains "[endpoint1-abcdefghijklmnop.z01.azurefd.net]"

必須のパラメーター

--content-paths

消去するコンテンツへのパス。 ファイル パスまたはワイルドカード ディレクトリを記述できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ	値
パラメーター グループ:	Contents Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--domains

ドメインの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ	値
パラメーター グループ:	Contents Arguments

--endpoint-name

グローバルに一意であるプロファイルの下のエンドポイントの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az afd endpoint show

指定したサブスクリプション、リソース グループ、およびプロファイルの下に、指定したエンドポイント名を持つ既存の AzureFrontDoor エンドポイントを取得します。

az afd endpoint show [--endpoint-name --name]
                     [--ids]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]

例

AFDEndpoints_Get

az afd endpoint show --resource-group RG --profile-name profile1 --endpoint-name endpoint1

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--endpoint-name --name -n

グローバルに一意であるプロファイルの下のエンドポイントの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az afd endpoint update

新しい AzureFrontDoor エンドポイントを、指定したサブスクリプション、リソース グループ、およびプロファイルの下の指定したエンドポイント名で更新します。

az afd endpoint update [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--enabled-state {Disabled, Enabled}]
                       [--endpoint-name --name]
                       [--enforce-mtls {Disabled, Enabled}]
                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                       [--ids]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--profile-name]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--subscription]
                       [--tags]

例

AFDEndpoints_Create

az afd endpoint update --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --name-reuse-scope TenantReuse --enabled-state Enabled --enforce-mtls Disabled --tags "{}"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
パラメーター グループ:	Generic Update Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--enabled-state

この規則の使用を有効にするかどうかを指定します。 使用できる値は 、'Enabled' または 'Disabled' です。

プロパティ	値
パラメーター グループ:	Properties Arguments
指定可能な値:	Disabled, Enabled

--endpoint-name --name -n

グローバルに一意であるプロファイルの下のエンドポイントの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--enforce-mtls

既定では [無効] に設定されています。 [有効] に設定すると、mTLS が有効になっているカスタム ドメインのみを子ルート リソースに追加できます。

プロパティ	値
パラメーター グループ:	Properties Arguments
指定可能な値:	Disabled, Enabled

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
パラメーター グループ:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
パラメーター グループ:	Generic Update Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
パラメーター グループ:	Generic Update Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ	値
パラメーター グループ:	Endpoint Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az afd endpoint wait

条件が満たされるまで CLI を待機状態にします。

az afd endpoint wait [--acquire-policy-token]
                     [--change-reference]
                     [--created]
                     [--custom]
                     [--deleted]
                     [--endpoint-name --name]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--endpoint-name --name -n

グローバルに一意であるプロファイルの下のエンドポイントの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--exists

リソースが存在するまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	30

--profile-name

リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium プロファイルの名前。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーター グループ:	Resource Id Arguments

--timeout

最大待機時間 (秒単位)。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
パラメーター グループ:	Wait Condition Arguments
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False