Virtual Network Peerings - Get

指定した仮想ネットワーク ピアリングを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}?api-version=2023-09-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプションの資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

virtualNetworkName
path True

string

仮想ネットワークの名前。

virtualNetworkPeeringName
path True

string

仮想ネットワーク ピアリングの名前。

api-version
query True

string

クライアント API バージョン。

応答

名前 説明
200 OK

VirtualNetworkPeering

要求が成功しました。 この操作は、結果の VirtualNetworkPeering リソースを返します。

Other Status Codes

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

Get peering
Get peering with remote virtual network encryption

Get peering

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer?api-version=2023-09-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer",
  "name": "peer",
  "properties": {
    "allowVirtualNetworkAccess": true,
    "allowForwardedTraffic": true,
    "allowGatewayTransit": false,
    "useRemoteGateways": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "12.0.0.0/8"
      ]
    },
    "remoteVirtualNetworkAddressSpace": {
      "addressPrefixes": [
        "12.0.0.0/8"
      ]
    },
    "remoteBgpCommunities": {
      "virtualNetworkCommunity": "12076:20002",
      "regionalCommunity": "12076:50004"
    },
    "peeringState": "Initiated",
    "peeringSyncLevel": "FullyInSync",
    "provisioningState": "Succeeded"
  }
}

Get peering with remote virtual network encryption

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer?api-version=2023-09-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer",
  "name": "peer",
  "properties": {
    "allowVirtualNetworkAccess": true,
    "allowForwardedTraffic": true,
    "allowGatewayTransit": false,
    "useRemoteGateways": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "remoteAddressSpace": {
      "addressPrefixes": [
        "12.0.0.0/8"
      ]
    },
    "remoteBgpCommunities": {
      "virtualNetworkCommunity": "12076:20002",
      "regionalCommunity": "12076:50004"
    },
    "remoteVirtualNetworkEncryption": {
      "enabled": true,
      "enforcement": "AllowUnencrypted"
    },
    "peeringState": "Initiated",
    "provisioningState": "Succeeded"
  }
}

定義

名前 説明
AddressSpace

AddressSpace には、仮想ネットワークのサブネットで使用できる IP アドレス範囲の配列が含まれています。

CloudError

サービスからのエラー応答。

CloudErrorBody

サービスからのエラー応答。

ProvisioningState

現在のプロビジョニング状態。

SubResource

別のサブリソースへの参照。

VirtualNetworkBgpCommunities

この VNET 内のプレフィックスに対応する各ルートを使用して ExpressRoute 経由で送信される Bgp コミュニティ。

VirtualNetworkEncryption

仮想ネットワークで暗号化が有効になっているかどうか、および暗号化されていない VM が暗号化された VNet で許可されているかどうかを示します。

VirtualNetworkEncryptionEnforcement

暗号化された VNet で暗号化をサポートしていない VM が許可されている場合

VirtualNetworkPeering

仮想ネットワーク リソース内のピアリング。

VirtualNetworkPeeringLevel

仮想ネットワーク ピアリングのピアリング同期の状態。

VirtualNetworkPeeringState

仮想ネットワーク ピアリングの状態。

AddressSpace

AddressSpace には、仮想ネットワークのサブネットで使用できる IP アドレス範囲の配列が含まれています。

名前 説明
addressPrefixes

string[]

CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。

CloudError

サービスからのエラー応答。

名前 説明
error

CloudErrorBody

クラウド エラー本文。

CloudErrorBody

サービスからのエラー応答。

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

CloudErrorBody[]

エラーに関する追加の詳細の一覧。

message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

target

string

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

ProvisioningState

現在のプロビジョニング状態。

名前 説明
Deleting

string

Failed

string

Succeeded

string

Updating

string

SubResource

別のサブリソースへの参照。

名前 説明
id

string

リソースの ID

VirtualNetworkBgpCommunities

この VNET 内のプレフィックスに対応する各ルートを使用して ExpressRoute 経由で送信される Bgp コミュニティ。

名前 説明
regionalCommunity

string

仮想ネットワークのリージョンに関連付けられている BGP コミュニティ。

virtualNetworkCommunity

string

仮想ネットワークに関連付けられている BGP コミュニティ。

VirtualNetworkEncryption

仮想ネットワークで暗号化が有効になっているかどうか、および暗号化されていない VM が暗号化された VNet で許可されているかどうかを示します。

名前 説明
enabled

boolean

仮想ネットワークで暗号化が有効になっているかどうかを示します。

enforcement

VirtualNetworkEncryptionEnforcement

暗号化された VNet で暗号化をサポートしていない VM が許可されている場合

VirtualNetworkEncryptionEnforcement

暗号化された VNet で暗号化をサポートしていない VM が許可されている場合

名前 説明
AllowUnencrypted

string

DropUnencrypted

string

VirtualNetworkPeering

仮想ネットワーク リソース内のピアリング。

名前 説明
etag

string

リソースが更新されるたびに変更される一意の読み取り専用文字列。

id

string

リソースの ID

name

string

リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。

properties.allowForwardedTraffic

boolean

ローカル仮想ネットワーク内の VM からの転送されたトラフィックが、リモート仮想ネットワークで許可または禁止されるかどうか。

properties.allowGatewayTransit

boolean

リモート仮想ネットワークでゲートウェイ リンクを使用して、この仮想ネットワークにリンクできる場合。

properties.allowVirtualNetworkAccess

boolean

ローカル仮想ネットワーク空間内の VM がリモート仮想ネットワーク空間内の VM にアクセスできるかどうか。

properties.doNotVerifyRemoteGateways

boolean

リモート ゲートウェイのプロビジョニング状態を確認する必要がある場合。

properties.peeringState

VirtualNetworkPeeringState

仮想ネットワーク ピアリングの状態。

properties.peeringSyncLevel

VirtualNetworkPeeringLevel

仮想ネットワーク ピアリングのピアリング同期の状態。

properties.provisioningState

ProvisioningState

仮想ネットワーク ピアリング リソースのプロビジョニング状態。

properties.remoteAddressSpace

AddressSpace

リモート仮想ネットワークとピアリングされたアドレス空間への参照。

properties.remoteBgpCommunities

VirtualNetworkBgpCommunities

リモート仮想ネットワークの Bgp コミュニティへの参照。

properties.remoteVirtualNetwork

SubResource

リモート仮想ネットワークへの参照。 リモート仮想ネットワークは、同じリージョンでも異なるリージョン (プレビュー) でもかまいません。 プレビューの登録と詳細については、こちらを参照してください (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)。

properties.remoteVirtualNetworkAddressSpace

AddressSpace

リモート仮想ネットワークの現在のアドレス空間への参照。

properties.remoteVirtualNetworkEncryption

VirtualNetworkEncryption

リモート仮想ネットワークの暗号化への参照

properties.resourceGuid

string

Virtual Network ピアリング リソースの resourceGuid プロパティ。

properties.useRemoteGateways

boolean

この仮想ネットワークでリモート ゲートウェイを使用できる場合。 フラグが true に設定されていて、リモート ピアリングの allowGatewayTransit も true の場合、仮想ネットワークは転送にリモート仮想ネットワークのゲートウェイを使用します。 このフラグを true に設定できるのは、ピアリングが 1 つだけです。 仮想ネットワークにゲートウェイが既に存在する場合は、このフラグを設定できません。

type

string

リソースの種類。

VirtualNetworkPeeringLevel

仮想ネットワーク ピアリングのピアリング同期の状態。

名前 説明
FullyInSync

string

LocalAndRemoteNotInSync

string

LocalNotInSync

string

RemoteNotInSync

string

VirtualNetworkPeeringState

仮想ネットワーク ピアリングの状態。

名前 説明
Connected

string

Disconnected

string

Initiated

string