Microsoft.Network vpnSites
Artikel 05/07/2024
1 inzender
Feedback
In dit artikel
Bicep-resourcedefinitie
Het resourcetype vpnSites kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.Network/vpnSites-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Network/vpnSites@2023-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
}
}
}
]
}
}
Eigenschapswaarden
vpnSites
Naam
Description
Waarde
naam
De resourcenaam
tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes. Begin met alfanumeriek. Einde alfanumeriek of onderstrepingsteken.
location
Resourcelocatie.
tekenreeks
tags
Resourcetags.
Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties
Eigenschappen van de VPN-site.
VpnSiteProperties
VpnSiteProperties
Naam
Description
Waarde
addressSpace
De AddressSpace die een matrix van IP-adresbereiken bevat.
AddressSpace
bgpEigenschappen
De set bgp-eigenschappen.
BgpSettings
deviceEigenschappen
De apparaateigenschappen.
DeviceProperties
ipAddress
Het IP-adres voor de vpn-site.
tekenreeks
isSecuritySite
IsSecuritySite-vlag.
booleaans
o365Policy
Office365-beleid.
O365PolicyProperties
siteKey
De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.
tekenreeks
virtualWan
De VirtualWAN waartoe de vpnSite behoort.
Subresource
vpnSiteLinks
Lijst met alle VPN-sitekoppelingen.
VpnSiteLink []
AddressSpace
Naam
Description
Waarde
addressPrefixes
Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
tekenreeks[]
BgpSettings
Naam
Description
Waarde
Asn
De ASN van de BGP-luidspreker.
int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 4294967295
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-luidspreker.
tekenreeks
bgpPeeringAddresses
BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.
IPConfigurationBgpPeeringAddress []
peerWeight
Het gewicht dat is toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.
int
IPConfigurationBgpPeeringAddress
Naam
Description
Waarde
customBgpIpAddresses
De lijst met aangepaste BGP-peeringadressen die deel uitmaken van de IP-configuratie.
tekenreeks[]
ipconfigurationId
De id van de IP-configuratie die bij de gateway hoort.
tekenreeks
DeviceProperties
Naam
Description
Waarde
deviceModel
Model van het apparaat.
tekenreeks
deviceVendor
Naam van de leverancier van het apparaat.
tekenreeks
linkSpeedInMbps
Koppelingssnelheid.
int
O365PolicyProperties
O365BreakOutCategoryPolicies
Naam
Description
Waarde
Toestaan
Vlag om de toegestane categorie te beheren.
booleaans
standaardinstelling
Vlag om de standaardcategorie te beheren.
booleaans
Optimaliseren
Vlag om de optimalisatiecategorie te beheren.
booleaans
SubResource
Naam
Description
Waarde
id
Resource-id.
tekenreeks
VpnSiteLink
Naam
Description
Waarde
id
Resource-id.
tekenreeks
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
tekenreeks
properties
Eigenschappen van de VPN-sitekoppeling.
VpnSiteLinkProperties
VpnSiteLinkProperties
Naam
Description
Waarde
bgpProperties
De set bgp-eigenschappen.
VpnLinkBgpSettings
Fqdn
FQDN van vpn-site-link.
tekenreeks
ipAddress
Het IP-adres voor de vpn-site-link.
tekenreeks
linkEigenschappen
De eigenschappen van de koppelingsprovider.
VpnLinkProviderProperties
VpnLinkBgpSettings
Naam
Description
Waarde
Asn
De ASN van de BGP-luidspreker.
int
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
tekenreeks
VpnLinkProviderProperties
Naam
Description
Waarde
linkProviderName
Naam van de koppelingsprovider.
tekenreeks
linkSpeedInMbps
Koppelingssnelheid.
int
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
Template
Beschrijving
Maakt Virtual WAN resources
Met deze sjabloon kunt u virtual WAN-resources maken, waaronder Virtual WAN, Virtual Hub, VPN Gateway, VPN-site en een VPN Connecton.
Resourcedefinitie van ARM-sjabloon
Het resourcetype vpnSites kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.Network/vpnSites-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2023-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"
}
}
}
]
}
}
Eigenschapswaarden
vpnSites
Naam
Description
Waarde
type
Het resourcetype
'Microsoft.Network/vpnSites'
apiVersion
De resource-API-versie
'2023-11-01'
naam
De resourcenaam
tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes. Begin met alfanumeriek. Einde alfanumeriek of onderstrepingsteken.
location
Resourcelocatie.
tekenreeks
tags
Resourcetags.
Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties
Eigenschappen van de VPN-site.
VpnSiteProperties
VpnSiteProperties
Naam
Description
Waarde
addressSpace
De AddressSpace die een matrix van IP-adresbereiken bevat.
AddressSpace
bgpEigenschappen
De set bgp-eigenschappen.
BgpSettings
deviceEigenschappen
De apparaateigenschappen.
DeviceProperties
ipAddress
Het IP-adres voor de vpn-site.
tekenreeks
isSecuritySite
IsSecuritySite-vlag.
booleaans
o365Policy
Office365-beleid.
O365PolicyProperties
siteKey
De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.
tekenreeks
virtualWan
De VirtualWAN waartoe de vpnSite behoort.
Subresource
vpnSiteLinks
Lijst met alle VPN-sitekoppelingen.
VpnSiteLink []
AddressSpace
Naam
Description
Waarde
addressPrefixes
Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
tekenreeks[]
BgpSettings
Naam
Description
Waarde
Asn
De ASN van de BGP-luidspreker.
int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 4294967295
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-luidspreker.
tekenreeks
bgpPeeringAddresses
BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.
IPConfigurationBgpPeeringAddress []
peerWeight
Het gewicht dat is toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.
int
IPConfigurationBgpPeeringAddress
Naam
Description
Waarde
customBgpIpAddresses
De lijst met aangepaste BGP-peeringadressen die deel uitmaken van de IP-configuratie.
tekenreeks[]
ipconfigurationId
De id van de IP-configuratie die bij de gateway hoort.
tekenreeks
DeviceProperties
Naam
Description
Waarde
deviceModel
Model van het apparaat.
tekenreeks
deviceVendor
Naam van de leverancier van het apparaat.
tekenreeks
linkSpeedInMbps
Koppelingssnelheid.
int
O365PolicyProperties
O365BreakOutCategoryPolicies
Naam
Description
Waarde
Toestaan
Vlag om de toegestane categorie te beheren.
booleaans
standaardinstelling
Vlag om de standaardcategorie te beheren.
booleaans
Optimaliseren
Vlag om de optimalisatiecategorie te beheren.
booleaans
SubResource
Naam
Description
Waarde
id
Resource-id.
tekenreeks
VpnSiteLink
Naam
Description
Waarde
id
Resource-id.
tekenreeks
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
tekenreeks
properties
Eigenschappen van de VPN-sitekoppeling.
VpnSiteLinkProperties
VpnSiteLinkProperties
Naam
Description
Waarde
bgpProperties
De set bgp-eigenschappen.
VpnLinkBgpSettings
Fqdn
FQDN van vpn-site-link.
tekenreeks
ipAddress
Het IP-adres voor de vpn-site-link.
tekenreeks
linkEigenschappen
De eigenschappen van de koppelingsprovider.
VpnLinkProviderProperties
VpnLinkBgpSettings
Naam
Description
Waarde
Asn
De ASN van de BGP-luidspreker.
int
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
tekenreeks
VpnLinkProviderProperties
Naam
Description
Waarde
linkProviderName
Naam van de koppelingsprovider.
tekenreeks
linkSpeedInMbps
Koppelingssnelheid.
int
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
Template
Beschrijving
Maakt Virtual WAN resources
Met deze sjabloon kunt u virtual WAN-resources maken, waaronder Virtual WAN, Virtual Hub, VPN Gateway, VPN-site en een VPN Connecton.
Het resourcetype vpnSites kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Microsoft.Network/vpnSites-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2023-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
}
}
}
]
}
})
}
Eigenschapswaarden
vpnSites
Naam
Description
Waarde
type
Het resourcetype
"Microsoft.Network/vpnSites@2023-11-01"
naam
De resourcenaam
tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieken, onderstrepingstekens, punten en afbreekstreepjes. Begin met alfanumeriek. Einde alfanumeriek of onderstrepingsteken.
location
Resourcelocatie.
tekenreeks
parent_id
Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep.
tekenreeks (vereist)
tags
Resourcetags.
Woordenlijst met tagnamen en -waarden.
properties
Eigenschappen van de VPN-site.
VpnSiteProperties
VpnSiteProperties
Naam
Description
Waarde
addressSpace
De AddressSpace die een matrix van IP-adresbereiken bevat.
AddressSpace
bgpEigenschappen
De set bgp-eigenschappen.
BgpSettings
deviceEigenschappen
De apparaateigenschappen.
DeviceProperties
ipAddress
Het IP-adres voor de vpn-site.
tekenreeks
isSecuritySite
IsSecuritySite-vlag.
booleaans
o365Policy
Office365-beleid.
O365PolicyProperties
siteKey
De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.
tekenreeks
virtualWan
De VirtualWAN waartoe de vpnSite behoort.
Subresource
vpnSiteLinks
Lijst met alle VPN-sitekoppelingen.
VpnSiteLink []
AddressSpace
Naam
Description
Waarde
addressPrefixes
Een lijst met adresblokken die zijn gereserveerd voor dit virtuele netwerk in CIDR-notatie.
tekenreeks[]
BgpSettings
Naam
Description
Waarde
Asn
De ASN van de BGP-luidspreker.
int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 4294967295
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-luidspreker.
tekenreeks
bgpPeeringAddresses
BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.
IPConfigurationBgpPeeringAddress []
peerWeight
Het gewicht dat is toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.
int
IPConfigurationBgpPeeringAddress
Naam
Description
Waarde
customBgpIpAddresses
De lijst met aangepaste BGP-peeringadressen die deel uitmaken van de IP-configuratie.
tekenreeks[]
ipconfigurationId
De id van de IP-configuratie die bij de gateway hoort.
tekenreeks
DeviceProperties
Naam
Description
Waarde
deviceModel
Model van het apparaat.
tekenreeks
deviceVendor
Naam van de leverancier van het apparaat.
tekenreeks
linkSpeedInMbps
Koppelingssnelheid.
int
O365PolicyProperties
O365BreakOutCategoryPolicies
Naam
Description
Waarde
Toestaan
Vlag om de toegestane categorie te beheren.
booleaans
standaardinstelling
Vlag om de standaardcategorie te beheren.
booleaans
Optimaliseren
Vlag om de optimalisatiecategorie te beheren.
booleaans
SubResource
Naam
Description
Waarde
id
Resource-id.
tekenreeks
VpnSiteLink
Naam
Description
Waarde
id
Resource-id.
tekenreeks
naam
De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
tekenreeks
properties
Eigenschappen van de VPN-sitekoppeling.
VpnSiteLinkProperties
VpnSiteLinkProperties
Naam
Description
Waarde
bgpProperties
De set bgp-eigenschappen.
VpnLinkBgpSettings
Fqdn
FQDN van vpn-site-link.
tekenreeks
ipAddress
Het IP-adres voor de vpn-site-link.
tekenreeks
linkEigenschappen
De eigenschappen van de koppelingsprovider.
VpnLinkProviderProperties
VpnLinkBgpSettings
Naam
Description
Waarde
Asn
De ASN van de BGP-luidspreker.
int
bgpPeeringAddress
Het BGP-peeringadres en de BGP-id van deze BGP-spreker.
tekenreeks
VpnLinkProviderProperties
Naam
Description
Waarde
linkProviderName
Naam van de koppelingsprovider.
tekenreeks
linkSpeedInMbps
Koppelingssnelheid.
int