az network private-endpoint

プライベート エンドポイントを管理します。

コマンド

名前	説明	型	Status
az network private-endpoint asg	プライベート エンドポイント アプリケーション セキュリティ グループを管理します。	コア	GA
az network private-endpoint asg add	プライベート エンドポイント アプリケーション セキュリティ グループを追加します。	コア	GA
az network private-endpoint asg list	プライベート エンドポイント内のアプリケーション セキュリティ グループを一覧表示します。	コア	GA
az network private-endpoint asg remove	プライベート エンドポイント アプリケーション セキュリティ グループを削除します。	コア	GA
az network private-endpoint asg wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network private-endpoint create	プライベート エンドポイントを作成する。	コア	GA
az network private-endpoint delete	プライベート エンドポイントを削除します。	コア	GA
az network private-endpoint dns-zone-group	プライベート エンドポイント DNS ゾーン グループを管理します。	コア	GA
az network private-endpoint dns-zone-group add	プライベート エンドポイント DNS ゾーンを DNS ゾーン グループに追加します。	コア	GA
az network private-endpoint dns-zone-group create	プライベート エンドポイント DNS ゾーン グループを作成します。	コア	GA
az network private-endpoint dns-zone-group delete	プライベート エンドポイント DNS ゾーン グループを削除します。	コア	GA
az network private-endpoint dns-zone-group list	すべてのプライベート エンドポイント DNS ゾーン グループを一覧表示します。	コア	GA
az network private-endpoint dns-zone-group remove	プライベート エンドポイント DNS ゾーンを DNS ゾーン グループに削除します。	コア	GA
az network private-endpoint dns-zone-group show	プライベート エンドポイントの DNS ゾーン グループを表示します。	コア	GA
az network private-endpoint dns-zone-group wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network private-endpoint ip-config	プライベート エンドポイントの IP 構成を管理します。	コア	GA
az network private-endpoint ip-config add	プライベート エンドポイント IP 構成を追加します。	コア	GA
az network private-endpoint ip-config list	プライベート エンドポイント内の IP 構成を一覧表示します。	コア	GA
az network private-endpoint ip-config remove	プライベート エンドポイントの IP 構成を削除します。	コア	GA
az network private-endpoint ip-config wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az network private-endpoint list	プライベート エンドポイントを一覧表示します。	コア	GA
az network private-endpoint list-types	このリージョンのこのサブスクリプションのプライベート エンドポイントにリンクできるすべてのリソースの種類を返します。	コア	GA
az network private-endpoint show	プライベート エンドポイントの詳細を取得します。	コア	GA
az network private-endpoint update	プライベート エンドポイントを更新します。	コア	GA
az network private-endpoint wait	条件が満たされるまで CLI を待機状態にします。	コア	GA

az network private-endpoint create

プライベート エンドポイントを作成する。

az network private-endpoint create --connection-name
                                   --name
                                   --private-connection-resource-id
                                   --resource-group
                                   --subnet
                                   [--asg]
                                   [--edge-zone]
                                   [--group-id]
                                   [--ip-config]
                                   [--location]
                                   [--manual-request {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--nic-name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--request-message]
                                   [--tags]
                                   [--vnet-name]

例

プライベート エンドポイントを作成する。

az network private-endpoint create -g MyResourceGroup -n MyPE --vnet-name MyVnetName --subnet MySubnet --private-connection-resource-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/privateLinkServices/MyPLS" --connection-name tttt -l centralus

ASG を使用してプライベート エンドポイントを作成します。

az network private-endpoint create -n MyPE -g MyResourceGroup --vnet-name MyVnetName --subnet MySubnet --connection-name MyConnectionName --group-id MyGroupId --private-connection-resource-id MyResourceId --asg id=MyAsgId --asg id=MyAsgId

ip-configs を使用してプライベート エンドポイントを作成します。

az network private-endpoint create -n MyPE -g MyResourceGroup --vnet-name MyVnetName --subnet MySubnet --connection-name MyConnectionName --group-id MyGroupId --private-connection-resource-id MyResourceId --ip-configs [{name:Myipconfig1,group-id:MyGroupId ,member-name:MyMemberName,private-ip-address:10.0.0.4},{name:Myipconfig2,private-ip-address:10.0.0.6}]

必須のパラメーター

--connection-name

プライベート リンク サービス接続の名前。

--name -n

プライベート エンドポイントの名前。

--private-connection-resource-id

接続先のプライベート エンドポイントのリソース ID。

--resource-group -g

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

--subnet

既存のサブネットの名前または ID。 名前を指定した場合は、--vnet-name も指定します。 他のリソース グループまたはサブスクリプションで既存のサブネットを使用する場合は、サブネットの名前ではなく ID を指定し、--vnet-name を指定しないでください。

省略可能のパラメーター

--asg --asgs

プライベート エンドポイント アプリケーション セキュリティ グループ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。 単数形フラグ: --asg.

--edge-zone

エッジ ゾーンの名前。

--group-id --group-ids

このプライベート エンドポイントが接続する必要があるリモート リソースから取得したグループの ID。 "az network private-link-resource list" を使用して、サポートされているグループ ID を取得できます。 これは、PrivateLinkService.、サポートの短縮構文、json ファイル、yaml-file を除いて指定する必要があります。 詳細を表示するには、"??" を試してください。

--ip-config --ip-configs

プライベート エンドポイントの IP 構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。 単数形フラグ: --ip-config.

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--manual-request

手動要求を使用して接続を確立します。 プライベート リンク サービスのサブスクリプションにアクセスできない場合は、"true" として構成します。

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

--nic-name

プライベート エンドポイントに接続されているネットワーク インターフェイスのカスタム名。

--no-wait

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

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

--request-message

この接続要求を使用してリモート リソースの所有者に渡されたメッセージ。 140 文字に制限されます。

--tags

スペース区切りのタグ: key[=value] [key[=value]...]既存のタグをクリアするには、"" を使用します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--vnet-name

サブネットに関連付けられている仮想ネットワーク (VNet) (サブネット 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 network private-endpoint delete

プライベート エンドポイントを削除します。

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

例

プライベート エンドポイントを削除します。

az network private-endpoint delete --name MyPrivateEndpoint --resource-group MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

プライベート エンドポイントの名前。

--no-wait

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

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

--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 network private-endpoint list

プライベート エンドポイントを一覧表示します。

az network private-endpoint list [--resource-group]

例

プライベート エンドポイントを一覧表示します。

az network private-endpoint list -g MyResourceGroup

省略可能のパラメーター

--resource-group -g

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

グローバル パラメーター

--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 network private-endpoint list-types

このリージョンのこのサブスクリプションのプライベート エンドポイントにリンクできるすべてのリソースの種類を返します。

az network private-endpoint list-types [--location]
                                       [--resource-group]

例

すべてのリソースの種類を一覧表示する

az network private-endpoint list-types -l centralus

省略可能のパラメーター

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。 指定しない場合は、リソース グループの場所が使用されます。

--resource-group -g

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

グローバル パラメーター

--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 network private-endpoint show

プライベート エンドポイントの詳細を取得します。

az network private-endpoint show [--expand]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

例

プライベート エンドポイントの詳細を取得する

az network private-endpoint show --name MyPrivateEndpoint --resource-group MyResourceGroup

省略可能のパラメーター

--expand

参照先のリソースを展開します。

--ids

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

--name -n

プライベート エンドポイントの名前。

--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 network private-endpoint update

プライベート エンドポイントを更新します。

az network private-endpoint update [--add]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--remove]
                                   [--request-message]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]
                                   [--tags]

例

プライベート エンドポイントを更新します。

az network private-endpoint update -g MyResourceGroup -n MyPE --request-message "test" --tags mytag=hello

プライベート エンドポイントを更新します。

az network private-endpoint update --name MyPE --resource-group MyResourceGroup --set useRemoteGateways=true

省略可能のパラメーター

--add

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

--force-string

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

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

--ids

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

--name -n

プライベート エンドポイントの名前。

--no-wait

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

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

--remove

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

--request-message

この接続要求を使用してリモート リソースの所有者に渡されたメッセージ。 140 文字に制限されます。

--resource-group -g

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

--set

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

--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value]...]既存のタグをクリアするには、"" を使用します。 短縮構文、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 network private-endpoint wait

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

az network private-endpoint wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--expand]
                                 [--ids]
                                 [--interval]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

省略可能のパラメーター

--created

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

既定値: False

--custom

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

--deleted

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

既定値: False

--exists

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

既定値: False

--expand

参照先のリソースを展開します。

--ids

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

--interval

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

既定値: 30

--name -n

プライベート エンドポイントの名前。

--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 を使います。