Microsoft.Network vpnSites
Artikel 12/19/2024
2 Mitwirkende
Feedback
In diesem Artikel
Bicep-Ressourcendefinition
Der Ressourcentyp "vpnSites" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll .
Um eine Microsoft.Network/vpnSites-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Network/vpnSites@2024-05-01' = {
location: 'string'
name: 'string'
properties: {
addressSpace: {
addressPrefixes: [
'string'
]
ipamPoolPrefixAllocations: [
{
numberOfIpAddresses: 'string'
pool: {
id: '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'
}
}
Eigenschaftswerte
AddressSpace
Name
Beschreibung
Wert
addressPrefixes
Eine Liste von Adressblöcken, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind.
string[]
ipamPoolPrefixAllocations
Eine Liste der IPAM-Pools, die IP-Adresspräfixe zuordnen.
IpamPoolPrefixAllocation []
BgpSettings
Name
Beschreibung
Wert
asn
Der ASN des BGP-Sprechers.
Int Zwänge: Min.-Wert = 0 Max. Wert = 4294967295
bgpPeeringAddress
Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
Schnur
bgpPeeringAddresses
BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway.
IPConfigurationBgpPeeringAddress []
PeerWeight
Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden.
Int
DeviceProperties
Name
Beschreibung
Wert
deviceModel
Modell des Geräts.
Schnur
deviceVendor
Name des Geräteanbieters.
Schnur
linkSpeedInMbps
Verbindungsgeschwindigkeit.
Int
IpamPoolPrefixAllocation
IpamPoolPrefixAllocationPool
Name
Beschreibung
Wert
id
Ressourcen-ID der zugeordneten Azure IpamPool-Ressource.
Schnur
IPConfigurationBgpPeeringAddress
Name
Beschreibung
Wert
customBgpIpAddresses
Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören.
string[]
ipconfigurationId
Die ID der IP-Konfiguration, die zum Gateway gehört.
Schnur
Microsoft.Network/vpnSites
Name
Beschreibung
Wert
Ort
Ressourcenspeicherort.
Schnur
Name
Der Ressourcenname
Zeichenfolge (erforderlich)
Eigenschaften
Eigenschaften des VPN-Standorts.
VpnSiteProperties-
Schilder
Ressourcentags
Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
O365BreakOutCategoryPolicies
Name
Beschreibung
Wert
erlauben
Kennzeichnung zum Steuern der Zulässigen Kategorie.
Bool
Vorgabe
Kennzeichnen, um die Standardkategorie zu steuern.
Bool
optimieren
Kennzeichnen, um die Kategorie zu optimieren.
Bool
O365PolicyProperties
Unterressource
Name
Beschreibung
Wert
id
Ressourcen-ID.
Schnur
VpnLinkBgpSettings
Name
Beschreibung
Wert
asn
Der ASN des BGP-Sprechers.
Int
bgpPeeringAddress
Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
Schnur
VpnLinkProviderProperties
Name
Beschreibung
Wert
linkProviderName
Name des Linkanbieters.
Schnur
linkSpeedInMbps
Verbindungsgeschwindigkeit.
Int
VpnSiteLink
Name
Beschreibung
Wert
id
Ressourcen-ID.
Schnur
Name
Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
Schnur
Eigenschaften
Eigenschaften des VPN-Standortlinks.
VpnSiteLinkProperties-
VpnSiteLinkProperties
Name
Beschreibung
Wert
bgpProperties
Der Satz von bgp-Eigenschaften.
VpnLinkBgpSettings-
fqdn
FQDN von vpn-site-link.
Schnur
ipAddress
Die IP-Adresse für den vpn-site-link.
Schnur
linkProperties
Die Eigenschaften des Verknüpfungsanbieters.
VpnLinkProviderProperties-
VpnSiteProperties
Name
Beschreibung
Wert
addressSpace
AddressSpace, das ein Array von IP-Adressbereichen enthält.
AddressSpace-
bgpProperties
Der Satz von bgp-Eigenschaften.
BgpSettings-
deviceProperties
Die Geräteeigenschaften.
DeviceProperties-
ipAddress
Die IP-Adresse für die vpn-Site.
Schnur
isSecuritySite
IsSecuritySite-Flag.
Bool
o365Policy
Office365-Richtlinie.
O365PolicyProperties
siteKey
Der Schlüssel für vpn-Site, der für Verbindungen verwendet werden kann.
Schnur
virtualWan
Der VirtualWAN, zu dem die vpnSite gehört.
SubResource-
vpnSiteLinks
Liste aller VPN-Websitelinks.
VpnSiteLink- []
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
Bicep-Datei
Beschreibung
erstellt virtuelle WAN-Ressourcen
Mit dieser Vorlage können Sie virtuelle WAN-Ressourcen erstellen, einschließlich Virtual WAN, Virtual Hub, VPN-Gateway, VPN-Standort und vpn Connecton.
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "vpnSites" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll .
Um eine Microsoft.Network/vpnSites-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2024-05-01",
"name": "string",
"location": "string",
"properties": {
"addressSpace": {
"addressPrefixes": [ "string" ],
"ipamPoolPrefixAllocations": [
{
"numberOfIpAddresses": "string",
"pool": {
"id": "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"
}
}
Eigenschaftswerte
AddressSpace
Name
Beschreibung
Wert
addressPrefixes
Eine Liste von Adressblöcken, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind.
string[]
ipamPoolPrefixAllocations
Eine Liste der IPAM-Pools, die IP-Adresspräfixe zuordnen.
IpamPoolPrefixAllocation []
BgpSettings
Name
Beschreibung
Wert
asn
Der ASN des BGP-Sprechers.
Int Zwänge: Min.-Wert = 0 Max. Wert = 4294967295
bgpPeeringAddress
Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
Schnur
bgpPeeringAddresses
BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway.
IPConfigurationBgpPeeringAddress []
PeerWeight
Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden.
Int
DeviceProperties
Name
Beschreibung
Wert
deviceModel
Modell des Geräts.
Schnur
deviceVendor
Name des Geräteanbieters.
Schnur
linkSpeedInMbps
Verbindungsgeschwindigkeit.
Int
IpamPoolPrefixAllocation
IpamPoolPrefixAllocationPool
Name
Beschreibung
Wert
id
Ressourcen-ID der zugeordneten Azure IpamPool-Ressource.
Schnur
IPConfigurationBgpPeeringAddress
Name
Beschreibung
Wert
customBgpIpAddresses
Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören.
string[]
ipconfigurationId
Die ID der IP-Konfiguration, die zum Gateway gehört.
Schnur
Microsoft.Network/vpnSites
Name
Beschreibung
Wert
apiVersion
Die API-Version
'2024-05-01'
Ort
Ressourcenspeicherort.
Schnur
Name
Der Ressourcenname
Zeichenfolge (erforderlich)
Eigenschaften
Eigenschaften des VPN-Standorts.
VpnSiteProperties-
Schilder
Ressourcentags
Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art
Der Ressourcentyp
"Microsoft.Network/vpnSites"
O365BreakOutCategoryPolicies
Name
Beschreibung
Wert
erlauben
Kennzeichnung zum Steuern der Zulässigen Kategorie.
Bool
Vorgabe
Kennzeichnen, um die Standardkategorie zu steuern.
Bool
optimieren
Kennzeichnen, um die Kategorie zu optimieren.
Bool
O365PolicyProperties
Unterressource
Name
Beschreibung
Wert
id
Ressourcen-ID.
Schnur
VpnLinkBgpSettings
Name
Beschreibung
Wert
asn
Der ASN des BGP-Sprechers.
Int
bgpPeeringAddress
Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
Schnur
VpnLinkProviderProperties
Name
Beschreibung
Wert
linkProviderName
Name des Linkanbieters.
Schnur
linkSpeedInMbps
Verbindungsgeschwindigkeit.
Int
VpnSiteLink
Name
Beschreibung
Wert
id
Ressourcen-ID.
Schnur
Name
Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
Schnur
Eigenschaften
Eigenschaften des VPN-Standortlinks.
VpnSiteLinkProperties-
VpnSiteLinkProperties
Name
Beschreibung
Wert
bgpProperties
Der Satz von bgp-Eigenschaften.
VpnLinkBgpSettings-
fqdn
FQDN von vpn-site-link.
Schnur
ipAddress
Die IP-Adresse für den vpn-site-link.
Schnur
linkProperties
Die Eigenschaften des Verknüpfungsanbieters.
VpnLinkProviderProperties-
VpnSiteProperties
Name
Beschreibung
Wert
addressSpace
AddressSpace, das ein Array von IP-Adressbereichen enthält.
AddressSpace-
bgpProperties
Der Satz von bgp-Eigenschaften.
BgpSettings-
deviceProperties
Die Geräteeigenschaften.
DeviceProperties-
ipAddress
Die IP-Adresse für die vpn-Site.
Schnur
isSecuritySite
IsSecuritySite-Flag.
Bool
o365Policy
Office365-Richtlinie.
O365PolicyProperties
siteKey
Der Schlüssel für vpn-Site, der für Verbindungen verwendet werden kann.
Schnur
virtualWan
Der VirtualWAN, zu dem die vpnSite gehört.
SubResource-
vpnSiteLinks
Liste aller VPN-Websitelinks.
VpnSiteLink- []
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
Schablone
Beschreibung
erstellt virtuelle WAN-Ressourcen
Mit dieser Vorlage können Sie virtuelle WAN-Ressourcen erstellen, einschließlich Virtual WAN, Virtual Hub, VPN-Gateway, VPN-Standort und vpn Connecton.
Der Ressourcentyp "vpnSites" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll .
Um eine Microsoft.Network/vpnSites-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2024-05-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
addressSpace = {
addressPrefixes = [
"string"
]
ipamPoolPrefixAllocations = [
{
numberOfIpAddresses = "string"
pool = {
id = "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
}
}
}
]
}
})
}
Eigenschaftswerte
AddressSpace
Name
Beschreibung
Wert
addressPrefixes
Eine Liste von Adressblöcken, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind.
string[]
ipamPoolPrefixAllocations
Eine Liste der IPAM-Pools, die IP-Adresspräfixe zuordnen.
IpamPoolPrefixAllocation []
BgpSettings
Name
Beschreibung
Wert
asn
Der ASN des BGP-Sprechers.
Int Zwänge: Min.-Wert = 0 Max. Wert = 4294967295
bgpPeeringAddress
Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
Schnur
bgpPeeringAddresses
BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway.
IPConfigurationBgpPeeringAddress []
PeerWeight
Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden.
Int
DeviceProperties
Name
Beschreibung
Wert
deviceModel
Modell des Geräts.
Schnur
deviceVendor
Name des Geräteanbieters.
Schnur
linkSpeedInMbps
Verbindungsgeschwindigkeit.
Int
IpamPoolPrefixAllocation
IpamPoolPrefixAllocationPool
Name
Beschreibung
Wert
id
Ressourcen-ID der zugeordneten Azure IpamPool-Ressource.
Schnur
IPConfigurationBgpPeeringAddress
Name
Beschreibung
Wert
customBgpIpAddresses
Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören.
string[]
ipconfigurationId
Die ID der IP-Konfiguration, die zum Gateway gehört.
Schnur
Microsoft.Network/vpnSites
Name
Beschreibung
Wert
Ort
Ressourcenspeicherort.
Schnur
Name
Der Ressourcenname
Zeichenfolge (erforderlich)
Eigenschaften
Eigenschaften des VPN-Standorts.
VpnSiteProperties-
Schilder
Ressourcentags
Wörterbuch der Tagnamen und -werte.
Art
Der Ressourcentyp
"Microsoft.Network/vpnSites@2024-05-01"
O365BreakOutCategoryPolicies
Name
Beschreibung
Wert
erlauben
Kennzeichnung zum Steuern der Zulässigen Kategorie.
Bool
Vorgabe
Kennzeichnen, um die Standardkategorie zu steuern.
Bool
optimieren
Kennzeichnen, um die Kategorie zu optimieren.
Bool
O365PolicyProperties
Unterressource
Name
Beschreibung
Wert
id
Ressourcen-ID.
Schnur
VpnLinkBgpSettings
Name
Beschreibung
Wert
asn
Der ASN des BGP-Sprechers.
Int
bgpPeeringAddress
Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
Schnur
VpnLinkProviderProperties
Name
Beschreibung
Wert
linkProviderName
Name des Linkanbieters.
Schnur
linkSpeedInMbps
Verbindungsgeschwindigkeit.
Int
VpnSiteLink
Name
Beschreibung
Wert
id
Ressourcen-ID.
Schnur
Name
Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
Schnur
Eigenschaften
Eigenschaften des VPN-Standortlinks.
VpnSiteLinkProperties-
VpnSiteLinkProperties
Name
Beschreibung
Wert
bgpProperties
Der Satz von bgp-Eigenschaften.
VpnLinkBgpSettings-
fqdn
FQDN von vpn-site-link.
Schnur
ipAddress
Die IP-Adresse für den vpn-site-link.
Schnur
linkProperties
Die Eigenschaften des Verknüpfungsanbieters.
VpnLinkProviderProperties-
VpnSiteProperties
Name
Beschreibung
Wert
addressSpace
AddressSpace, das ein Array von IP-Adressbereichen enthält.
AddressSpace-
bgpProperties
Der Satz von bgp-Eigenschaften.
BgpSettings-
deviceProperties
Die Geräteeigenschaften.
DeviceProperties-
ipAddress
Die IP-Adresse für die vpn-Site.
Schnur
isSecuritySite
IsSecuritySite-Flag.
Bool
o365Policy
Office365-Richtlinie.
O365PolicyProperties
siteKey
Der Schlüssel für vpn-Site, der für Verbindungen verwendet werden kann.
Schnur
virtualWan
Der VirtualWAN, zu dem die vpnSite gehört.
SubResource-
vpnSiteLinks
Liste aller VPN-Websitelinks.
VpnSiteLink- []