Microsoft.Network vpnSites 2023-06-01
- [アーティクル]
-
-
Bicep リソース定義
vpnSites リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Network/vpnSites リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Network/vpnSites@2023-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
addressSpace: {
addressPrefixes: [
'string'
]
}
bgpProperties: {
asn: int
bgpPeeringAddress: 'string'
bgpPeeringAddresses: [
{
customBgpIpAddresses: [
'string'
]
ipconfigurationId: 'string'
}
]
peerWeight: int
}
deviceProperties: {
deviceModel: 'string'
deviceVendor: 'string'
linkSpeedInMbps: int
}
ipAddress: 'string'
isSecuritySite: bool
o365Policy: {
breakOutCategories: {
allow: bool
default: bool
optimize: bool
}
}
siteKey: 'string'
virtualWan: {
id: 'string'
}
vpnSiteLinks: [
{
id: 'string'
name: 'string'
properties: {
bgpProperties: {
asn: int
bgpPeeringAddress: 'string'
}
fqdn: 'string'
ipAddress: 'string'
linkProperties: {
linkProviderName: 'string'
linkSpeedInMbps: int
}
}
}
]
}
}
プロパティ値
vpnSites
| 名前 |
説明 |
値 |
| name |
リソース名 |
string (必須)
文字数制限: 1 から 80
有効な文字:
英数字、アンダースコア、ピリオド、およびハイフン。
英数字で開始します。 英数字またはアンダースコアで終了します。 |
| location |
リソースの場所。 |
string |
| tags |
リソース タグ。 |
タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| properties |
VPN サイトのプロパティ。 |
VpnSiteProperties |
VpnSiteProperties
| 名前 |
説明 |
値 |
| addressSpace |
IP アドレス範囲の配列を含む AddressSpace。 |
AddressSpace |
| bgpProperties |
bgp プロパティのセット。 |
BgpSettings |
| deviceProperties |
デバイスのプロパティ。 |
DeviceProperties |
| ipAddress |
vpn-site の IP アドレス。 |
string |
| isSecuritySite |
IsSecuritySite フラグ。 |
[bool] |
| o365Policy |
Office365 ポリシー。 |
O365PolicyProperties |
| siteKey |
接続に使用できる vpn-site のキー。 |
string |
| virtualWan |
vpnSite が属する VirtualWAN。 |
サブリソース |
| vpnSiteLinks |
すべての VPN サイト リンクの一覧。 |
VpnSiteLink[] |
AddressSpace
| 名前 |
説明 |
値 |
| addressPrefixes |
CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 |
string[] |
BgpSettings
| 名前 |
説明 |
値 |
| Asn |
BGP スピーカーの ASN。 |
INT
制約:
最小値 = 0
最大値 = 4294967295
|
| bgpPeeringAddress |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
string |
| bgpPeeringAddresses |
仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
この BGP スピーカーから学習したルートに追加された重み。 |
INT |
IPConfigurationBgpPeeringAddress
| 名前 |
説明 |
値 |
| customBgpIpAddresses |
IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 |
string[] |
| ipconfigurationId |
ゲートウェイに属する IP 構成の ID。 |
string |
DeviceProperties
| 名前 |
説明 |
値 |
| deviceModel |
デバイスのモデル。 |
string |
| deviceVendor |
デバイスベンダーの名前。 |
string |
| linkSpeedInMbps |
リンク速度。 |
INT |
O365PolicyProperties
O365BreakOutCategoryPolicies
| 名前 |
説明 |
値 |
| allow |
許可カテゴリを制御するフラグ。 |
[bool] |
| default |
既定のカテゴリを制御するフラグ。 |
[bool] |
| optimize |
最適化カテゴリを制御するためのフラグ。 |
[bool] |
サブリソース
| 名前 |
説明 |
値 |
| id |
リソースの ID |
string |
VpnSiteLink
| 名前 |
説明 |
値 |
| id |
リソースの ID |
string |
| name |
リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
string |
| properties |
VPN サイト リンクのプロパティ。 |
VpnSiteLinkProperties |
VpnSiteLinkProperties
VpnLinkBgpSettings
| 名前 |
説明 |
値 |
| Asn |
BGP スピーカーの ASN。 |
INT |
| bgpPeeringAddress |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
string |
VpnLinkProviderProperties
| 名前 |
説明 |
値 |
| linkProviderName |
リンク プロバイダーの名前。 |
string |
| linkSpeedIn Mbps |
リンク速度。 |
INT |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template |
説明 |
Virtual WAN リソースを作成します
 |
このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。 |
ARM テンプレート リソース定義
vpnSites リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Network/vpnSites リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2023-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"addressSpace": {
"addressPrefixes": [ "string" ]
},
"bgpProperties": {
"asn": "int",
"bgpPeeringAddress": "string",
"bgpPeeringAddresses": [
{
"customBgpIpAddresses": [ "string" ],
"ipconfigurationId": "string"
}
],
"peerWeight": "int"
},
"deviceProperties": {
"deviceModel": "string",
"deviceVendor": "string",
"linkSpeedInMbps": "int"
},
"ipAddress": "string",
"isSecuritySite": "bool",
"o365Policy": {
"breakOutCategories": {
"allow": "bool",
"default": "bool",
"optimize": "bool"
}
},
"siteKey": "string",
"virtualWan": {
"id": "string"
},
"vpnSiteLinks": [
{
"id": "string",
"name": "string",
"properties": {
"bgpProperties": {
"asn": "int",
"bgpPeeringAddress": "string"
},
"fqdn": "string",
"ipAddress": "string",
"linkProperties": {
"linkProviderName": "string",
"linkSpeedInMbps": "int"
}
}
}
]
}
}
プロパティ値
vpnSites
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
'Microsoft.Network/vpnSites' |
| apiVersion |
リソース API のバージョン |
'2023-06-01' |
| name |
リソース名 |
string (必須)
文字制限: 1 から 80
有効な文字:
英数字、アンダースコア、ピリオド、およびハイフン。
英数字で開始します。 英数字またはアンダースコアで終了します。 |
| location |
リソースの場所。 |
string |
| tags |
リソース タグ。 |
タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| properties |
VPN サイトのプロパティ。 |
VpnSiteProperties |
VpnSiteProperties
| 名前 |
説明 |
値 |
| addressSpace |
IP アドレス範囲の配列を含む AddressSpace。 |
AddressSpace |
| bgpProperties |
bgp プロパティのセット。 |
BgpSettings |
| deviceProperties |
デバイスのプロパティ。 |
DeviceProperties |
| ipAddress |
vpn-site の IP アドレス。 |
string |
| isSecuritySite |
IsSecuritySite フラグ。 |
[bool] |
| o365Policy |
Office365 ポリシー。 |
O365PolicyProperties |
| siteKey |
接続に使用できる vpn-site のキー。 |
string |
| virtualWan |
vpnSite が属する VirtualWAN。 |
サブリソース |
| vpnSiteLinks |
すべての VPN サイト リンクの一覧。 |
VpnSiteLink[] |
AddressSpace
| 名前 |
説明 |
値 |
| addressPrefixes |
CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 |
string[] |
BgpSettings
| 名前 |
説明 |
値 |
| Asn |
BGP スピーカーの ASN。 |
INT
制約:
最小値 = 0
最大値 = 4294967295
|
| bgpPeeringAddress |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
string |
| bgpPeeringAddresses |
仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
この BGP スピーカーから学習したルートに追加された重み。 |
INT |
IPConfigurationBgpPeeringAddress
| 名前 |
説明 |
値 |
| customBgpIpAddresses |
IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 |
string[] |
| ipconfigurationId |
ゲートウェイに属する IP 構成の ID。 |
string |
DeviceProperties
| 名前 |
説明 |
値 |
| deviceModel |
デバイスのモデル。 |
string |
| deviceVendor |
デバイスベンダーの名前。 |
string |
| linkSpeedInMbps |
リンク速度。 |
INT |
O365PolicyProperties
O365BreakOutCategoryPolicies
| 名前 |
説明 |
値 |
| allow |
許可カテゴリを制御するフラグ。 |
[bool] |
| default |
既定のカテゴリを制御するフラグ。 |
[bool] |
| optimize |
最適化カテゴリを制御するためのフラグ。 |
[bool] |
サブリソース
| 名前 |
説明 |
値 |
| id |
リソースの ID |
string |
VpnSiteLink
| 名前 |
説明 |
値 |
| id |
リソースの ID |
string |
| name |
リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
string |
| properties |
VPN サイト リンクのプロパティ。 |
VpnSiteLinkProperties |
VpnSiteLinkProperties
VpnLinkBgpSettings
| 名前 |
説明 |
値 |
| Asn |
BGP スピーカーの ASN。 |
INT |
| bgpPeeringAddress |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
string |
VpnLinkProviderProperties
| 名前 |
説明 |
値 |
| linkProviderName |
リンク プロバイダーの名前。 |
string |
| linkSpeedIn Mbps |
リンク速度。 |
INT |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template |
説明 |
Virtual WAN リソースを作成します
|
このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。 |
vpnSites リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Network/vpnSites リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2023-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
addressSpace = {
addressPrefixes = [
"string"
]
}
bgpProperties = {
asn = int
bgpPeeringAddress = "string"
bgpPeeringAddresses = [
{
customBgpIpAddresses = [
"string"
]
ipconfigurationId = "string"
}
]
peerWeight = int
}
deviceProperties = {
deviceModel = "string"
deviceVendor = "string"
linkSpeedInMbps = int
}
ipAddress = "string"
isSecuritySite = bool
o365Policy = {
breakOutCategories = {
allow = bool
default = bool
optimize = bool
}
}
siteKey = "string"
virtualWan = {
id = "string"
}
vpnSiteLinks = [
{
id = "string"
name = "string"
properties = {
bgpProperties = {
asn = int
bgpPeeringAddress = "string"
}
fqdn = "string"
ipAddress = "string"
linkProperties = {
linkProviderName = "string"
linkSpeedInMbps = int
}
}
}
]
}
})
}
プロパティ値
vpnSites
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
"Microsoft.Network/vpnSites@2023-06-01" |
| name |
リソース名 |
string (必須)
文字制限: 1 から 80
有効な文字:
英数字、アンダースコア、ピリオド、およびハイフン。
英数字で開始します。 英数字またはアンダースコアで終了します。 |
| location |
リソースの場所。 |
string |
| parent_id |
リソース グループにデプロイするには、そのリソース グループの ID を使用します。 |
string (必須) |
| tags |
リソース タグ。 |
タグの名前と値のディクショナリ。 |
| properties |
VPN サイトのプロパティ。 |
VpnSiteProperties |
VpnSiteProperties
| 名前 |
説明 |
値 |
| addressSpace |
IP アドレス範囲の配列を含む AddressSpace。 |
AddressSpace |
| bgpProperties |
bgp プロパティのセット。 |
BgpSettings |
| deviceProperties |
デバイスのプロパティ。 |
DeviceProperties |
| ipAddress |
vpn-site の IP アドレス。 |
string |
| isSecuritySite |
IsSecuritySite フラグ。 |
[bool] |
| o365Policy |
Office365 ポリシー。 |
O365PolicyProperties |
| siteKey |
接続に使用できる vpn-site のキー。 |
string |
| virtualWan |
vpnSite が属する VirtualWAN。 |
サブリソース |
| vpnSiteLinks |
すべての VPN サイト リンクの一覧。 |
VpnSiteLink[] |
AddressSpace
| 名前 |
説明 |
値 |
| addressPrefixes |
CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 |
string[] |
BgpSettings
| 名前 |
説明 |
値 |
| Asn |
BGP スピーカーの ASN。 |
INT
制約:
最小値 = 0
最大値 = 4294967295
|
| bgpPeeringAddress |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
string |
| bgpPeeringAddresses |
仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
この BGP スピーカーから学習したルートに追加された重み。 |
INT |
IPConfigurationBgpPeeringAddress
| 名前 |
説明 |
値 |
| customBgpIpAddresses |
IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 |
string[] |
| ipconfigurationId |
ゲートウェイに属する IP 構成の ID。 |
string |
DeviceProperties
| 名前 |
説明 |
値 |
| deviceModel |
デバイスのモデル。 |
string |
| deviceVendor |
デバイスベンダーの名前。 |
string |
| linkSpeedIn Mbps |
リンク速度。 |
INT |
O365PolicyProperties
O365BreakOutCategoryPolicies
| 名前 |
説明 |
値 |
| allow |
許可カテゴリを制御するフラグ。 |
[bool] |
| default |
既定のカテゴリを制御するフラグ。 |
[bool] |
| optimize |
最適化カテゴリを制御するフラグ。 |
[bool] |
サブリソース
| 名前 |
説明 |
値 |
| id |
リソースの ID |
string |
VpnSiteLink
| 名前 |
説明 |
値 |
| id |
リソースの ID |
string |
| name |
リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
string |
| properties |
VPN サイト リンクのプロパティ。 |
VpnSiteLinkProperties |
VpnSiteLinkProperties
VpnLinkBgpSettings
| 名前 |
説明 |
値 |
| Asn |
BGP スピーカーの ASN。 |
INT |
| bgpPeeringAddress |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
string |
VpnLinkProviderProperties
| 名前 |
説明 |
値 |
| linkProviderName |
リンク プロバイダーの名前。 |
string |
| linkSpeedIn Mbps |
リンク速度。 |
int |