次の方法で共有


Vpn Sites - Create Or Update

VpnSite リソースが存在しない場合は作成し、それ以外の場合は既存の VpnSite を更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}?api-version=2024-05-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

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

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

vpnSiteName
path True

string

作成または更新される VpnSite の名前。

api-version
query True

string

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

要求本文

名前 必須 説明
location True

string

リソースの場所。

id

string

リソース ID。

properties.addressSpace

AddressSpace

IP アドレス範囲の配列を含む AddressSpace。

properties.bgpProperties

BgpSettings

bgp プロパティのセット。

properties.deviceProperties

DeviceProperties

デバイスのプロパティ。

properties.ipAddress

string

VPN サイトの IP アドレス。

properties.isSecuritySite

boolean

IsSecuritySite フラグ。

properties.o365Policy

O365PolicyProperties

Office365 ポリシー。

properties.siteKey

string

接続に使用できる VPN サイトのキー。

properties.virtualWan

SubResource

vpnSite が属する VirtualWAN。

properties.vpnSiteLinks

VpnSiteLink[]

すべての VPN サイト リンクの一覧。

tags

object

リソース タグ。

応答

名前 説明
200 OK

VpnSite

要求が成功しました。 作成または更新された VpnSite の詳細を返します。

201 Created

VpnSite

要求が正常に受信されました。 作成または更新された VpnSite の詳細を返します。

Other Status Codes

CloudError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

VpnSiteCreate

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1?api-version=2024-05-01

{
  "tags": {
    "key1": "value1"
  },
  "location": "West US",
  "properties": {
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "properties": {
          "ipAddress": "50.50.50.56",
          "fqdn": "link1.vpnsite1.contoso.com",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ],
    "o365Policy": {
      "breakOutCategories": {
        "allow": true,
        "optimize": true,
        "default": false
      }
    }
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "vpnSite1",
  "type": "Microsoft.Network/vpnSites",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "deviceProperties": {
      "linkSpeedInMbps": 0
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
        "properties": {
          "provisioningState": "Succeeded",
          "ipAddress": "50.50.50.56",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ]
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "vpnSite1",
  "type": "Microsoft.Network/vpnSites",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "deviceProperties": {
      "linkSpeedInMbps": 0
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "ipAddress": "50.50.50.56",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ]
  }
}

定義

名前 説明
AddressSpace

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

BgpSettings

BGP 設定の詳細。

CloudError

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

CloudErrorBody

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

DeviceProperties

デバイスのプロパティの一覧。

IpamPoolPrefixAllocation

IpamPool プレフィックス割り当てリファレンス。

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress のプロパティ。

O365BreakOutCategoryPolicies

Office365 ブレークアウト カテゴリ。

O365PolicyProperties

Office365 ブレークアウト ポリシー。

ProvisioningState

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

SubResource

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

VpnLinkBgpSettings

リンクの BGP 設定の詳細。

VpnLinkProviderProperties

リンク プロバイダーのプロパティの一覧。

VpnSite

VpnSite リソース。

VpnSiteLink

VpnSiteLink リソース。

AddressSpace

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

名前 説明
addressPrefixes

string[]

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

ipamPoolPrefixAllocations

IpamPoolPrefixAllocation[]

IP アドレス プレフィックスを割り当てる IPAM プールの一覧。

BgpSettings

BGP 設定の詳細。

名前 説明
asn

integer (int64)

minimum: 0
maximum: 4294967295

BGP スピーカーの ASN。

bgpPeeringAddress

string

この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。

bgpPeeringAddresses

IPConfigurationBgpPeeringAddress[]

仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。

peerWeight

integer (int32)

この BGP スピーカーから学習したルートに追加された重み。

CloudError

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

名前 説明
error

CloudErrorBody

クラウド エラー本文。

CloudErrorBody

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

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。

details

CloudErrorBody[]

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

message

string

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

target

string

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

DeviceProperties

デバイスのプロパティの一覧。

名前 説明
deviceModel

string

デバイスのモデル。

deviceVendor

string

デバイスベンダーの名前。

linkSpeedInMbps

integer (int32)

リンク速度。

IpamPoolPrefixAllocation

IpamPool プレフィックス割り当てリファレンス。

名前 説明
allocatedAddressPrefixes

string[]

関連付けられたリソースの IpamPool に割り当てられた IP アドレス プレフィックスの一覧。

numberOfIpAddresses

string

割り当てる IP アドレスの数。

pool.id

string (arm-id)

関連付けられている Azure IpamPool リソースのリソース ID。

IPConfigurationBgpPeeringAddress

IPConfigurationBgpPeeringAddress のプロパティ。

名前 説明
customBgpIpAddresses

string[]

IP 構成に属するカスタム BGP ピアリング アドレスの一覧。

defaultBgpIpAddresses

string[]

IP 構成に属する既定の BGP ピアリング アドレスの一覧。

ipconfigurationId

string

ゲートウェイに属する IP 構成の ID。

tunnelIpAddresses

string[]

IP 構成に属するトンネル パブリック IP アドレスの一覧。

O365BreakOutCategoryPolicies

Office365 ブレークアウト カテゴリ。

名前 説明
allow

boolean

許可カテゴリを制御するフラグ。

default

boolean

既定のカテゴリを制御するフラグ。

optimize

boolean

最適化カテゴリを制御するフラグ。

O365PolicyProperties

Office365 ブレークアウト ポリシー。

名前 説明
breakOutCategories

O365BreakOutCategoryPolicies

Office365 ブレークアウト カテゴリ。

ProvisioningState

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

説明
Deleting
Failed
Succeeded
Updating

SubResource

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

名前 説明
id

string

リソース ID。

VpnLinkBgpSettings

リンクの BGP 設定の詳細。

名前 説明
asn

integer (int64)

BGP スピーカーの ASN。

bgpPeeringAddress

string

この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。

VpnLinkProviderProperties

リンク プロバイダーのプロパティの一覧。

名前 説明
linkProviderName

string

リンク プロバイダーの名前。

linkSpeedInMbps

integer (int32)

リンク速度。

VpnSite

VpnSite リソース。

名前 説明
etag

string

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

id

string

リソース ID。

location

string

リソースの場所。

name

string

リソース名。

properties.addressSpace

AddressSpace

IP アドレス範囲の配列を含む AddressSpace。

properties.bgpProperties

BgpSettings

bgp プロパティのセット。

properties.deviceProperties

DeviceProperties

デバイスのプロパティ。

properties.ipAddress

string

VPN サイトの IP アドレス。

properties.isSecuritySite

boolean

IsSecuritySite フラグ。

properties.o365Policy

O365PolicyProperties

Office365 ポリシー。

properties.provisioningState

ProvisioningState

VPN サイト リソースのプロビジョニング状態。

properties.siteKey

string

接続に使用できる VPN サイトのキー。

properties.virtualWan

SubResource

vpnSite が属する VirtualWAN。

properties.vpnSiteLinks

VpnSiteLink[]

すべての VPN サイト リンクの一覧。

tags

object

リソース タグ。

type

string

リソースの種類。

VpnSiteLink リソース。

名前 説明
etag

string

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

id

string

リソース ID。

name

string

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

properties.bgpProperties

VpnLinkBgpSettings

bgp プロパティのセット。

properties.fqdn

string

vpn-site-link の FQDN。

properties.ipAddress

string

vpn-site-link の IP アドレス。

properties.linkProperties

VpnLinkProviderProperties

リンク プロバイダーのプロパティ。

properties.provisioningState

ProvisioningState

VPN サイト リンク リソースのプロビジョニング状態。

type

string

リソースの種類。