Microsoft.Network virtualNetworkGateways 2016-03-30
Artigo 12/09/2024
2 colaboradores
Comentários
Neste artigo
Definição de recurso do Bicep
O tipo de recurso virtualNetworkGateways pode ser implantado com operações de destino:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Para criar um recurso Microsoft.Network/virtualNetworkGateways, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2016-03-30' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
bgpSettings: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
enableBgp: bool
gatewayDefaultSite: {
id: 'string'
}
gatewayType: 'string'
ipConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
privateIPAddress: 'string'
privateIPAllocationMethod: 'string'
provisioningState: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
provisioningState: 'string'
resourceGuid: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
vpnClientConfiguration: {
vpnClientAddressPool: {
addressPrefixes: [
'string'
]
}
vpnClientRevokedCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
provisioningState: 'string'
thumbprint: 'string'
}
}
]
vpnClientRootCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
provisioningState: 'string'
publicCertData: 'string'
}
}
]
}
vpnType: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
AddressSpace
Nome
Descrição
Valor
addressPrefixes
Obtém ou define lista de blocos de endereço reservados para essa rede virtual na notação CIDR
string[]
BgpSettings
Nome
Descrição
Valor
Asn
Obtém ou define o ASN do locutor BGP
int
bgpPeeringAddress
Obtém ou define o endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP
corda
peerWeight
Obtém ou define o peso adicionado às rotas aprendidas com este alto-falante BGP
int
Microsoft.Network/virtualNetworkGateways
Nome
Descrição
Valor
etag
Obtém uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
localização
Local do recurso
corda
nome
O nome do recurso
cadeia de caracteres (obrigatório)
Propriedades
Propriedades de VirtualNetworkGateway
VirtualNetworkGatewayPropertiesFormat
Tags
Marcas de recurso
Dicionário de nomes e valores de marca. Consulte Marcas em modelos
SubResource
Nome
Descrição
Valor
id
ID do recurso
corda
VirtualNetworkGatewayIPConfiguration
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades de VirtualNetworkGatewayIPConfiguration
VirtualNetworkGatewayIPConfigurationPropertiesFormat
Nome
Descrição
Valor
privateIPAddress
Obtém ou define o privateIPAddress da Configuração de IP
corda
privateIPAllocationMethod
Obtém ou define o método de alocação PrivateIP (Estático/Dinâmico)
'Dinâmico' 'Estático'
provisioningState
Obtém ou define o estado de provisionamento do recurso PublicIP atualizando/excluindo/falha
corda
publicIPAddress
Obtém ou define a referência do recurso PublicIP
sub-recurso
sub-rede
Obtém ou define a referência do recurso de sub-rede
sub-recurso
Nome
Descrição
Valor
bgpSettings
Configurações do alto-falante BGP do gateway de rede virtual
bgpSettings
enableBgp
Sinalizador EnableBgp
Bool
gatewayDefaultSite
Obtém ou define a referência do recurso LocalNetworkGateway que representa o site de rede local com rotas padrão. Atribua valor Nulo em caso de remoção da configuração de site padrão existente.
sub-recurso
gatewayType
O tipo desse gateway de rede virtual.
'ExpressRoute' 'Vpn'
ipConfigurations
IpConfigurations para gateway de rede virtual.
VirtualNetworkGatewayIPConfiguration []
provisioningState
Obtém ou define o estado de provisionamento do recurso VirtualNetworkGateway atualizando/excluindo/falha
corda
resourceGuid
Obtém ou define a propriedade GUID de recurso do recurso VirtualNetworkGateway
corda
Sku
Obtém ou define a referência do recurso VirtualNetworkGatewaySku que representa o sku selecionado para o gateway de rede virtual.
VirtualNetworkGatewaySku
vpnClientConfiguration
Obtém ou define a referência do recurso VpnClientConfiguration que representa as configurações do VpnClient P2S.
VpnClientConfiguration
vpnType
O tipo desse gateway de rede virtual.
'PolicyBased' 'RouteBased'
VirtualNetworkGatewaySku
Nome
Descrição
Valor
capacidade
A capacidade
int
nome
Nome do sku do gateway -Basic/HighPerformance/Standard
'Básico' 'HighPerformance' 'Standard'
camada
Camada de sku do gateway -Basic/HighPerformance/Standard
'Básico' 'HighPerformance' 'Standard'
VpnClientConfiguration
Nome
Descrição
Valor
vpnClientAddressPool
Obtém ou define a referência do recurso espaço de endereço que representa o espaço de endereço para VpnClient P2S.
do AddressSpace
vpnClientRevokedCertificates
VpnClientRevokedCertificate para gateway de rede virtual.
VpnClientRevokedCertificate []
vpnClientRootCertificates
VpnClientRootCertificate para gateway de rede virtual.
VpnClientRootCertificate []
VpnClientRevokedCertificate
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades do certificado de cliente VPN revogado do gateway de rede virtual
VpnClientRevokedCertificatePropertiesFormat
Nome
Descrição
Valor
provisioningState
Obtém ou define o estado de provisionamento do recurso de certificado revogado pelo cliente VPN atualizando/excluindo/falha
corda
Impressão digital
Obtém ou define a impressão digital do certificado do cliente Vpn revogada
corda
VpnClientRootCertificate
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades de certificados SSL do gateway de aplicativo
VpnClientRootCertificatePropertiesFormat
Nome
Descrição
Valor
provisioningState
Obtém ou define o estado de provisionamento do recurso de certificado raiz do cliente VPN Atualizando/excluindo/falha
corda
publicCertData
Obtém ou define os dados públicos do certificado
corda
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Definição de recurso de modelo do ARM
O tipo de recurso virtualNetworkGateways pode ser implantado com operações de destino:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Para criar um recurso Microsoft.Network/virtualNetworkGateways, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Network/virtualNetworkGateways",
"apiVersion": "2016-03-30",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"bgpSettings": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"enableBgp": "bool",
"gatewayDefaultSite": {
"id": "string"
},
"gatewayType": "string",
"ipConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"privateIPAddress": "string",
"privateIPAllocationMethod": "string",
"provisioningState": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
],
"provisioningState": "string",
"resourceGuid": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"vpnClientConfiguration": {
"vpnClientAddressPool": {
"addressPrefixes": [ "string" ]
},
"vpnClientRevokedCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"provisioningState": "string",
"thumbprint": "string"
}
}
],
"vpnClientRootCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"provisioningState": "string",
"publicCertData": "string"
}
}
]
},
"vpnType": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
AddressSpace
Nome
Descrição
Valor
addressPrefixes
Obtém ou define lista de blocos de endereço reservados para essa rede virtual na notação CIDR
string[]
BgpSettings
Nome
Descrição
Valor
Asn
Obtém ou define o ASN do locutor BGP
int
bgpPeeringAddress
Obtém ou define o endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP
corda
peerWeight
Obtém ou define o peso adicionado às rotas aprendidas com este alto-falante BGP
int
Microsoft.Network/virtualNetworkGateways
Nome
Descrição
Valor
apiVersion
A versão da API
'2016-03-30'
etag
Obtém uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
localização
Local do recurso
corda
nome
O nome do recurso
cadeia de caracteres (obrigatório)
Propriedades
Propriedades de VirtualNetworkGateway
VirtualNetworkGatewayPropertiesFormat
Tags
Marcas de recurso
Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo
O tipo de recurso
'Microsoft.Network/virtualNetworkGateways'
SubResource
Nome
Descrição
Valor
id
ID do recurso
corda
VirtualNetworkGatewayIPConfiguration
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades de VirtualNetworkGatewayIPConfiguration
VirtualNetworkGatewayIPConfigurationPropertiesFormat
Nome
Descrição
Valor
privateIPAddress
Obtém ou define o privateIPAddress da Configuração de IP
corda
privateIPAllocationMethod
Obtém ou define o método de alocação PrivateIP (Estático/Dinâmico)
'Dinâmico' 'Estático'
provisioningState
Obtém ou define o estado de provisionamento do recurso PublicIP atualizando/excluindo/falha
corda
publicIPAddress
Obtém ou define a referência do recurso PublicIP
sub-recurso
sub-rede
Obtém ou define a referência do recurso de sub-rede
sub-recurso
Nome
Descrição
Valor
bgpSettings
Configurações do alto-falante BGP do gateway de rede virtual
bgpSettings
enableBgp
Sinalizador EnableBgp
Bool
gatewayDefaultSite
Obtém ou define a referência do recurso LocalNetworkGateway que representa o site de rede local com rotas padrão. Atribua valor Nulo em caso de remoção da configuração de site padrão existente.
sub-recurso
gatewayType
O tipo desse gateway de rede virtual.
'ExpressRoute' 'Vpn'
ipConfigurations
IpConfigurations para gateway de rede virtual.
VirtualNetworkGatewayIPConfiguration []
provisioningState
Obtém ou define o estado de provisionamento do recurso VirtualNetworkGateway atualizando/excluindo/falha
corda
resourceGuid
Obtém ou define a propriedade GUID de recurso do recurso VirtualNetworkGateway
corda
Sku
Obtém ou define a referência do recurso VirtualNetworkGatewaySku que representa o sku selecionado para o gateway de rede virtual.
VirtualNetworkGatewaySku
vpnClientConfiguration
Obtém ou define a referência do recurso VpnClientConfiguration que representa as configurações do VpnClient P2S.
VpnClientConfiguration
vpnType
O tipo desse gateway de rede virtual.
'PolicyBased' 'RouteBased'
VirtualNetworkGatewaySku
Nome
Descrição
Valor
capacidade
A capacidade
int
nome
Nome do sku do gateway -Basic/HighPerformance/Standard
'Básico' 'HighPerformance' 'Standard'
camada
Camada de sku do gateway -Basic/HighPerformance/Standard
'Básico' 'HighPerformance' 'Standard'
VpnClientConfiguration
Nome
Descrição
Valor
vpnClientAddressPool
Obtém ou define a referência do recurso espaço de endereço que representa o espaço de endereço para VpnClient P2S.
do AddressSpace
vpnClientRevokedCertificates
VpnClientRevokedCertificate para gateway de rede virtual.
VpnClientRevokedCertificate []
vpnClientRootCertificates
VpnClientRootCertificate para gateway de rede virtual.
VpnClientRootCertificate []
VpnClientRevokedCertificate
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades do certificado de cliente VPN revogado do gateway de rede virtual
VpnClientRevokedCertificatePropertiesFormat
Nome
Descrição
Valor
provisioningState
Obtém ou define o estado de provisionamento do recurso de certificado revogado pelo cliente VPN atualizando/excluindo/falha
corda
Impressão digital
Obtém ou define a impressão digital do certificado do cliente Vpn revogada
corda
VpnClientRootCertificate
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades de certificados SSL do gateway de aplicativo
VpnClientRootCertificatePropertiesFormat
Nome
Descrição
Valor
provisioningState
Obtém ou define o estado de provisionamento do recurso de certificado raiz do cliente VPN Atualizando/excluindo/falha
corda
publicCertData
Obtém ou define os dados públicos do certificado
corda
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
O tipo de recurso virtualNetworkGateways pode ser implantado com operações de destino:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Para criar um recurso Microsoft.Network/virtualNetworkGateways, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualNetworkGateways@2016-03-30"
name = "string"
etag = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
bgpSettings = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
enableBgp = bool
gatewayDefaultSite = {
id = "string"
}
gatewayType = "string"
ipConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
privateIPAddress = "string"
privateIPAllocationMethod = "string"
provisioningState = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
provisioningState = "string"
resourceGuid = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
vpnClientConfiguration = {
vpnClientAddressPool = {
addressPrefixes = [
"string"
]
}
vpnClientRevokedCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
provisioningState = "string"
thumbprint = "string"
}
}
]
vpnClientRootCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
provisioningState = "string"
publicCertData = "string"
}
}
]
}
vpnType = "string"
}
})
}
Valores de propriedade
AddressSpace
Nome
Descrição
Valor
addressPrefixes
Obtém ou define lista de blocos de endereço reservados para essa rede virtual na notação CIDR
string[]
BgpSettings
Nome
Descrição
Valor
Asn
Obtém ou define o ASN do locutor BGP
int
bgpPeeringAddress
Obtém ou define o endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP
corda
peerWeight
Obtém ou define o peso adicionado às rotas aprendidas com este alto-falante BGP
int
Microsoft.Network/virtualNetworkGateways
Nome
Descrição
Valor
etag
Obtém uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
localização
Local do recurso
corda
nome
O nome do recurso
cadeia de caracteres (obrigatório)
Propriedades
Propriedades de VirtualNetworkGateway
VirtualNetworkGatewayPropertiesFormat
Tags
Marcas de recurso
Dicionário de nomes e valores de marca.
tipo
O tipo de recurso
"Microsoft.Network/virtualNetworkGateways@2016-03-30"
SubResource
Nome
Descrição
Valor
id
ID do recurso
corda
VirtualNetworkGatewayIPConfiguration
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades de VirtualNetworkGatewayIPConfiguration
VirtualNetworkGatewayIPConfigurationPropertiesFormat
Nome
Descrição
Valor
privateIPAddress
Obtém ou define o privateIPAddress da Configuração de IP
corda
privateIPAllocationMethod
Obtém ou define o método de alocação PrivateIP (Estático/Dinâmico)
'Dinâmico' 'Estático'
provisioningState
Obtém ou define o estado de provisionamento do recurso PublicIP atualizando/excluindo/falha
corda
publicIPAddress
Obtém ou define a referência do recurso PublicIP
sub-recurso
sub-rede
Obtém ou define a referência do recurso de sub-rede
sub-recurso
Nome
Descrição
Valor
bgpSettings
Configurações do alto-falante BGP do gateway de rede virtual
bgpSettings
enableBgp
Sinalizador EnableBgp
Bool
gatewayDefaultSite
Obtém ou define a referência do recurso LocalNetworkGateway que representa o site de rede local com rotas padrão. Atribua valor Nulo em caso de remoção da configuração de site padrão existente.
sub-recurso
gatewayType
O tipo desse gateway de rede virtual.
'ExpressRoute' 'Vpn'
ipConfigurations
IpConfigurations para gateway de rede virtual.
VirtualNetworkGatewayIPConfiguration []
provisioningState
Obtém ou define o estado de provisionamento do recurso VirtualNetworkGateway atualizando/excluindo/falha
corda
resourceGuid
Obtém ou define a propriedade GUID de recurso do recurso VirtualNetworkGateway
corda
Sku
Obtém ou define a referência do recurso VirtualNetworkGatewaySku que representa o sku selecionado para o gateway de rede virtual.
VirtualNetworkGatewaySku
vpnClientConfiguration
Obtém ou define a referência do recurso VpnClientConfiguration que representa as configurações do VpnClient P2S.
VpnClientConfiguration
vpnType
O tipo desse gateway de rede virtual.
'PolicyBased' 'RouteBased'
VirtualNetworkGatewaySku
Nome
Descrição
Valor
capacidade
A capacidade
int
nome
Nome do sku do gateway -Basic/HighPerformance/Standard
'Básico' 'HighPerformance' 'Standard'
camada
Camada de sku do gateway -Basic/HighPerformance/Standard
'Básico' 'HighPerformance' 'Standard'
VpnClientConfiguration
Nome
Descrição
Valor
vpnClientAddressPool
Obtém ou define a referência do recurso espaço de endereço que representa o espaço de endereço para VpnClient P2S.
do AddressSpace
vpnClientRevokedCertificates
VpnClientRevokedCertificate para gateway de rede virtual.
VpnClientRevokedCertificate []
vpnClientRootCertificates
VpnClientRootCertificate para gateway de rede virtual.
VpnClientRootCertificate []
VpnClientRevokedCertificate
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades do certificado de cliente VPN revogado do gateway de rede virtual
VpnClientRevokedCertificatePropertiesFormat
Nome
Descrição
Valor
provisioningState
Obtém ou define o estado de provisionamento do recurso de certificado revogado pelo cliente VPN atualizando/excluindo/falha
corda
Impressão digital
Obtém ou define a impressão digital do certificado do cliente Vpn revogada
corda
VpnClientRootCertificate
Nome
Descrição
Valor
etag
Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado
corda
id
ID do recurso
corda
nome
Obtém o nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso
corda
Propriedades
Propriedades de certificados SSL do gateway de aplicativo
VpnClientRootCertificatePropertiesFormat
Nome
Descrição
Valor
provisioningState
Obtém ou define o estado de provisionamento do recurso de certificado raiz do cliente VPN Atualizando/excluindo/falha
corda
publicCertData
Obtém ou define os dados públicos do certificado
corda