Microsoft.Network virtualNetworkGateways 2016-09-01
Artikel 12/21/2024
2 inzenders
Feedback
In dit artikel
Bicep-resourcedefinitie
Het resourcetype virtualNetworkGateways kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigen voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Resource Microsoft.Network/virtualNetworkGateways wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2016-09-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
activeActive: bool
bgpSettings: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
enableBgp: bool
gatewayDefaultSite: {
id: 'string'
}
gatewayType: 'string'
ipConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
privateIPAllocationMethod: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
resourceGuid: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
vpnClientConfiguration: {
vpnClientAddressPool: {
addressPrefixes: [
'string'
]
}
vpnClientRevokedCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
thumbprint: 'string'
}
}
]
vpnClientRootCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
publicCertData: 'string'
}
}
]
}
vpnType: 'string'
}
tags: {
{customized property}: 'string'
}
}
Eigenschapswaarden
AddressSpace
Naam
Beschrijving
Waarde
addressPrefixes
Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
tekenreeks[]
BgpSettings
Naam
Beschrijving
Waarde
Asn
De ASN van de BGP-spreker.
Int
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
snaar
peerWeight
Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.
Int
Microsoft.Network/virtualNetworkGateways
Naam
Beschrijving
Waarde
etag
Hiermee haalt u een unieke alleen-lezen tekenreeks op die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
plaats
Resourcelocatie.
snaar
naam
De resourcenaam
tekenreeks (vereist)
Eigenschappen
Eigenschappen van VirtualNetworkGateway
VirtualNetworkGatewayPropertiesFormat (vereist)
Tags
Resourcetags
Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
SubResource
Naam
Beschrijving
Waarde
legitimatiebewijs
Resource-id.
snaar
VirtualNetworkGatewayIPConfiguration
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van VirtualNetworkGatewayIPConfiguration
VirtualNetworkGatewayIPConfigurationPropertiesFormat
Naam
Beschrijving
Waarde
privateIPAllocationMethod
De privé-IP-toewijzingsmethode. Mogelijke waarden zijn: 'Statisch' en 'Dynamisch'.
'Dynamisch' 'Statisch'
publicIPAddress
De verwijzing naar de openbare IP-resource.
SubResource (vereist)
Subnet
De verwijzing naar de subnetresource.
SubResource (vereist)
Naam
Beschrijving
Waarde
activeActive
ActiveActive-vlag
Bool
bgpSettings
De BGP-sprekerinstellingen van de virtuele netwerkgateway.
BgpSettings
enableBgp
Of BGP is ingeschakeld voor deze virtuele netwerkgateway of niet.
Bool
gatewayDefaultSite
De verwijzing van de LocalNetworkGateway-resource die staat voor de lokale netwerksite met standaardroutes. Wijs null-waarde toe in het geval dat bestaande standaardsite-instelling wordt verwijderd.
SubResource-
gatewayType
Het type van deze virtuele netwerkgateway. Mogelijke waarden zijn: Vpn en ExpressRoute.
'ExpressRoute' Vpn (vereist)
ipConfigurations
IP-configuraties voor virtuele netwerkgateway.
VirtualNetworkGatewayIPConfiguration [] (vereist)
resourceGuid
De resource-GUID-eigenschap van de VirtualNetworkGateway-resource.
snaar
Sku
De verwijzing naar de VirtualNetworkGatewaySku-resource die de SKU vertegenwoordigt die is geselecteerd voor de virtuele netwerkgateway.
VirtualNetworkGatewaySku
vpnClientConfiguration
De verwijzing naar de VpnClientConfiguration-resource die de P2S VpnClient-configuraties vertegenwoordigt.
VpnClientConfiguration-
vpnType
Het type van deze virtuele netwerkgateway. Mogelijke waarden zijn: 'PolicyBased' en 'RouteBased'.
'PolicyBased' 'RouteBased' (vereist)
VirtualNetworkGatewaySku
Naam
Beschrijving
Waarde
capaciteit
De capaciteit.
Int
naam
Naam van gateway-SKU. Mogelijke waarden zijn: Basic, HighPerformance,Standard en UltraPerformance.
'Basis' 'HighPerformance' 'Standaard' 'UltraPerformance' (vereist)
rang
Gateway-SKU-laag. Mogelijke waarden zijn: Basic, HighPerformance,Standard en UltraPerformance.
'Basis' 'HighPerformance' 'Standaard' 'UltraPerformance' (vereist)
VpnClientConfiguration
Naam
Beschrijving
Waarde
vpnClientAddressPool
De verwijzing naar de adresruimteresource die de adresruimte voor P2S VpnClient vertegenwoordigt.
AddressSpace
vpnClientRevokedCertificates
VpnClientRevokedCertificate voor virtuele netwerkgateway.
VpnClientRevokedCertificate []
vpnClientRootCertificates
VpnClientRootCertificate voor virtuele netwerkgateway.
VpnClientRootCertificate []
VpnClientRevokedCertificate
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van het ingetrokken VPN-clientcertificaat van de virtuele netwerkgateway.
VpnClientRevokedCertificatePropertiesFormat
Naam
Beschrijving
Waarde
Vingerafdruk
De vingerafdruk van het ingetrokken VPN-clientcertificaat.
snaar
VpnClientRootCertificate
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van SSL-certificaten van application gateway
VpnClientRootCertificatePropertiesFormat (vereist)
Naam
Beschrijving
Waarde
publicCertData
De openbare certificaatgegevens.
tekenreeks (vereist)
Quickstart-voorbeelden
In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.
Resourcedefinitie van ARM-sjabloon
Het resourcetype virtualNetworkGateways kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigen voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.Network/virtualNetworkGateways-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Network/virtualNetworkGateways",
"apiVersion": "2016-09-01",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"activeActive": "bool",
"bgpSettings": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"enableBgp": "bool",
"gatewayDefaultSite": {
"id": "string"
},
"gatewayType": "string",
"ipConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"privateIPAllocationMethod": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
],
"resourceGuid": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"vpnClientConfiguration": {
"vpnClientAddressPool": {
"addressPrefixes": [ "string" ]
},
"vpnClientRevokedCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"thumbprint": "string"
}
}
],
"vpnClientRootCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"publicCertData": "string"
}
}
]
},
"vpnType": "string"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschapswaarden
AddressSpace
Naam
Beschrijving
Waarde
addressPrefixes
Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
tekenreeks[]
BgpSettings
Naam
Beschrijving
Waarde
Asn
De ASN van de BGP-spreker.
Int
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
snaar
peerWeight
Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.
Int
Microsoft.Network/virtualNetworkGateways
Naam
Beschrijving
Waarde
apiVersion
De API-versie
'2016-09-01'
etag
Hiermee haalt u een unieke alleen-lezen tekenreeks op die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
plaats
Resourcelocatie.
snaar
naam
De resourcenaam
tekenreeks (vereist)
Eigenschappen
Eigenschappen van VirtualNetworkGateway
VirtualNetworkGatewayPropertiesFormat (vereist)
Tags
Resourcetags
Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type
Het resourcetype
'Microsoft.Network/virtualNetworkGateways'
SubResource
Naam
Beschrijving
Waarde
legitimatiebewijs
Resource-id.
snaar
VirtualNetworkGatewayIPConfiguration
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van VirtualNetworkGatewayIPConfiguration
VirtualNetworkGatewayIPConfigurationPropertiesFormat
Naam
Beschrijving
Waarde
privateIPAllocationMethod
De privé-IP-toewijzingsmethode. Mogelijke waarden zijn: 'Statisch' en 'Dynamisch'.
'Dynamisch' 'Statisch'
publicIPAddress
De verwijzing naar de openbare IP-resource.
SubResource (vereist)
Subnet
De verwijzing naar de subnetresource.
SubResource (vereist)
Naam
Beschrijving
Waarde
activeActive
ActiveActive-vlag
Bool
bgpSettings
De BGP-sprekerinstellingen van de virtuele netwerkgateway.
BgpSettings
enableBgp
Of BGP is ingeschakeld voor deze virtuele netwerkgateway of niet.
Bool
gatewayDefaultSite
De verwijzing van de LocalNetworkGateway-resource die staat voor de lokale netwerksite met standaardroutes. Wijs null-waarde toe in het geval dat bestaande standaardsite-instelling wordt verwijderd.
SubResource-
gatewayType
Het type van deze virtuele netwerkgateway. Mogelijke waarden zijn: Vpn en ExpressRoute.
'ExpressRoute' Vpn (vereist)
ipConfigurations
IP-configuraties voor virtuele netwerkgateway.
VirtualNetworkGatewayIPConfiguration [] (vereist)
resourceGuid
De resource-GUID-eigenschap van de VirtualNetworkGateway-resource.
snaar
Sku
De verwijzing naar de VirtualNetworkGatewaySku-resource die de SKU vertegenwoordigt die is geselecteerd voor de virtuele netwerkgateway.
VirtualNetworkGatewaySku
vpnClientConfiguration
De verwijzing naar de VpnClientConfiguration-resource die de P2S VpnClient-configuraties vertegenwoordigt.
VpnClientConfiguration-
vpnType
Het type van deze virtuele netwerkgateway. Mogelijke waarden zijn: 'PolicyBased' en 'RouteBased'.
'PolicyBased' 'RouteBased' (vereist)
VirtualNetworkGatewaySku
Naam
Beschrijving
Waarde
capaciteit
De capaciteit.
Int
naam
Naam van gateway-SKU. Mogelijke waarden zijn: Basic, HighPerformance,Standard en UltraPerformance.
'Basis' 'HighPerformance' 'Standaard' 'UltraPerformance' (vereist)
rang
Gateway-SKU-laag. Mogelijke waarden zijn: Basic, HighPerformance,Standard en UltraPerformance.
'Basis' 'HighPerformance' 'Standaard' 'UltraPerformance' (vereist)
VpnClientConfiguration
Naam
Beschrijving
Waarde
vpnClientAddressPool
De verwijzing naar de adresruimteresource die de adresruimte voor P2S VpnClient vertegenwoordigt.
AddressSpace
vpnClientRevokedCertificates
VpnClientRevokedCertificate voor virtuele netwerkgateway.
VpnClientRevokedCertificate []
vpnClientRootCertificates
VpnClientRootCertificate voor virtuele netwerkgateway.
VpnClientRootCertificate []
VpnClientRevokedCertificate
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van het ingetrokken VPN-clientcertificaat van de virtuele netwerkgateway.
VpnClientRevokedCertificatePropertiesFormat
Naam
Beschrijving
Waarde
Vingerafdruk
De vingerafdruk van het ingetrokken VPN-clientcertificaat.
snaar
VpnClientRootCertificate
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van SSL-certificaten van application gateway
VpnClientRootCertificatePropertiesFormat (vereist)
Naam
Beschrijving
Waarde
publicCertData
De openbare certificaatgegevens.
tekenreeks (vereist)
Quickstart-sjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
Het resourcetype virtualNetworkGateways kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigen voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.Network/virtualNetworkGateways-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualNetworkGateways@2016-09-01"
name = "string"
etag = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
activeActive = bool
bgpSettings = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
enableBgp = bool
gatewayDefaultSite = {
id = "string"
}
gatewayType = "string"
ipConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
privateIPAllocationMethod = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
resourceGuid = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
vpnClientConfiguration = {
vpnClientAddressPool = {
addressPrefixes = [
"string"
]
}
vpnClientRevokedCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
thumbprint = "string"
}
}
]
vpnClientRootCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
publicCertData = "string"
}
}
]
}
vpnType = "string"
}
})
}
Eigenschapswaarden
AddressSpace
Naam
Beschrijving
Waarde
addressPrefixes
Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
tekenreeks[]
BgpSettings
Naam
Beschrijving
Waarde
Asn
De ASN van de BGP-spreker.
Int
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
snaar
peerWeight
Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.
Int
Microsoft.Network/virtualNetworkGateways
Naam
Beschrijving
Waarde
etag
Hiermee haalt u een unieke alleen-lezen tekenreeks op die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
plaats
Resourcelocatie.
snaar
naam
De resourcenaam
tekenreeks (vereist)
Eigenschappen
Eigenschappen van VirtualNetworkGateway
VirtualNetworkGatewayPropertiesFormat (vereist)
Tags
Resourcetags
Woordenlijst met tagnamen en -waarden.
type
Het resourcetype
"Microsoft.Network/virtualNetworkGateways@2016-09-01"
SubResource
Naam
Beschrijving
Waarde
legitimatiebewijs
Resource-id.
snaar
VirtualNetworkGatewayIPConfiguration
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van VirtualNetworkGatewayIPConfiguration
VirtualNetworkGatewayIPConfigurationPropertiesFormat
Naam
Beschrijving
Waarde
privateIPAllocationMethod
De privé-IP-toewijzingsmethode. Mogelijke waarden zijn: 'Statisch' en 'Dynamisch'.
'Dynamisch' 'Statisch'
publicIPAddress
De verwijzing naar de openbare IP-resource.
SubResource (vereist)
Subnet
De verwijzing naar de subnetresource.
SubResource (vereist)
Naam
Beschrijving
Waarde
activeActive
ActiveActive-vlag
Bool
bgpSettings
De BGP-sprekerinstellingen van de virtuele netwerkgateway.
BgpSettings
enableBgp
Of BGP is ingeschakeld voor deze virtuele netwerkgateway of niet.
Bool
gatewayDefaultSite
De verwijzing van de LocalNetworkGateway-resource die staat voor de lokale netwerksite met standaardroutes. Wijs null-waarde toe in het geval dat bestaande standaardsite-instelling wordt verwijderd.
SubResource-
gatewayType
Het type van deze virtuele netwerkgateway. Mogelijke waarden zijn: Vpn en ExpressRoute.
'ExpressRoute' Vpn (vereist)
ipConfigurations
IP-configuraties voor virtuele netwerkgateway.
VirtualNetworkGatewayIPConfiguration [] (vereist)
resourceGuid
De resource-GUID-eigenschap van de VirtualNetworkGateway-resource.
snaar
Sku
De verwijzing naar de VirtualNetworkGatewaySku-resource die de SKU vertegenwoordigt die is geselecteerd voor de virtuele netwerkgateway.
VirtualNetworkGatewaySku
vpnClientConfiguration
De verwijzing naar de VpnClientConfiguration-resource die de P2S VpnClient-configuraties vertegenwoordigt.
VpnClientConfiguration-
vpnType
Het type van deze virtuele netwerkgateway. Mogelijke waarden zijn: 'PolicyBased' en 'RouteBased'.
'PolicyBased' 'RouteBased' (vereist)
VirtualNetworkGatewaySku
Naam
Beschrijving
Waarde
capaciteit
De capaciteit.
Int
naam
Naam van gateway-SKU. Mogelijke waarden zijn: Basic, HighPerformance,Standard en UltraPerformance.
'Basis' 'HighPerformance' 'Standaard' 'UltraPerformance' (vereist)
rang
Gateway-SKU-laag. Mogelijke waarden zijn: Basic, HighPerformance,Standard en UltraPerformance.
'Basis' 'HighPerformance' 'Standaard' 'UltraPerformance' (vereist)
VpnClientConfiguration
Naam
Beschrijving
Waarde
vpnClientAddressPool
De verwijzing naar de adresruimteresource die de adresruimte voor P2S VpnClient vertegenwoordigt.
AddressSpace
vpnClientRevokedCertificates
VpnClientRevokedCertificate voor virtuele netwerkgateway.
VpnClientRevokedCertificate []
vpnClientRootCertificates
VpnClientRootCertificate voor virtuele netwerkgateway.
VpnClientRootCertificate []
VpnClientRevokedCertificate
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van het ingetrokken VPN-clientcertificaat van de virtuele netwerkgateway.
VpnClientRevokedCertificatePropertiesFormat
Naam
Beschrijving
Waarde
Vingerafdruk
De vingerafdruk van het ingetrokken VPN-clientcertificaat.
snaar
VpnClientRootCertificate
Naam
Beschrijving
Waarde
etag
Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
snaar
legitimatiebewijs
Resource-id.
snaar
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
snaar
Eigenschappen
Eigenschappen van SSL-certificaten van application gateway
VpnClientRootCertificatePropertiesFormat (vereist)
Naam
Beschrijving
Waarde
publicCertData
De openbare certificaatgegevens.
tekenreeks (vereist)