次の方法で共有


Microsoft.Network 接続 2016-06-01

Bicep リソース定義

接続リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Network/connections リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Network/connections@2016-06-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authorizationKey: 'string'
    connectionStatus: 'string'
    connectionType: 'string'
    egressBytesTransferred: int
    enableBgp: bool
    ingressBytesTransferred: int
    localNetworkGateway2: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        gatewayIpAddress: 'string'
        localNetworkAddressSpace: {
          addressPrefixes: [
            'string'
          ]
        }
        provisioningState: 'string'
        resourceGuid: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    peer: {
      id: 'string'
    }
    provisioningState: 'string'
    resourceGuid: 'string'
    routingWeight: int
    sharedKey: 'string'
    virtualNetworkGateway1: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    virtualNetworkGateway2: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Network/connections (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
場所 リソースの場所
名前 リソース名 string (必須)
プロパティ VirtualNetworkGatewayConnection プロパティ VirtualNetworkGatewayConnectionPropertiesFormat の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

アドレス空間

名前 形容 価値
addressプレフィックス この仮想ネットワーク用に予約されているアドレス ブロックの一覧を CIDR 表記で取得または設定します。 文字列[]

Bgp設定

名前 形容 価値
ASN(エーエスエヌ) この BGP スピーカーの ASN を取得または設定します。 整数 (int)
bgpピアリングアドレス この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子を取得または設定します。
ピアウェイト この BGP スピーカーから学習したルートに追加される重みを取得または設定します。 整数 (int)

ローカルネットワークゲートウェイ

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
身分証明書 リソース ID
場所 リソースの場所
プロパティ LocalNetworkGateway プロパティ LocalNetworkGatewayPropertiesFormat (英語)
タグ リソース タグ リソースタグ

LocalNetworkGatewayPropertiesFormat (英語)

名前 形容 価値
bgp設定 ローカル ネットワーク ゲートウェイの BGP スピーカー設定 Bgp設定
ゲートウェイ IP アドレス ローカル ネットワーク ゲートウェイの IP アドレス。
localNetworkAddressSpace (ローカルネットワークアドレススペース) ローカル ネットワーク サイトのアドレス空間 アドレス空間
プロビジョニング状態 LocalNetworkGateway リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド LocalNetworkGateway リソースのリソース guid プロパティを取得または設定します。

リソースタグ

名前 形容 価値

リソースタグ

名前 形容 価値

リソースタグ

名前 形容 価値

サブリソース

名前 形容 価値
身分証明書 リソース ID

VirtualNetworkGateway(英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
身分証明書 リソース ID
場所 リソースの場所
プロパティ VirtualNetworkGateway プロパティ VirtualNetworkGatewayPropertiesFormat の
タグ リソース タグ リソースタグ

VirtualNetworkGatewayConnectionPropertiesFormat

名前 形容 価値
authorizationキー authorizationKey。
connectionStatus(接続ステータス) 仮想ネットワーク ゲートウェイの接続状態 「コネクテッド」
「つながる」
「接続されていません」
「不明」
接続タイプ ゲートウェイ接続の種類 IPsec/Dedicated/VpnClient/Vnet2Vnet 「エクスプレスルート」
「IPsec」
「Vnet2Vnet」
「VPNClient」
egressBytesTransfered(転送済み) この接続で転送されたエグレス バイト数 整数 (int)
enableBgpの EnableBgp フラグ ブール (bool)
ingressBytesTransferred(イングレスバイト転送) この接続で転送されたイングレス バイト 整数 (int)
localNetworkGateway2 の 一般的なリソース情報の共通クラス ローカルネットワークゲートウェイ
ピア ピアリング リソースへの参照。 SubResource の
プロビジョニング状態 VirtualNetworkGatewayConnection リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド VirtualNetworkGatewayConnection リソースのリソース guid プロパティを取得または設定します。
ルーティングウェイト ルーティングの重み。 整数 (int)
共有キー IPsec 共有キー。
virtualNetworkGateway1 一般的なリソース情報の共通クラス VirtualNetworkGateway の
virtualNetworkGateway2 (英語) 一般的なリソース情報の共通クラス VirtualNetworkGateway の

VirtualNetworkGatewayIPConfiguration (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ VirtualNetworkGatewayIPConfiguration のプロパティ VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名前 形容 価値
privateIPAllocationメソッド PrivateIP の割り当て方法を取得または設定します。 「ダイナミック」
「静的」
プロビジョニング状態 PublicIP リソースの更新/削除/失敗のプロビジョニング状態を取得します。
publicIPアドレス PublicIP リソースの参照を取得または設定します。 SubResource の
サブネット サブネット リソースの参照を取得または設定します。 SubResource の

VirtualNetworkGatewayPropertiesFormat

名前 形容 価値
アクティブアクティブ ActiveActive フラグ ブール (bool)
bgp設定 仮想ネットワーク ゲートウェイの BGP スピーカー設定 Bgp設定
enableBgpの EnableBgp フラグ ブール (bool)
ゲートウェイ・デフォルト・サイト 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースの参照を取得または設定します。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 SubResource の
ゲートウェイタイプ この仮想ネットワーク ゲートウェイの種類。 「エクスプレスルート」
「VPN」
ipConfigurationsの 仮想ネットワーク ゲートウェイの IpConfigurations。 VirtualNetworkGatewayIPConfiguration[]
プロビジョニング状態 VirtualNetworkGateway リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド VirtualNetworkGateway リソースのリソース guid プロパティを取得または設定します。
エスケーユー 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースの参照を取得または設定します。 VirtualNetworkGatewaySku
vpnClientConfiguration (vpnクライアント構成) P2S VpnClient 構成を表す VpnClientConfiguration リソースの参照を取得または設定します。 VpnClientConfiguration の
vpnタイプ この仮想ネットワーク ゲートウェイの種類。 「ポリシーベース」
「ルートベース」

VirtualNetworkGatewaySku

名前 形容 価値
能力 容量 整数 (int)
名前 ゲートウェイ SKU 名 -Basic/HighPerformance/Standard/UltraPerformance 「ベーシック」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
ゲートウェイ SKU レベル -Basic/HighPerformance/Standard/UltraPerformance 「ベーシック」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」

VpnClientConfiguration (英語)

名前 形容 価値
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースの参照を取得または設定します。 アドレス空間
vpnClientRevokedCertificates (英語) 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRoot証明書 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 VpnClientRoot証明書[]

VpnClientRevokedCertificate (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ 仮想ネットワーク ゲートウェイの失効した VPN クライアント証明書のプロパティ VpnClientRevokedCertificatePropertiesFormat の

VpnClientRevokedCertificatePropertiesFormat

名前 形容 価値
プロビジョニング状態 VPN クライアントが失効した証明書リソースの更新/削除/失敗のプロビジョニング状態を取得します
拇印 失効した Vpn クライアント証明書の拇印を取得または設定します。

VpnClientRoot証明書

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ アプリケーション ゲートウェイの SSL 証明書のプロパティ VpnClientRootCertificatePropertiesFormat の

VpnClientRootCertificatePropertiesFormat

名前 形容 価値
プロビジョニング状態 VPN クライアント ルート証明書リソースのプロビジョニング状態を取得します。更新中/削除中/失敗しました
publicCertData の 証明書のパブリック データを取得または設定します。

使用例

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
仮想ネットワーク ゲートウェイ接続 仮想ネットワーク ゲートウェイ接続用の AVM リソース モジュール

Azure クイック スタートのサンプル

Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル 形容
BGP VNET から VNET への接続 を作成する このテンプレートを使用すると、仮想ネットワーク ゲートウェイと BGP を使用して 2 つの VNET を接続できます。
BGP を使用してアクティブ/アクティブ VPN ゲートウェイを使用してサイト間 VPN を する このテンプレートを使用すると、BGP を使用してアクティブ/アクティブ構成の VPN ゲートウェイを持つ 2 つの VNet 間にサイト間 VPN をデプロイできます。 各 Azure VPN Gateway は、リモート ピアの FQDN を解決して、リモート VPN ゲートウェイのパブリック IP を決定します。 テンプレートは、可用性ゾーンを持つ Azure リージョンで想定どおりに実行されます。

ARM テンプレート リソース定義

接続リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Network/connections リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Network/connections",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "authorizationKey": "string",
    "connectionStatus": "string",
    "connectionType": "string",
    "egressBytesTransferred": "int",
    "enableBgp": "bool",
    "ingressBytesTransferred": "int",
    "localNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "gatewayIpAddress": "string",
        "localNetworkAddressSpace": {
          "addressPrefixes": [ "string" ]
        },
        "provisioningState": "string",
        "resourceGuid": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "peer": {
      "id": "string"
    },
    "provisioningState": "string",
    "resourceGuid": "string",
    "routingWeight": "int",
    "sharedKey": "string",
    "virtualNetworkGateway1": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "virtualNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Network/connections (英語)

名前 形容 価値
apiVersion (英語) API のバージョン '2016-06-01'
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
場所 リソースの場所
名前 リソース名 string (必須)
プロパティ VirtualNetworkGatewayConnection プロパティ VirtualNetworkGatewayConnectionPropertiesFormat の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.Network/connections'

アドレス空間

名前 形容 価値
addressプレフィックス この仮想ネットワーク用に予約されているアドレス ブロックの一覧を CIDR 表記で取得または設定します。 文字列[]

Bgp設定

名前 形容 価値
ASN(エーエスエヌ) この BGP スピーカーの ASN を取得または設定します。 整数 (int)
bgpピアリングアドレス この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子を取得または設定します。
ピアウェイト この BGP スピーカーから学習したルートに追加される重みを取得または設定します。 整数 (int)

ローカルネットワークゲートウェイ

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
身分証明書 リソース ID
場所 リソースの場所
プロパティ LocalNetworkGateway プロパティ LocalNetworkGatewayPropertiesFormat (英語)
タグ リソース タグ リソースタグ

LocalNetworkGatewayPropertiesFormat (英語)

名前 形容 価値
bgp設定 ローカル ネットワーク ゲートウェイの BGP スピーカー設定 Bgp設定
ゲートウェイ IP アドレス ローカル ネットワーク ゲートウェイの IP アドレス。
localNetworkAddressSpace (ローカルネットワークアドレススペース) ローカル ネットワーク サイトのアドレス空間 アドレス空間
プロビジョニング状態 LocalNetworkGateway リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド LocalNetworkGateway リソースのリソース guid プロパティを取得または設定します。

リソースタグ

名前 形容 価値

リソースタグ

名前 形容 価値

リソースタグ

名前 形容 価値

サブリソース

名前 形容 価値
身分証明書 リソース ID

VirtualNetworkGateway(英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
身分証明書 リソース ID
場所 リソースの場所
プロパティ VirtualNetworkGateway プロパティ VirtualNetworkGatewayPropertiesFormat の
タグ リソース タグ リソースタグ

VirtualNetworkGatewayConnectionPropertiesFormat

名前 形容 価値
authorizationキー authorizationKey。
connectionStatus(接続ステータス) 仮想ネットワーク ゲートウェイの接続状態 「コネクテッド」
「つながる」
「接続されていません」
「不明」
接続タイプ ゲートウェイ接続の種類 IPsec/Dedicated/VpnClient/Vnet2Vnet 「エクスプレスルート」
「IPsec」
「Vnet2Vnet」
「VPNClient」
egressBytesTransfered(転送済み) この接続で転送されたエグレス バイト数 整数 (int)
enableBgpの EnableBgp フラグ ブール (bool)
ingressBytesTransferred(イングレスバイト転送) この接続で転送されたイングレス バイト 整数 (int)
localNetworkGateway2 の 一般的なリソース情報の共通クラス ローカルネットワークゲートウェイ
ピア ピアリング リソースへの参照。 SubResource の
プロビジョニング状態 VirtualNetworkGatewayConnection リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド VirtualNetworkGatewayConnection リソースのリソース guid プロパティを取得または設定します。
ルーティングウェイト ルーティングの重み。 整数 (int)
共有キー IPsec 共有キー。
virtualNetworkGateway1 一般的なリソース情報の共通クラス VirtualNetworkGateway の
virtualNetworkGateway2 (英語) 一般的なリソース情報の共通クラス VirtualNetworkGateway の

VirtualNetworkGatewayIPConfiguration (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ VirtualNetworkGatewayIPConfiguration のプロパティ VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名前 形容 価値
privateIPAllocationメソッド PrivateIP の割り当て方法を取得または設定します。 「ダイナミック」
「静的」
プロビジョニング状態 PublicIP リソースの更新/削除/失敗のプロビジョニング状態を取得します。
publicIPアドレス PublicIP リソースの参照を取得または設定します。 SubResource の
サブネット サブネット リソースの参照を取得または設定します。 SubResource の

VirtualNetworkGatewayPropertiesFormat

名前 形容 価値
アクティブアクティブ ActiveActive フラグ ブール (bool)
bgp設定 仮想ネットワーク ゲートウェイの BGP スピーカー設定 Bgp設定
enableBgpの EnableBgp フラグ ブール (bool)
ゲートウェイ・デフォルト・サイト 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースの参照を取得または設定します。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 SubResource の
ゲートウェイタイプ この仮想ネットワーク ゲートウェイの種類。 「エクスプレスルート」
「VPN」
ipConfigurationsの 仮想ネットワーク ゲートウェイの IpConfigurations。 VirtualNetworkGatewayIPConfiguration[]
プロビジョニング状態 VirtualNetworkGateway リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド VirtualNetworkGateway リソースのリソース guid プロパティを取得または設定します。
エスケーユー 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースの参照を取得または設定します。 VirtualNetworkGatewaySku
vpnClientConfiguration (vpnクライアント構成) P2S VpnClient 構成を表す VpnClientConfiguration リソースの参照を取得または設定します。 VpnClientConfiguration の
vpnタイプ この仮想ネットワーク ゲートウェイの種類。 「ポリシーベース」
「ルートベース」

VirtualNetworkGatewaySku

名前 形容 価値
能力 容量 整数 (int)
名前 ゲートウェイ SKU 名 -Basic/HighPerformance/Standard/UltraPerformance 「ベーシック」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
ゲートウェイ SKU レベル -Basic/HighPerformance/Standard/UltraPerformance 「ベーシック」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」

VpnClientConfiguration (英語)

名前 形容 価値
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースの参照を取得または設定します。 アドレス空間
vpnClientRevokedCertificates (英語) 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRoot証明書 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 VpnClientRoot証明書[]

VpnClientRevokedCertificate (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ 仮想ネットワーク ゲートウェイの失効した VPN クライアント証明書のプロパティ VpnClientRevokedCertificatePropertiesFormat の

VpnClientRevokedCertificatePropertiesFormat

名前 形容 価値
プロビジョニング状態 VPN クライアントが失効した証明書リソースの更新/削除/失敗のプロビジョニング状態を取得します
拇印 失効した Vpn クライアント証明書の拇印を取得または設定します。

VpnClientRoot証明書

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ アプリケーション ゲートウェイの SSL 証明書のプロパティ VpnClientRootCertificatePropertiesFormat の

VpnClientRootCertificatePropertiesFormat

名前 形容 価値
プロビジョニング状態 VPN クライアント ルート証明書リソースのプロビジョニング状態を取得します。更新中/削除中/失敗しました
publicCertData の 証明書のパブリック データを取得または設定します。

使用例

Azure クイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
BOSH CFクロスリージョン

Azure にデプロイする
このテンプレートは、Azure 上の 2 つのリージョンに BOSH と Cloud Foundry をデプロイするために必要なリソースを設定するのに役立ちます。
ExpressRoute 回線を VNET に接続する

Azure にデプロイする
このテンプレートでは、VNET、ExpresRoute ゲートウェイ、および AzurePrivatePeering が構成されたプロビジョニング済みで有効な ExpressRoute 回線への接続が作成されます。
BGP VNET から VNET への接続 を作成する

Azure にデプロイする
このテンプレートを使用すると、仮想ネットワーク ゲートウェイと BGP を使用して 2 つの VNET を接続できます。
サイト間 VPN 接続 を作成する

Azure にデプロイする
このテンプレートを使用すると、仮想ネットワーク ゲートウェイを使用してサイト間 VPN 接続を作成できます。
VM を使用してサイト間 VPN 接続を作成する

Azure にデプロイする
このテンプレートを使用すると、仮想ネットワーク ゲートウェイを使用してサイト間 VPN 接続を作成できます。
2 つのリージョン間で VNET 間接続を作成

Azure にデプロイする
このテンプレートを使用すると、Virtual Network ゲートウェイを使用して、異なるリージョンの 2 つの VNET を接続できます。
推移的な BGP 接続の を示す 3 つの vNet を作成する

Azure にデプロイする
このテンプレートでは、仮想ネットワーク ゲートウェイと BGP 対応接続を使用して接続された 3 つの vNet をデプロイします
HBase geo レプリケーション をデプロイする

Azure にデプロイする
このテンプレートを使用すると、VPN vnet 間接続を使用して、2 つの異なるリージョン間で HBase レプリケーション用の Azure 環境を構成できます。
既存の Azure VNET をマルチ VNET 構成 に拡張する

Azure にデプロイする
このテンプレートを使用すると、既存の単一の VNET 環境を、VNET 間ゲートウェイを使用して 2 つのデータセンター リージョンにまたがるマルチ VNET 環境に拡張できます。
BGP を使用してアクティブ/アクティブ VPN ゲートウェイを使用してサイト間 VPN を する

Azure
にデプロイする
このテンプレートを使用すると、BGP を使用してアクティブ/アクティブ構成の VPN ゲートウェイを持つ 2 つの VNet 間にサイト間 VPN をデプロイできます。 各 Azure VPN Gateway は、リモート ピアの FQDN を解決して、リモート VPN ゲートウェイのパブリック IP を決定します。 テンプレートは、可用性ゾーンを持つ Azure リージョンで想定どおりに実行されます。
VPN カスタム IPSec ポリシー の

Azure
にデプロイする
このカスタム IPSec ポリシーを使用すると、IKE パラメーターをより詳細に構成できます。 これにより、サイト間 VPN ポリシーを展開して、VPN Endpoit デバイス上の特定の設定をサポートできます。

Terraform (AzAPI プロバイダー) リソース定義

接続リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Network/connections リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/connections@2016-06-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      authorizationKey = "string"
      connectionStatus = "string"
      connectionType = "string"
      egressBytesTransferred = int
      enableBgp = bool
      ingressBytesTransferred = int
      localNetworkGateway2 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          gatewayIpAddress = "string"
          localNetworkAddressSpace = {
            addressPrefixes = [
              "string"
            ]
          }
          provisioningState = "string"
          resourceGuid = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      peer = {
        id = "string"
      }
      provisioningState = "string"
      resourceGuid = "string"
      routingWeight = int
      sharedKey = "string"
      virtualNetworkGateway1 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      virtualNetworkGateway2 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
    }
  }
}

プロパティ値

Microsoft.Network/connections (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
場所 リソースの場所
名前 リソース名 string (必須)
プロパティ VirtualNetworkGatewayConnection プロパティ VirtualNetworkGatewayConnectionPropertiesFormat の
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.Network/connections@2016-06-01" (英語)

アドレス空間

名前 形容 価値
addressプレフィックス この仮想ネットワーク用に予約されているアドレス ブロックの一覧を CIDR 表記で取得または設定します。 文字列[]

Bgp設定

名前 形容 価値
ASN(エーエスエヌ) この BGP スピーカーの ASN を取得または設定します。 整数 (int)
bgpピアリングアドレス この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子を取得または設定します。
ピアウェイト この BGP スピーカーから学習したルートに追加される重みを取得または設定します。 整数 (int)

ローカルネットワークゲートウェイ

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
身分証明書 リソース ID
場所 リソースの場所
プロパティ LocalNetworkGateway プロパティ LocalNetworkGatewayPropertiesFormat (英語)
タグ リソース タグ リソースタグ

LocalNetworkGatewayPropertiesFormat (英語)

名前 形容 価値
bgp設定 ローカル ネットワーク ゲートウェイの BGP スピーカー設定 Bgp設定
ゲートウェイ IP アドレス ローカル ネットワーク ゲートウェイの IP アドレス。
localNetworkAddressSpace (ローカルネットワークアドレススペース) ローカル ネットワーク サイトのアドレス空間 アドレス空間
プロビジョニング状態 LocalNetworkGateway リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド LocalNetworkGateway リソースのリソース guid プロパティを取得または設定します。

リソースタグ

名前 形容 価値

リソースタグ

名前 形容 価値

リソースタグ

名前 形容 価値

サブリソース

名前 形容 価値
身分証明書 リソース ID

VirtualNetworkGateway(英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列を取得します。
身分証明書 リソース ID
場所 リソースの場所
プロパティ VirtualNetworkGateway プロパティ VirtualNetworkGatewayPropertiesFormat の
タグ リソース タグ リソースタグ

VirtualNetworkGatewayConnectionPropertiesFormat

名前 形容 価値
authorizationキー authorizationKey。
connectionStatus(接続ステータス) 仮想ネットワーク ゲートウェイの接続状態 「コネクテッド」
「つながる」
「接続されていません」
「不明」
接続タイプ ゲートウェイ接続の種類 IPsec/Dedicated/VpnClient/Vnet2Vnet 「エクスプレスルート」
「IPsec」
「Vnet2Vnet」
「VPNClient」
egressBytesTransfered(転送済み) この接続で転送されたエグレス バイト数 整数 (int)
enableBgpの EnableBgp フラグ ブール (bool)
ingressBytesTransferred(イングレスバイト転送) この接続で転送されたイングレス バイト 整数 (int)
localNetworkGateway2 の 一般的なリソース情報の共通クラス ローカルネットワークゲートウェイ
ピア ピアリング リソースへの参照。 SubResource の
プロビジョニング状態 VirtualNetworkGatewayConnection リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド VirtualNetworkGatewayConnection リソースのリソース guid プロパティを取得または設定します。
ルーティングウェイト ルーティングの重み。 整数 (int)
共有キー IPsec 共有キー。
virtualNetworkGateway1 一般的なリソース情報の共通クラス VirtualNetworkGateway の
virtualNetworkGateway2 (英語) 一般的なリソース情報の共通クラス VirtualNetworkGateway の

VirtualNetworkGatewayIPConfiguration (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ VirtualNetworkGatewayIPConfiguration のプロパティ VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名前 形容 価値
privateIPAllocationメソッド PrivateIP の割り当て方法を取得または設定します。 「ダイナミック」
「静的」
プロビジョニング状態 PublicIP リソースの更新/削除/失敗のプロビジョニング状態を取得します。
publicIPアドレス PublicIP リソースの参照を取得または設定します。 SubResource の
サブネット サブネット リソースの参照を取得または設定します。 SubResource の

VirtualNetworkGatewayPropertiesFormat

名前 形容 価値
アクティブアクティブ ActiveActive フラグ ブール (bool)
bgp設定 仮想ネットワーク ゲートウェイの BGP スピーカー設定 Bgp設定
enableBgpの EnableBgp フラグ ブール (bool)
ゲートウェイ・デフォルト・サイト 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースの参照を取得または設定します。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 SubResource の
ゲートウェイタイプ この仮想ネットワーク ゲートウェイの種類。 「エクスプレスルート」
「VPN」
ipConfigurationsの 仮想ネットワーク ゲートウェイの IpConfigurations。 VirtualNetworkGatewayIPConfiguration[]
プロビジョニング状態 VirtualNetworkGateway リソースの更新/削除/失敗のプロビジョニング状態を取得します。
リソースギッド VirtualNetworkGateway リソースのリソース guid プロパティを取得または設定します。
エスケーユー 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースの参照を取得または設定します。 VirtualNetworkGatewaySku
vpnClientConfiguration (vpnクライアント構成) P2S VpnClient 構成を表す VpnClientConfiguration リソースの参照を取得または設定します。 VpnClientConfiguration の
vpnタイプ この仮想ネットワーク ゲートウェイの種類。 「ポリシーベース」
「ルートベース」

VirtualNetworkGatewaySku

名前 形容 価値
能力 容量 整数 (int)
名前 ゲートウェイ SKU 名 -Basic/HighPerformance/Standard/UltraPerformance 「ベーシック」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
ゲートウェイ SKU レベル -Basic/HighPerformance/Standard/UltraPerformance 「ベーシック」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」

VpnClientConfiguration (英語)

名前 形容 価値
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースの参照を取得または設定します。 アドレス空間
vpnClientRevokedCertificates (英語) 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRoot証明書 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 VpnClientRoot証明書[]

VpnClientRevokedCertificate (英語)

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ 仮想ネットワーク ゲートウェイの失効した VPN クライアント証明書のプロパティ VpnClientRevokedCertificatePropertiesFormat の

VpnClientRevokedCertificatePropertiesFormat

名前 形容 価値
プロビジョニング状態 VPN クライアントが失効した証明書リソースの更新/削除/失敗のプロビジョニング状態を取得します
拇印 失効した Vpn クライアント証明書の拇印を取得または設定します。

VpnClientRoot証明書

名前 形容 価値
ETAGの リソースが更新されるたびに変更される一意の読み取り専用文字列
身分証明書 リソース ID
名前 リソース グループ内で一意のリソースの名前を取得します。 この名前は、リソースへのアクセスに使用できます
プロパティ アプリケーション ゲートウェイの SSL 証明書のプロパティ VpnClientRootCertificatePropertiesFormat の

VpnClientRootCertificatePropertiesFormat

名前 形容 価値
プロビジョニング状態 VPN クライアント ルート証明書リソースのプロビジョニング状態を取得します。更新中/削除中/失敗しました
publicCertData の 証明書のパブリック データを取得または設定します。

使用例

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
仮想ネットワーク ゲートウェイ接続 仮想ネットワーク ゲートウェイ接続用の AVM リソース モジュール