Share via

az afd route

  • リファレンス

AFD エンドポイントでルートを管理します。

コマンド

名前 説明 型 Status
az afd route create

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

 コア GA
az afd route delete

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

 コア GA
az afd route list

プロファイル内のすべての既存の配信元を一覧表示します。

 コア GA
az afd route show

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

 コア GA
az afd route update

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

 コア GA
az afd route wait

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

 コア GA

az afd route create

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

az afd route create --endpoint-name
                    --name
                    --profile-name
                    --resource-group
                    [--content-types-to-compress]
                    [--custom-domains]
                    [--enable-caching {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enabled-state {Disabled, Enabled}]
                    [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                    [--https-redirect {Disabled, Enabled}]
                    [--link-to-default-domain {Disabled, Enabled}]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--origin-group]
                    [--origin-path]
                    [--patterns-to-match]
                    [--query-parameters]
                    [--query-string-caching-behavior]
                    [--rule-sets]
                    [--supported-protocols]

例

エンドポイントの既定の doメイン をすべての HTTPS 要求の配信元グループに関連付けるルートを作成します。

az afd route create -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --https-redirect Disabled --origin-group og001 --supported-protocols Https --link-to-default-domain Enabled --forwarding-protocol MatchRequest

エンドポイントの既定の doメイン をすべての要求の配信元グループに関連付けるルートを作成し、指定したルール セットを使用してルートの動作をカスタマイズします。

az afd route create -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --rule-sets ruleset1 rulseset2 --origin-group og001 --supported-protocols Http Https --link-to-default-domain Enabled --forwarding-protocol MatchRequest --https-redirect Disabled

エンドポイントの既定の doメイン とカスタム doメイン を指定したパス パターンを持つすべての要求の配信元グループに関連付けるルートを作成し、すべての trafic を Https を使用するようにリダイレクトします。

az afd route create -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --patterns-to-match /test1/* /tes2/* --origin-group og001 --supported-protocols Http Https --custom-domains cd001 --forwarding-protocol MatchRequest --https-redirect Enabled --link-to-default-domain Enabled

必須のパラメーター

--endpoint-name

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

--name --route-name -n

ルーティング規則の名前。

--profile-name

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

--resource-group -g

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

省略可能のパラメーター

--content-types-to-compress

圧縮が適用されるコンテンツ タイプの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--custom-domains

このエンドポイントによって参照されるカスタム doメイン。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--enable-caching

キャッシュがそのルートにエンアンブルされているかどうかを示します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--enable-compression

AzureFrontDoor でコンテンツ圧縮が有効かどうかを示します。 既定値は false です。 圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。要求されたコンテンツが 1 バイトより小さいか、1 MB (メガバイト)より大きい場合、コンテンツは AzureFrontDoorwhen で圧縮されません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

この規則の使用を許可するかどうか。 使用できる値は 、'Enabled' または 'Disabled' です。

承認された値: Disabled, Enabled
--forwarding-protocol

バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。

承認された値: HttpOnly, HttpsOnly, MatchRequest
既定値: MatchRequest
--https-redirect

HTTP トラフィックを HTTPS トラフィックに自動的にリダイレクトするかどうか。 これは、このルールを設定する簡単な方法であり、実行される最初のルールであることに注意してください。

承認された値: Disabled, Enabled
既定値: Disabled
--link-to-default-domain

このルートを既定のエンドポイント ドメインにリンクするかどうか。

承認された値: Disabled, Enabled
既定値: Disabled
--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--origin-group

関連付ける配信元グループの名前または ID。

--origin-path

AzureFrontDoor がコンテンツの取得に使用できる配信元のディレクトリ パス (例: contoso.cloudapp.net/originpath)。

--patterns-to-match

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

--query-parameters

含めるか除外するクエリ パラメーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--query-string-caching-behavior

クエリ文字列を含む要求を Frontdoor がキャッシュする方法を定義します。キャッシュ時、特定のクエリ文字列を無視する場合、一意の URL を使用してすべての要求をキャッシュする場合、または特定のクエリ文字列をキャッシュする場合は、クエリ文字列を無視できます。

--rule-sets

ルートによって参照される規則セットの ID または名前のコレクション。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--supported-protocols

このルートでサポートされているプロトコルのリスト。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

既定値: ['Http', 'Https']
グローバル パラメーター
--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 afd route delete

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

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

例

route1 という名前のルートを削除します。

az afd route delete -g group --profile-name profile --endpoint-name endpoint1 --route-name route1

省略可能のパラメーター

--endpoint-name

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

--ids

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

--name --route-name -n

ルーティング規則の名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

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

--resource-group -g

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

--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 afd route list

プロファイル内のすべての既存の配信元を一覧表示します。

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

必須のパラメーター

--endpoint-name

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

--profile-name

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

--resource-group -g

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

省略可能のパラメーター

--max-items

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

--next-token

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

グローバル パラメーター
--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 afd route show

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

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

省略可能のパラメーター

--endpoint-name

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

--ids

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

--name --route-name -n

ルーティング規則の名前。

--profile-name

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

--resource-group -g

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

--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 afd route update

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

az afd route update [--add]
                    [--content-types-to-compress]
                    [--custom-domains]
                    [--enable-caching {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enabled-state {Disabled, Enabled}]
                    [--endpoint-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                    [--https-redirect {Disabled, Enabled}]
                    [--ids]
                    [--link-to-default-domain {Disabled, Enabled}]
                    [--name]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--origin-group]
                    [--origin-path]
                    [--patterns-to-match]
                    [--profile-name]
                    [--query-parameters]
                    [--query-string-caching-behavior]
                    [--remove]
                    [--resource-group]
                    [--rule-sets]
                    [--set]
                    [--subscription]
                    [--supported-protocols]

例

Http 要求と Https 要求の両方を受け入れるようにルートを更新し、Https を使用するようにすべての trafic をリダイレクトします。

az afd route update -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --supported-protocols Http Https --https-redirect Enabled

ルートのルール セットの設定を更新して、ルートの動作をカスタマイズします。

az afd route update -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --rule-sets ruleset1 rulseset2

ルートの圧縮設定を更新して、指定したコンテンツ タイプの圧縮を有効にします。

az afd route update -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --query-string-caching-behavior IgnoreQueryString --enable-compression true --content-types-to-compress text/javascript text/plain

省略可能のパラメーター

--add

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

--content-types-to-compress

圧縮が適用されるコンテンツ タイプの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--custom-domains

このエンドポイントによって参照されるカスタム doメイン。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--enable-caching

キャッシュがそのルートにエンアンブルされているかどうかを示します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--enable-compression

AzureFrontDoor でコンテンツ圧縮が有効かどうかを示します。 既定値は false です。圧縮が有効になっている場合、ユーザーが圧縮バージョンを要求した場合、コンテンツは圧縮として処理されます。要求されたコンテンツが 1 バイトより小さいか、1 MB (メガバイト)より大きい場合、コンテンツは AzureFrontDoorwhen で圧縮されません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

この規則の使用を許可するかどうか。 使用できる値は 、'Enabled' または 'Disabled' です。

承認された値: Disabled, Enabled
--endpoint-name

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

--force-string

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--forwarding-protocol

バックエンドにトラフィックを転送するときに、このルールが使用するプロトコル。

承認された値: HttpOnly, HttpsOnly, MatchRequest
--https-redirect

HTTP トラフィックを HTTPS トラフィックに自動的にリダイレクトするかどうか。 これは、このルールを設定する簡単な方法であり、実行される最初のルールであることに注意してください。

承認された値: Disabled, Enabled
--ids

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

--link-to-default-domain

このルートを既定のエンドポイント ドメインにリンクするかどうか。

承認された値: Disabled, Enabled
--name --route-name -n

ルーティング規則の名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--origin-group

関連付ける配信元グループの名前または ID。

--origin-path

AzureFrontDoor がコンテンツの取得に使用できる配信元のディレクトリ パス (例: contoso.cloudapp.net/originpath)。

--patterns-to-match

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

--profile-name

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

--query-parameters

含めるか除外するクエリ パラメーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--query-string-caching-behavior

クエリ文字列を含む要求を Frontdoor がキャッシュする方法を定義します。キャッシュ時、特定のクエリ文字列を無視する場合、一意の URL を使用してすべての要求をキャッシュする場合、または特定のクエリ文字列をキャッシュする場合は、クエリ文字列を無視できます。

--remove

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

--resource-group -g

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

--rule-sets

ルートによって参照される規則セットの ID または名前のコレクション。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--set

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

--subscription

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

--supported-protocols

このルートでサポートされているプロトコルのリスト。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 afd route wait

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

az afd route wait [--created]
                  [--custom]
                  [--deleted]
                  [--endpoint-name]
                  [--exists]
                  [--ids]
                  [--interval]
                  [--name]
                  [--profile-name]
                  [--resource-group]
                  [--subscription]
                  [--timeout]
                  [--updated]

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--endpoint-name

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

--exists

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

既定値: False
--ids

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

--interval

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

既定値: 30
--name --route-name -n

ルーティング規則の名前。

--profile-name

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

--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600
--updated

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

既定値: 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 を使います。