Bicep リソース定義
vpnSites リソースの種類は、次をターゲットとする操作と共にデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Network/vpnSites リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Network/vpnSites@2024-07-01' = {
location: 'string'
name: 'string'
properties: {
addressSpace: {
addressPrefixes: [
'string'
]
ipamPoolPrefixAllocations: [
{
numberOfIpAddresses: 'string'
pool: {
id: '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
}
}
}
]
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
Microsoft.Network/vpnSites (英語)
名前 |
形容 |
価値 |
場所 |
リソースの場所。 |
糸 |
名前 |
リソース名 |
string (必須) |
プロパティ |
VPN サイトのプロパティ。 |
VpnSiteProperties の |
タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
アドレス空間
名前 |
形容 |
価値 |
addressプレフィックス |
CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 |
文字列[] |
ipamPoolPrefixAllocations(英語) |
IP アドレス プレフィックスを割り当てる IPAM プールの一覧。 |
IpamPoolプレフィックス割り当て[] |
Bgp設定
名前 |
形容 |
価値 |
ASN(エーエスエヌ) |
BGP スピーカーの ASN。 |
int
制約: 最小値 = 0 最大値 = 4294967295 |
bgpピアリングアドレス |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
糸 |
bgpPeeringアドレス |
仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 |
IPConfigurationBgpPeeringAddress[] |
ピアウェイト |
この BGP スピーカーから学習したルートに追加された重み。 |
整数 (int) |
デバイスプロパティ
名前 |
形容 |
価値 |
デバイスモデル |
デバイスのモデル。 |
糸 |
デバイスベンダー |
デバイスベンダーの名前。 |
糸 |
linkSpeedIn Mbps |
リンク速度。 |
整数 (int) |
IpamPoolPrefixAllocation
IpamPoolプレフィックス割り当てプール
名前 |
形容 |
価値 |
身分証明書 |
関連付けられている Azure IpamPool リソースのリソース ID。 |
糸 |
IPConfigurationBgpPeeringAddress (英語)
名前 |
形容 |
価値 |
customBgpIpアドレス |
IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 |
文字列[] |
ipconfigurationId (英語) |
ゲートウェイに属する IP 構成の ID。 |
糸 |
O365BreakOutCategoryポリシー
名前 |
形容 |
価値 |
許す |
許可カテゴリを制御するフラグ。 |
ブール (bool) |
デフォルト |
既定のカテゴリを制御するフラグ。 |
ブール (bool) |
最適化 |
最適化カテゴリを制御するフラグ。 |
ブール (bool) |
O365ポリシープロパティ
サブリソース
名前 |
形容 |
価値 |
身分証明書 |
リソース ID。 |
糸 |
VpnLinkBgp設定
名前 |
形容 |
価値 |
ASN(エーエスエヌ) |
BGP スピーカーの ASN。 |
整数 (int) |
bgpピアリングアドレス |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
糸 |
VpnLinkProviderプロパティ
名前 |
形容 |
価値 |
リンク・プロバイダ名 |
リンク プロバイダーの名前。 |
糸 |
linkSpeedIn Mbps |
リンク速度。 |
整数 (int) |
VpnSiteリンク
名前 |
形容 |
価値 |
身分証明書 |
リソース ID。 |
糸 |
名前 |
リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
糸 |
プロパティ |
VPN サイト リンクのプロパティ。 |
VpnSiteLinkProperties の |
VpnSiteLinkプロパティ
名前 |
形容 |
価値 |
bgpプロパティ |
bgp プロパティのセット。 |
VpnLinkBgpSettings の |
FQDNの |
vpn-site-link の FQDN。 |
糸 |
IPアドレス |
vpn-site-link の IP アドレス。 |
糸 |
リンクプロパティ |
リンク プロバイダーのプロパティ。 |
VpnLinkProviderProperties の |
VpnSiteプロパティ
名前 |
形容 |
価値 |
アドレス空間 |
IP アドレス範囲の配列を含む AddressSpace。 |
アドレス空間 |
bgpプロパティ |
bgp プロパティのセット。 |
Bgp設定 |
デバイスプロパティ |
デバイスのプロパティ。 |
DeviceProperties の |
IPアドレス |
VPN サイトの IP アドレス。 |
糸 |
isSecuritySite (英語) |
IsSecuritySite フラグ。 |
ブール (bool) |
o365ポリシー |
Office365 ポリシー。 |
O365ポリシープロパティ |
サイトキー |
接続に使用できる VPN サイトのキー。 |
糸 |
バーチャルワン |
vpnSite が属する VirtualWAN。 |
SubResource の |
vpnサイトリンク |
すべての VPN サイト リンクの一覧。 |
VpnSiteLink[] |
使用例
Azure 検証済みモジュール
次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。
モジュール |
形容 |
VPN サイトの |
VPN サイト用 AVM リソース モジュール |
Azure クイック スタートのサンプル
次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。
Bicep ファイル |
形容 |
Virtual WAN リソースを作成 |
このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。 |
ARM テンプレート リソース定義
vpnSites リソースの種類は、次をターゲットとする操作と共にデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Network/vpnSites リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2024-07-01",
"name": "string",
"location": "string",
"properties": {
"addressSpace": {
"addressPrefixes": [ "string" ],
"ipamPoolPrefixAllocations": [
{
"numberOfIpAddresses": "string",
"pool": {
"id": "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"
}
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
Microsoft.Network/vpnSites (英語)
名前 |
形容 |
価値 |
apiVersion (英語) |
API のバージョン |
'2024-07-01' |
場所 |
リソースの場所。 |
糸 |
名前 |
リソース名 |
string (必須) |
プロパティ |
VPN サイトのプロパティ。 |
VpnSiteProperties の |
タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
種類 |
リソースの種類 |
「Microsoft.Network/vpnSites」 |
アドレス空間
名前 |
形容 |
価値 |
addressプレフィックス |
CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 |
文字列[] |
ipamPoolPrefixAllocations(英語) |
IP アドレス プレフィックスを割り当てる IPAM プールの一覧。 |
IpamPoolプレフィックス割り当て[] |
Bgp設定
名前 |
形容 |
価値 |
ASN(エーエスエヌ) |
BGP スピーカーの ASN。 |
int
制約: 最小値 = 0 最大値 = 4294967295 |
bgpピアリングアドレス |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
糸 |
bgpPeeringアドレス |
仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 |
IPConfigurationBgpPeeringAddress[] |
ピアウェイト |
この BGP スピーカーから学習したルートに追加された重み。 |
整数 (int) |
デバイスプロパティ
名前 |
形容 |
価値 |
デバイスモデル |
デバイスのモデル。 |
糸 |
デバイスベンダー |
デバイスベンダーの名前。 |
糸 |
linkSpeedIn Mbps |
リンク速度。 |
整数 (int) |
IpamPoolPrefixAllocation
IpamPoolプレフィックス割り当てプール
名前 |
形容 |
価値 |
身分証明書 |
関連付けられている Azure IpamPool リソースのリソース ID。 |
糸 |
IPConfigurationBgpPeeringAddress (英語)
名前 |
形容 |
価値 |
customBgpIpアドレス |
IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 |
文字列[] |
ipconfigurationId (英語) |
ゲートウェイに属する IP 構成の ID。 |
糸 |
O365BreakOutCategoryポリシー
名前 |
形容 |
価値 |
許す |
許可カテゴリを制御するフラグ。 |
ブール (bool) |
デフォルト |
既定のカテゴリを制御するフラグ。 |
ブール (bool) |
最適化 |
最適化カテゴリを制御するフラグ。 |
ブール (bool) |
O365ポリシープロパティ
サブリソース
名前 |
形容 |
価値 |
身分証明書 |
リソース ID。 |
糸 |
VpnLinkBgp設定
名前 |
形容 |
価値 |
ASN(エーエスエヌ) |
BGP スピーカーの ASN。 |
整数 (int) |
bgpピアリングアドレス |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
糸 |
VpnLinkProviderプロパティ
名前 |
形容 |
価値 |
リンク・プロバイダ名 |
リンク プロバイダーの名前。 |
糸 |
linkSpeedIn Mbps |
リンク速度。 |
整数 (int) |
VpnSiteリンク
名前 |
形容 |
価値 |
身分証明書 |
リソース ID。 |
糸 |
名前 |
リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
糸 |
プロパティ |
VPN サイト リンクのプロパティ。 |
VpnSiteLinkProperties の |
VpnSiteLinkプロパティ
名前 |
形容 |
価値 |
bgpプロパティ |
bgp プロパティのセット。 |
VpnLinkBgpSettings の |
FQDNの |
vpn-site-link の FQDN。 |
糸 |
IPアドレス |
vpn-site-link の IP アドレス。 |
糸 |
リンクプロパティ |
リンク プロバイダーのプロパティ。 |
VpnLinkProviderProperties の |
VpnSiteプロパティ
名前 |
形容 |
価値 |
アドレス空間 |
IP アドレス範囲の配列を含む AddressSpace。 |
アドレス空間 |
bgpプロパティ |
bgp プロパティのセット。 |
Bgp設定 |
デバイスプロパティ |
デバイスのプロパティ。 |
DeviceProperties の |
IPアドレス |
VPN サイトの IP アドレス。 |
糸 |
isSecuritySite (英語) |
IsSecuritySite フラグ。 |
ブール (bool) |
o365ポリシー |
Office365 ポリシー。 |
O365ポリシープロパティ |
サイトキー |
接続に使用できる VPN サイトのキー。 |
糸 |
バーチャルワン |
vpnSite が属する VirtualWAN。 |
SubResource の |
vpnサイトリンク |
すべての VPN サイト リンクの一覧。 |
VpnSiteLink[] |
使用例
Azure クイック スタート テンプレート
このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。
テンプレート |
形容 |
Virtual WAN リソースを作成
Azure にデプロイする |
このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。 |
vpnSites リソースの種類は、次をターゲットとする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Network/vpnSites リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2024-07-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
addressSpace = {
addressPrefixes = [
"string"
]
ipamPoolPrefixAllocations = [
{
numberOfIpAddresses = "string"
pool = {
id = "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
}
}
}
]
}
}
}
プロパティ値
Microsoft.Network/vpnSites (英語)
名前 |
形容 |
価値 |
場所 |
リソースの場所。 |
糸 |
名前 |
リソース名 |
string (必須) |
プロパティ |
VPN サイトのプロパティ。 |
VpnSiteProperties の |
タグ |
リソース タグ |
タグ名と値のディクショナリ。 |
種類 |
リソースの種類 |
"Microsoft.Network/vpnSites@2024-07-01" (英語) |
アドレス空間
名前 |
形容 |
価値 |
addressプレフィックス |
CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 |
文字列[] |
ipamPoolPrefixAllocations(英語) |
IP アドレス プレフィックスを割り当てる IPAM プールの一覧。 |
IpamPoolプレフィックス割り当て[] |
Bgp設定
名前 |
形容 |
価値 |
ASN(エーエスエヌ) |
BGP スピーカーの ASN。 |
int
制約: 最小値 = 0 最大値 = 4294967295 |
bgpピアリングアドレス |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
糸 |
bgpPeeringアドレス |
仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 |
IPConfigurationBgpPeeringAddress[] |
ピアウェイト |
この BGP スピーカーから学習したルートに追加された重み。 |
整数 (int) |
デバイスプロパティ
名前 |
形容 |
価値 |
デバイスモデル |
デバイスのモデル。 |
糸 |
デバイスベンダー |
デバイスベンダーの名前。 |
糸 |
linkSpeedIn Mbps |
リンク速度。 |
整数 (int) |
IpamPoolPrefixAllocation
IpamPoolプレフィックス割り当てプール
名前 |
形容 |
価値 |
身分証明書 |
関連付けられている Azure IpamPool リソースのリソース ID。 |
糸 |
IPConfigurationBgpPeeringAddress (英語)
名前 |
形容 |
価値 |
customBgpIpアドレス |
IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 |
文字列[] |
ipconfigurationId (英語) |
ゲートウェイに属する IP 構成の ID。 |
糸 |
O365BreakOutCategoryポリシー
名前 |
形容 |
価値 |
許す |
許可カテゴリを制御するフラグ。 |
ブール (bool) |
デフォルト |
既定のカテゴリを制御するフラグ。 |
ブール (bool) |
最適化 |
最適化カテゴリを制御するフラグ。 |
ブール (bool) |
O365ポリシープロパティ
サブリソース
名前 |
形容 |
価値 |
身分証明書 |
リソース ID。 |
糸 |
VpnLinkBgp設定
名前 |
形容 |
価値 |
ASN(エーエスエヌ) |
BGP スピーカーの ASN。 |
整数 (int) |
bgpピアリングアドレス |
この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 |
糸 |
VpnLinkProviderプロパティ
名前 |
形容 |
価値 |
リンク・プロバイダ名 |
リンク プロバイダーの名前。 |
糸 |
linkSpeedIn Mbps |
リンク速度。 |
整数 (int) |
VpnSiteリンク
名前 |
形容 |
価値 |
身分証明書 |
リソース ID。 |
糸 |
名前 |
リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 |
糸 |
プロパティ |
VPN サイト リンクのプロパティ。 |
VpnSiteLinkProperties の |
VpnSiteLinkプロパティ
名前 |
形容 |
価値 |
bgpプロパティ |
bgp プロパティのセット。 |
VpnLinkBgpSettings の |
FQDNの |
vpn-site-link の FQDN。 |
糸 |
IPアドレス |
vpn-site-link の IP アドレス。 |
糸 |
リンクプロパティ |
リンク プロバイダーのプロパティ。 |
VpnLinkProviderProperties の |
VpnSiteプロパティ
名前 |
形容 |
価値 |
アドレス空間 |
IP アドレス範囲の配列を含む AddressSpace。 |
アドレス空間 |
bgpプロパティ |
bgp プロパティのセット。 |
Bgp設定 |
デバイスプロパティ |
デバイスのプロパティ。 |
DeviceProperties の |
IPアドレス |
VPN サイトの IP アドレス。 |
糸 |
isSecuritySite (英語) |
IsSecuritySite フラグ。 |
ブール (bool) |
o365ポリシー |
Office365 ポリシー。 |
O365ポリシープロパティ |
サイトキー |
接続に使用できる VPN サイトのキー。 |
糸 |
バーチャルワン |
vpnSite が属する VirtualWAN。 |
SubResource の |
vpnサイトリンク |
すべての VPN サイト リンクの一覧。 |
VpnSiteLink[] |