az network private-link-service
プライベート リンク サービスを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az network private-link-service connection |
プライベート リンク サービス エンドポイント接続を管理します。 |
Core | GA |
| az network private-link-service connection delete |
プライベート リンク サービス エンドポイント接続を削除します。 |
Core | GA |
| az network private-link-service connection update |
プライベート リンク サービス エンドポイント接続を更新します。 |
Core | GA |
| az network private-link-service connection wait |
条件が満たされるまで CLI を待機状態にします。 |
Core | GA |
| az network private-link-service create |
Private Link サービスを作成します。 |
Core | GA |
| az network private-link-service delete |
プライベート リンク サービスを削除します。 |
Core | GA |
| az network private-link-service list |
プライベート リンク サービスを一覧表示します。 |
Core | GA |
| az network private-link-service list-auto-approved |
このリージョンのこのサブスクリプションで自動承認されたプライベート エンドポイントにリンクできるプライベート リンク サービス ID をすべて一覧表示します。 |
Core | GA |
| az network private-link-service show |
プライベート リンク サービスの詳細を取得します。 |
Core | GA |
| az network private-link-service update |
プライベート リンク サービスを更新します。 |
Core | GA |
| az network private-link-service wait |
条件が満たされるまで CLI を待機状態にします。 |
Core | GA |
az network private-link-service create
Private Link サービスを作成します。
az network private-link-service create --name
--resource-group
[--auto-approval]
[--destination-ip-address]
[--edge-zone]
[--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
[--fqdns]
[--ip-configurations]
[--lb-frontend-ip-configs]
[--lb-name]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--private-ip-address]
[--private-ip-address-version {IPv4, IPv6}]
[--private-ip-allocation-method {Dynamic, Static}]
[--subnet]
[--tags]
[--visibility]
[--vnet-name]
例
プライベート リンク サービスを作成する
az network private-link-service create -g MyResourceGroup -n MyPLSName --vnet-name MyVnetName --subnet MySubnet --lb-name MyLBName --lb-frontend-ip-configs LoadBalancerFrontEnd -l centralus
必須のパラメーター
プライベート リンク サービスの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
自動承認するサブスクリプション ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プライベート リンク サービスの宛先 IP アドレス。
エッジ ゾーンの名前。
プライベート リンク サービスのプロキシ プロトコルを有効にします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
FQDN のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プライベート リンク サービスの IP 構成の配列。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | IP Configuration Arguments |
リンク先のロード バランサー フロントエンド IP 構成の名前または ID のスペース区切りの一覧。 名前を使用する場合は、--lb-nameも指定します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
フロントエンド IP 構成を取得するロード バランサーの名前。 フロントエンド IP 構成 ID が指定されている場合は無視されます。
Location. 値のソース: az account list-locations
az configure --defaults location=<location>を使用して、既定の場所を構成できます。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
使用する静的プライベート IP アドレス。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | IP Configuration Arguments |
プライベート IP アドレスの IP バージョン。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | IP Configuration Arguments |
| 規定値: | IPv4 |
| 指定可能な値: | IPv4, IPv6 |
プライベート IP アドレスの割り当て方法。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | IP Configuration Arguments |
| 指定可能な値: | Dynamic, Static |
使用するサブネットの名前または ID。 名前が指定されている場合は、--vnet-nameも指定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | IP Configuration Arguments |
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プライベート リンク サービスが表示されるサブスクリプション ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
仮想ネットワーク (VNet) 名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | IP Configuration Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network private-link-service delete
プライベート リンク サービスを削除します。
az network private-link-service delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
例
プライベート リンク サービスを削除します。
az network private-link-service delete --name MyPrivateLinkService --resource-group MyResourceGroup
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プライベート リンク サービスの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network private-link-service list
プライベート リンク サービスを一覧表示します。
az network private-link-service list [--max-items]
[--next-token]
[--resource-group]
例
プライベート リンク サービスを一覧表示します。
az network private-link-service list --resource-group MyResourceGroup
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network private-link-service list-auto-approved
このリージョンのこのサブスクリプションで自動承認されたプライベート エンドポイントにリンクできるプライベート リンク サービス ID をすべて一覧表示します。
az network private-link-service list-auto-approved [--location]
[--max-items]
[--next-token]
[--resource-group]
例
自動承認を使用してプライベート エンドポイントにリンクできるプライベート リンク サービスをすべて一覧表示する
az network private-link-service list-auto-approved -l westus
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Location. 値のソース: az account list-locations
az configure --defaults location=<location>を使用して、既定の場所を構成できます。 指定しない場合は、リソース グループの場所が使用されます。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network private-link-service show
プライベート リンク サービスの詳細を取得します。
az network private-link-service show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]
例
プライベート リンク サービスの詳細を取得します。
az network private-link-service show --name MyPrivateLinkService --resource-group MyResourceGroup
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
参照先のリソースを展開します。 既定値は None です。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プライベート リンク サービスの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network private-link-service update
プライベート リンク サービスを更新します。
az network private-link-service update [--add]
[--auto-approval]
[--destination-ip-address]
[--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--fqdns]
[--ids]
[--lb-frontend-ip-configs]
[--lb-name]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
[--visibility]
例
プライベート リンク サービスを更新する
az network private-link-service update -g MyResourceGroup -n MyPLSName --visibility SubId1 SubId2 --auto-approval SubId1 SubId2
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
自動承認するサブスクリプション ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プライベート リンク サービスの宛先 IP アドレス。
プライベート リンク サービスのプロキシ プロトコルを有効にします。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
FQDN のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リンク先のロード バランサー フロントエンド IP 構成の名前または ID のスペース区切りの一覧。 名前を使用する場合は、--lb-nameも指定します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
フロントエンド IP 構成を取得するロード バランサーの名前。 フロントエンド IP 構成 ID が指定されている場合は無視されます。
プライベート リンク サービスの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プライベート リンク サービスが表示されるサブスクリプション ID のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network private-link-service wait
条件が満たされるまで CLI を待機状態にします。
az network private-link-service wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
参照先のリソースを展開します。 既定値は None です。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
プライベート リンク サービスの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |