Microsoft.Network vpnSites 2020-11-01

Artigo
05/07/2024

Definição de recurso do Bicep

O tipo de recurso vpnSites pode ser implantado com operações direcionadas:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/vpnSites, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Network/vpnSites@2020-11-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
          }
        }
      }
    ]
  }
}

Valores de propriedade

vpnSites

Nome	Descrição	Valor
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos, sublinhados, pontos e hifens. Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local	Local do recurso.	string
marcas	Marcas de recurso.	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	Propriedades do site VPN.	VpnSiteProperties

VpnSiteProperties

Nome	Descrição	Valor
addressSpace	O AddressSpace que contém uma matriz de intervalos de endereços IP.	AddressSpace
bgpProperties	O conjunto de propriedades bgp.	BgpSettings
deviceProperties	As propriedades do dispositivo.	DeviceProperties
ipAddress	O endereço IP para o vpn-site.	string
isSecuritySite	Sinalizador IsSecuritySite.	bool
o365Policy	Política do Office365.	O365PolicyProperties
siteKey	A chave para vpn-site que pode ser usada para conexões.	string
virtualWan	A VirtualWAN à qual o vpnSite pertence.	SubResource
vpnSiteLinks	Lista de todos os links de site vpn.	VpnSiteLink[]

AddressSpace

Nome	Descrição	Valor
addressPrefixes	Uma lista de blocos de endereço reservados para essa rede virtual na notação CIDR.	string[]

BgpSettings

Nome	Descrição	Valor
Asn	O ASN do alto-falante BGP.	INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295
bgpPeeringAddress	O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP.	string
bgpPeeringAddresses	Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual.	IPConfigurationBgpPeeringAddress[]
peerWeight	O peso adicionado às rotas aprendidas com esse alto-falante BGP.	INT

IPConfigurationBgpPeeringAddress

Nome	Descrição	Valor
customBgpIpAddresses	A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP.	string[]
ipconfigurationId	A ID da configuração de IP que pertence ao gateway.	string

DeviceProperties

Nome	Descrição	Valor
deviceModel	Modelo do dispositivo.	string
deviceVendor	Nome do fornecedor do dispositivo.	string
linkSpeedInMbps	Velocidade do link.	INT

O365PolicyProperties

Nome	Descrição	Valor
breakOutCategories	Categorias de sessão de grupo do Office365.	O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Nome	Descrição	Valor
allow	Sinalizador para controlar a categoria de permissão.	bool
padrão	Sinalizador para controlar a categoria padrão.	bool
optimize	Sinalizador para controlar a categoria de otimização.	bool

SubResource

Nome	Descrição	Valor
id	ID do recurso.	string

VpnSiteLink

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	Propriedades do link do site VPN.	VpnSiteLinkProperties

VpnSiteLinkProperties

Nome	Descrição	Valor
bgpProperties	O conjunto de propriedades bgp.	VpnLinkBgpSettings
fqdn	FQDN de vpn-site-link.	string
ipAddress	O endereço IP para o vpn-site-link.	string
linkProperties	As propriedades do provedor de link.	VpnLinkProviderProperties

VpnLinkBgpSettings

Nome	Descrição	Valor
Asn	O ASN do alto-falante BGP.	INT
bgpPeeringAddress	O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP.	string

VpnLinkProviderProperties

Nome	Descrição	Valor
linkProviderName	Nome do provedor de link.	string
linkSpeedInMbps	Velocidade do link.	INT

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Cria recursos de WAN Virtual	Esse modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway de VPN, Site VPN e um Vpn Connecton.

Definição de recurso de modelo do ARM

O tipo de recurso vpnSites pode ser implantado com operações direcionadas:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/vpnSites, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2020-11-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"
          }
        }
      }
    ]
  }
}

Valores de propriedade

vpnSites

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.Network/vpnSites'
apiVersion	A versão da API do recurso	'2020-11-01'
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos, sublinhados, pontos e hifens. Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local	Local do recurso.	string
marcas	Marcas de recurso.	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	Propriedades do site VPN.	VpnSiteProperties

VpnSiteProperties

Nome	Descrição	Valor
addressSpace	O AddressSpace que contém uma matriz de intervalos de endereços IP.	AddressSpace
bgpProperties	O conjunto de propriedades bgp.	BgpSettings
deviceProperties	As propriedades do dispositivo.	DeviceProperties
ipAddress	O endereço IP para o vpn-site.	string
isSecuritySite	Sinalizador IsSecuritySite.	bool
o365Policy	Política do Office365.	O365PolicyProperties
siteKey	A chave para vpn-site que pode ser usada para conexões.	string
virtualWan	A VirtualWAN à qual o vpnSite pertence.	SubResource
vpnSiteLinks	Lista de todos os links de site vpn.	VpnSiteLink[]

AddressSpace

Nome	Descrição	Valor
addressPrefixes	Uma lista de blocos de endereço reservados para essa rede virtual na notação CIDR.	string[]

BgpSettings

Nome	Descrição	Valor
Asn	O ASN do alto-falante BGP.	INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295
bgpPeeringAddress	O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP.	string
bgpPeeringAddresses	Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual.	IPConfigurationBgpPeeringAddress[]
peerWeight	O peso adicionado às rotas aprendidas com esse alto-falante BGP.	INT

IPConfigurationBgpPeeringAddress

Nome	Descrição	Valor
customBgpIpAddresses	A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP.	string[]
ipconfigurationId	A ID da configuração de IP que pertence ao gateway.	string

DeviceProperties

Nome	Descrição	Valor
deviceModel	Modelo do dispositivo.	string
deviceVendor	Nome do fornecedor do dispositivo.	string
linkSpeedInMbps	Velocidade do link.	INT

O365PolicyProperties

Nome	Descrição	Valor
breakOutCategories	Categorias de sessão de grupo do Office365.	O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Nome	Descrição	Valor
allow	Sinalizador para controlar a categoria de permissão.	bool
padrão	Sinalizador para controlar a categoria padrão.	bool
optimize	Sinalizador para controlar a categoria de otimização.	bool

SubResource

Nome	Descrição	Valor
id	ID do recurso.	string

VpnSiteLink

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	Propriedades do link do site VPN.	VpnSiteLinkProperties

VpnSiteLinkProperties

Nome	Descrição	Valor
bgpProperties	O conjunto de propriedades bgp.	VpnLinkBgpSettings
fqdn	FQDN de vpn-site-link.	string
ipAddress	O ip-address para o vpn-site-link.	string
linkProperties	As propriedades do provedor de link.	VpnLinkProviderProperties

VpnLinkBgpSettings

Nome	Descrição	Valor
Asn	O ASN do alto-falante BGP.	INT
bgpPeeringAddress	O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP.	string

VpnLinkProviderProperties

Nome	Descrição	Valor
linkProviderName	Nome do provedor de link.	string
linkSpeedInMbps	Velocidade do link.	INT

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Cria recursos de WAN Virtual	Esse modelo permite que você crie recursos de WAN virtual, incluindo WAN Virtual, Hub Virtual, Gateway de VPN, Site VPN e um Vpn Connecton.

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso vpnSites pode ser implantado com operações direcionadas:

Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/vpnSites, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnSites@2020-11-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
            }
          }
        }
      ]
    }
  })
}

Valores de propriedade

vpnSites

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Network/vpnSites@2020-11-01"
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos, sublinhados, pontos e hifens. Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local	Local do recurso.	string
parent_id	Para implantar em um grupo de recursos, use a ID desse grupo de recursos.	cadeia de caracteres (obrigatório)
marcas	Marcas de recurso.	Dicionário de nomes e valores de marcas.
properties	Propriedades do site VPN.	VpnSiteProperties

VpnSiteProperties

Nome	Descrição	Valor
addressSpace	O AddressSpace que contém uma matriz de intervalos de endereços IP.	AddressSpace
bgpProperties	O conjunto de propriedades bgp.	BgpSettings
deviceProperties	As propriedades do dispositivo.	DeviceProperties
ipAddress	O endereço ip para o site vpn.	string
isSecuritySite	Sinalizador IsSecuritySite.	bool
o365Policy	Política do Office365.	O365PolicyProperties
siteKey	A chave para vpn-site que pode ser usada para conexões.	string
virtualWan	O VirtualWAN ao qual o vpnSite pertence.	SubResource
vpnSiteLinks	Lista de todos os links do site vpn.	VpnSiteLink[]

AddressSpace

Nome	Descrição	Valor
addressPrefixes	Uma lista de blocos de endereços reservados para essa rede virtual na notação CIDR.	string[]

BgpSettings

Nome	Descrição	Valor
Asn	O ASN do alto-falante 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.	string
bgpPeeringAddresses	Endereço de emparelhamento BGP com ID de configuração de IP para gateway de rede virtual.	IPConfigurationBgpPeeringAddress[]
peerWeight	O peso adicionado às rotas aprendidas com esse alto-falante BGP.	INT

IPConfigurationBgpPeeringAddress

Nome	Descrição	Valor
customBgpIpAddresses	A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração de IP.	string[]
ipconfigurationId	A ID da configuração de IP que pertence ao gateway.	string

DeviceProperties

Nome	Descrição	Valor
deviceModel	Modelo do dispositivo.	string
deviceVendor	Nome do fornecedor do dispositivo.	string
linkSpeedInMbps	Velocidade do link.	INT

O365PolicyProperties

Nome	Descrição	Valor
breakOutCategories	Categorias de sessão de grupo do Office365.	O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Nome	Descrição	Valor
allow	Sinalizador para controlar a categoria de permissão.	bool
padrão	Sinalizador para controlar a categoria padrão.	bool
optimize	Sinalizador para controlar a categoria de otimização.	bool

SubResource

Nome	Descrição	Valor
id	ID do recurso.	string

VpnSiteLink

Nome	Descrição	Valor
id	ID do recurso.	string
name	O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.	string
properties	Propriedades do link do site VPN.	VpnSiteLinkProperties

VpnSiteLinkProperties

Nome	Descrição	Valor
bgpProperties	O conjunto de propriedades bgp.	VpnLinkBgpSettings
fqdn	FQDN de vpn-site-link.	string
ipAddress	O endereço IP para o vpn-site-link.	string
linkProperties	As propriedades do provedor de link.	VpnLinkProviderProperties

VpnLinkBgpSettings

Nome	Descrição	Valor
Asn	O ASN do alto-falante BGP.	INT
bgpPeeringAddress	O endereço de emparelhamento BGP e o identificador BGP desse alto-falante BGP.	string

VpnLinkProviderProperties

Nome	Descrição	Valor
linkProviderName	Nome do provedor de link.	string
linkSpeedInMbps	Velocidade do link.	INT

Compartilhar via

Microsoft.Network vpnSites 2020-11-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

vpnSites

VpnSiteProperties

AddressSpace

BgpSettings

IPConfigurationBgpPeeringAddress

DeviceProperties

O365PolicyProperties

O365BreakOutCategoryPolicies

SubResource

VpnSiteLink

VpnSiteLinkProperties

VpnLinkBgpSettings

VpnLinkProviderProperties

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

vpnSites

VpnSiteProperties

AddressSpace

BgpSettings

IPConfigurationBgpPeeringAddress

DeviceProperties

O365PolicyProperties

O365BreakOutCategoryPolicies

SubResource

VpnSiteLink

VpnSiteLinkProperties

VpnLinkBgpSettings

VpnLinkProviderProperties

Modelos de início rápido

Definição de recurso do Terraform (provedor AzAPI)

Formato de recurso

Valores de propriedade

vpnSites

VpnSiteProperties

AddressSpace

BgpSettings

IPConfigurationBgpPeeringAddress

DeviceProperties

O365PolicyProperties

O365BreakOutCategoryPolicies

SubResource

VpnSiteLink

VpnSiteLinkProperties

VpnLinkBgpSettings

VpnLinkProviderProperties

Comentários

Recursos adicionais