Definição de recursos do bíceps
O tipo de recurso vpnSites pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Exemplos de uso
Amostras de bíceps
Um exemplo básico de implantação do Site VPN.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource virtualWan 'Microsoft.Network/virtualWans@2022-07-01' = {
name: resourceName
location: location
properties: {
allowBranchToBranchTraffic: true
disableVpnEncryption: false
office365LocalBreakoutCategory: 'None'
type: 'Standard'
}
}
resource vpnSite 'Microsoft.Network/vpnSites@2022-07-01' = {
name: resourceName
location: location
properties: {
addressSpace: {
addressPrefixes: [
'10.0.1.0/24'
]
}
virtualWan: {
id: virtualWan.id
}
vpnSiteLinks: [
{
name: 'link1'
properties: {
fqdn: ''
ipAddress: '10.0.1.1'
linkProperties: {
linkProviderName: ''
linkSpeedInMbps: 0
}
}
}
{
name: 'link2'
properties: {
fqdn: ''
ipAddress: '10.0.1.2'
linkProperties: {
linkProviderName: ''
linkSpeedInMbps: 0
}
}
}
]
}
}
Módulos verificados do Azure
Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.
| Módulo |
Descrição |
|
Site VPN |
Módulo de recursos AVM para site VPN |
Exemplos de início rápido do Azure
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.
| Arquivo Bicep |
Descrição |
|
cria recursos de WAN virtual |
Este modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway VPN, Site VPN e um VPN Connecton. |
Para criar um recurso Microsoft.Network/vpnSites, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Network/vpnSites@2020-06-01' = {
location: 'string'
name: 'string'
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
}
}
}
]
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
Microsoft.Network/vpnSites
| Designação |
Descrição |
Valor |
| localização |
Localização do recurso. |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
Propriedades do site VPN. |
VpnSiteProperties |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. Consulte Tags em modelos |
EndereçoEspaço
| Designação |
Descrição |
Valor |
| addressPrefixes |
Uma lista de blocos de endereços reservados para esta rede virtual na notação CIDR. |
string[] |
BgpSettings
| Designação |
Descrição |
Valor |
| ASN |
ASN do orador BGP. |
Int
Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
| bgpPeeringAddress |
O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP. |
cadeia (de caracteres) |
| bgpPeeringAddresses |
Endereço de emparelhamento BGP com ID de configuração IP para gateway de rede virtual. |
IPConfigurationBgpPeeringAddress[] |
| Peso de pares |
O peso adicionado às rotas aprendidas com este alto-falante BGP. |
Int |
DeviceProperties
| Designação |
Descrição |
Valor |
| deviceModel [en] |
Modelo do dispositivo. |
cadeia (de caracteres) |
| deviceVendor |
Nome do fornecedor do dispositivo. |
cadeia (de caracteres) |
| linkSpeedInMbps |
Velocidade do link. |
Int |
IPConfigurationBgpPeeringAddress
| Designação |
Descrição |
Valor |
| customBgpIpAddresses |
A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração IP. |
string[] |
| ipconfigurationId |
O ID da configuração IP que pertence ao gateway. |
cadeia (de caracteres) |
O365BreakOutCategoryPolicies
| Designação |
Descrição |
Valor |
| permitir |
Sinalizador para controlar a categoria de permissão. |
Bool |
| predefinição |
Sinalizador para controlar a categoria padrão. |
Bool |
| optimizar |
Sinalizador para controlar a categoria de otimização. |
Bool |
O365PolicyProperties
| Designação |
Descrição |
Valor |
Subrecurso
| Designação |
Descrição |
Valor |
| ID |
ID do recurso. |
cadeia (de caracteres) |
VpnLinkBgpSettings
| Designação |
Descrição |
Valor |
| ASN |
ASN do orador BGP. |
Int |
| bgpPeeringAddress |
O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP. |
cadeia (de caracteres) |
VpnLinkProviderProperties
| Designação |
Descrição |
Valor |
| nome_linkProviderName |
Nome do provedor de link. |
cadeia (de caracteres) |
| linkSpeedInMbps |
Velocidade do link. |
Int |
VpnSiteLink
| Designação |
Descrição |
Valor |
| ID |
ID do recurso. |
cadeia (de caracteres) |
| Designação |
O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. |
cadeia (de caracteres) |
| propriedades |
Propriedades do link do site VPN. |
VpnSiteLinkProperties |
VpnSiteLinkProperties
| Designação |
Descrição |
Valor |
| bgpPropriedades |
O conjunto de propriedades bgp. |
VpnLinkBgpSettings |
| FQDN |
FQDN de vpn-site-link. |
cadeia (de caracteres) |
| Endereço IP |
O endereço ip para o vpn-site-link. |
cadeia (de caracteres) |
| linkPropriedades |
As propriedades do provedor de link. |
VpnLinkProviderProperties |
VpnSiteProperties
| Designação |
Descrição |
Valor |
| endereçoEspaço |
O AddressSpace que contém uma matriz de intervalos de endereços IP. |
EndereçoEspaço |
| bgpPropriedades |
O conjunto de propriedades bgp. |
BgpSettings |
| propriedades do dispositivo |
As propriedades do dispositivo. |
DeviceProperties |
| Endereço IP |
O endereço ip do vpn-site. |
cadeia (de caracteres) |
| isSecuritySite |
Sinalizador IsSecuritySite. |
Bool |
| o365Política |
Política do Office365. |
O365PolicyProperties |
| chave do site |
A chave para vpn-site que pode ser usada para conexões. |
cadeia (de caracteres) |
| virtualWan |
O VirtualWAN ao qual o vpnSite pertence. |
Subrecurso |
| vpnSiteLinks |
Lista de todos os links de sites vpn. |
VpnSiteLink[] |
Definição de recurso de modelo ARM
O tipo de recurso vpnSites pode ser implantado com operações que visam:
Exemplos de uso
Modelos de início rápido do Azure
Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.
| Modelo |
Descrição |
cria recursos de WAN virtual
|
Este modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway VPN, Site VPN e um VPN Connecton. |
Para criar um recurso Microsoft.Network/vpnSites, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2020-06-01",
"name": "string",
"location": "string",
"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"
}
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
Microsoft.Network/vpnSites
| Designação |
Descrição |
Valor |
| Versão da API |
A versão api |
'2020-06-01' |
| localização |
Localização do recurso. |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
Propriedades do site VPN. |
VpnSiteProperties |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. Consulte Tags em modelos |
| tipo |
O tipo de recurso |
'Microsoft.Network/vpnSites' |
EndereçoEspaço
| Designação |
Descrição |
Valor |
| addressPrefixes |
Uma lista de blocos de endereços reservados para esta rede virtual na notação CIDR. |
string[] |
BgpSettings
| Designação |
Descrição |
Valor |
| ASN |
ASN do orador BGP. |
Int
Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
| bgpPeeringAddress |
O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP. |
cadeia (de caracteres) |
| bgpPeeringAddresses |
Endereço de emparelhamento BGP com ID de configuração IP para gateway de rede virtual. |
IPConfigurationBgpPeeringAddress[] |
| Peso de pares |
O peso adicionado às rotas aprendidas com este alto-falante BGP. |
Int |
DeviceProperties
| Designação |
Descrição |
Valor |
| deviceModel [en] |
Modelo do dispositivo. |
cadeia (de caracteres) |
| deviceVendor |
Nome do fornecedor do dispositivo. |
cadeia (de caracteres) |
| linkSpeedInMbps |
Velocidade do link. |
Int |
IPConfigurationBgpPeeringAddress
| Designação |
Descrição |
Valor |
| customBgpIpAddresses |
A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração IP. |
string[] |
| ipconfigurationId |
O ID da configuração IP que pertence ao gateway. |
cadeia (de caracteres) |
O365BreakOutCategoryPolicies
| Designação |
Descrição |
Valor |
| permitir |
Sinalizador para controlar a categoria de permissão. |
Bool |
| predefinição |
Sinalizador para controlar a categoria padrão. |
Bool |
| optimizar |
Sinalizador para controlar a categoria de otimização. |
Bool |
O365PolicyProperties
| Designação |
Descrição |
Valor |
Subrecurso
| Designação |
Descrição |
Valor |
| ID |
ID do recurso. |
cadeia (de caracteres) |
VpnLinkBgpSettings
| Designação |
Descrição |
Valor |
| ASN |
ASN do orador BGP. |
Int |
| bgpPeeringAddress |
O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP. |
cadeia (de caracteres) |
VpnLinkProviderProperties
| Designação |
Descrição |
Valor |
| nome_linkProviderName |
Nome do provedor de link. |
cadeia (de caracteres) |
| linkSpeedInMbps |
Velocidade do link. |
Int |
VpnSiteLink
| Designação |
Descrição |
Valor |
| ID |
ID do recurso. |
cadeia (de caracteres) |
| Designação |
O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. |
cadeia (de caracteres) |
| propriedades |
Propriedades do link do site VPN. |
VpnSiteLinkProperties |
VpnSiteLinkProperties
| Designação |
Descrição |
Valor |
| bgpPropriedades |
O conjunto de propriedades bgp. |
VpnLinkBgpSettings |
| FQDN |
FQDN de vpn-site-link. |
cadeia (de caracteres) |
| Endereço IP |
O endereço ip para o vpn-site-link. |
cadeia (de caracteres) |
| linkPropriedades |
As propriedades do provedor de link. |
VpnLinkProviderProperties |
VpnSiteProperties
| Designação |
Descrição |
Valor |
| endereçoEspaço |
O AddressSpace que contém uma matriz de intervalos de endereços IP. |
EndereçoEspaço |
| bgpPropriedades |
O conjunto de propriedades bgp. |
BgpSettings |
| propriedades do dispositivo |
As propriedades do dispositivo. |
DeviceProperties |
| Endereço IP |
O endereço ip do vpn-site. |
cadeia (de caracteres) |
| isSecuritySite |
Sinalizador IsSecuritySite. |
Bool |
| o365Política |
Política do Office365. |
O365PolicyProperties |
| chave do site |
A chave para vpn-site que pode ser usada para conexões. |
cadeia (de caracteres) |
| virtualWan |
O VirtualWAN ao qual o vpnSite pertence. |
Subrecurso |
| vpnSiteLinks |
Lista de todos os links de sites vpn. |
VpnSiteLink[] |
O tipo de recurso vpnSites pode ser implantado com operações que visam:
-
Grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, veja registo de alterações.
Exemplos de uso
Um exemplo básico de implantação do Site VPN.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "virtualWan" {
type = "Microsoft.Network/virtualWans@2022-07-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
allowBranchToBranchTraffic = true
disableVpnEncryption = false
office365LocalBreakoutCategory = "None"
type = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "vpnSite" {
type = "Microsoft.Network/vpnSites@2022-07-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
addressSpace = {
addressPrefixes = [
"10.0.1.0/24",
]
}
virtualWan = {
id = azapi_resource.virtualWan.id
}
vpnSiteLinks = [
{
name = "link1"
properties = {
fqdn = ""
ipAddress = "10.0.1.1"
linkProperties = {
linkProviderName = ""
linkSpeedInMbps = 0
}
}
},
{
name = "link2"
properties = {
fqdn = ""
ipAddress = "10.0.1.2"
linkProperties = {
linkProviderName = ""
linkSpeedInMbps = 0
}
}
},
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Para criar um recurso Microsoft.Network/vpnSites, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2020-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
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
}
}
}
]
}
}
}
Valores de propriedade
Microsoft.Network/vpnSites
| Designação |
Descrição |
Valor |
| localização |
Localização do recurso. |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
Propriedades do site VPN. |
VpnSiteProperties |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. |
| tipo |
O tipo de recurso |
"Microsoft.Network/vpnSites@2020-06-01" |
EndereçoEspaço
| Designação |
Descrição |
Valor |
| addressPrefixes |
Uma lista de blocos de endereços reservados para esta rede virtual na notação CIDR. |
string[] |
BgpSettings
| Designação |
Descrição |
Valor |
| ASN |
ASN do orador BGP. |
Int
Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
| bgpPeeringAddress |
O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP. |
cadeia (de caracteres) |
| bgpPeeringAddresses |
Endereço de emparelhamento BGP com ID de configuração IP para gateway de rede virtual. |
IPConfigurationBgpPeeringAddress[] |
| Peso de pares |
O peso adicionado às rotas aprendidas com este alto-falante BGP. |
Int |
DeviceProperties
| Designação |
Descrição |
Valor |
| deviceModel [en] |
Modelo do dispositivo. |
cadeia (de caracteres) |
| deviceVendor |
Nome do fornecedor do dispositivo. |
cadeia (de caracteres) |
| linkSpeedInMbps |
Velocidade do link. |
Int |
IPConfigurationBgpPeeringAddress
| Designação |
Descrição |
Valor |
| customBgpIpAddresses |
A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração IP. |
string[] |
| ipconfigurationId |
O ID da configuração IP que pertence ao gateway. |
cadeia (de caracteres) |
O365BreakOutCategoryPolicies
| Designação |
Descrição |
Valor |
| permitir |
Sinalizador para controlar a categoria de permissão. |
Bool |
| predefinição |
Sinalizador para controlar a categoria padrão. |
Bool |
| optimizar |
Sinalizador para controlar a categoria de otimização. |
Bool |
O365PolicyProperties
| Designação |
Descrição |
Valor |
Subrecurso
| Designação |
Descrição |
Valor |
| ID |
ID do recurso. |
cadeia (de caracteres) |
VpnLinkBgpSettings
| Designação |
Descrição |
Valor |
| ASN |
ASN do orador BGP. |
Int |
| bgpPeeringAddress |
O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP. |
cadeia (de caracteres) |
VpnLinkProviderProperties
| Designação |
Descrição |
Valor |
| nome_linkProviderName |
Nome do provedor de link. |
cadeia (de caracteres) |
| linkSpeedInMbps |
Velocidade do link. |
Int |
VpnSiteLink
| Designação |
Descrição |
Valor |
| ID |
ID do recurso. |
cadeia (de caracteres) |
| Designação |
O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso. |
cadeia (de caracteres) |
| propriedades |
Propriedades do link do site VPN. |
VpnSiteLinkProperties |
VpnSiteLinkProperties
| Designação |
Descrição |
Valor |
| bgpPropriedades |
O conjunto de propriedades bgp. |
VpnLinkBgpSettings |
| FQDN |
FQDN de vpn-site-link. |
cadeia (de caracteres) |
| Endereço IP |
O endereço ip para o vpn-site-link. |
cadeia (de caracteres) |
| linkPropriedades |
As propriedades do provedor de link. |
VpnLinkProviderProperties |
VpnSiteProperties
| Designação |
Descrição |
Valor |
| endereçoEspaço |
O AddressSpace que contém uma matriz de intervalos de endereços IP. |
EndereçoEspaço |
| bgpPropriedades |
O conjunto de propriedades bgp. |
BgpSettings |
| propriedades do dispositivo |
As propriedades do dispositivo. |
DeviceProperties |
| Endereço IP |
O endereço ip do vpn-site. |
cadeia (de caracteres) |
| isSecuritySite |
Sinalizador IsSecuritySite. |
Bool |
| o365Política |
Política do Office365. |
O365PolicyProperties |
| chave do site |
A chave para vpn-site que pode ser usada para conexões. |
cadeia (de caracteres) |
| virtualWan |
O VirtualWAN ao qual o vpnSite pertence. |
Subrecurso |
| vpnSiteLinks |
Lista de todos os links de sites vpn. |
VpnSiteLink[] |