Freigeben über


Microsoft.Network vpnSites 2021-03-01

Bicep-Ressourcendefinition

Der Ressourcentyp vpnSites kann mit Vorgängen bereitgestellt werden, die folgendes zielten:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/vpnSites-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

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

Eigenschaftswerte

vpnSites

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen, Unterstriche, Punkte und Bindestriche.

Beginnen Sie mit einem alphanumerischen Zeichen. Enden Sie mit einem alphanumerischen Zeichen oder einem Unterstrich.
location Ressourcenspeicherort Zeichenfolge
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties Eigenschaften des VPN-Standorts. VpnSiteProperties

VpnSiteProperties

Name BESCHREIBUNG Wert
addressSpace Der AddressSpace, der 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 den VPN-Standort. Zeichenfolge
isSecuritySite IsSecuritySite-Flag. bool
o365Policy Office365-Richtlinie. O365PolicyProperties
siteKey Der Schlüssel für vpn-site, der für Verbindungen verwendet werden kann. Zeichenfolge
virtualWan Der VirtualWAN, zu dem die vpnSite gehört. Subresource
vpnSiteLinks Liste aller VPN-Site-Links. VpnSiteLink[]

AddressSpace

Name BESCHREIBUNG Wert
addressPrefixes Eine Liste der Adressblöcke, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind. string[]

BgpSettings

Name BESCHREIBUNG Wert
Asn Asn des BGP-Lautsprechers. INT

Einschränkungen:
Min-Wert = 0
Max. Wert = 4294967295
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Sprechers. Zeichenfolge
bgpPeeringAddresses BGP-Peeringadresse mit IP-Konfigurations-ID für das Gateway für virtuelle Netzwerke. IPConfigurationBgpPeeringAddress[]
peerWeight Die Gewichtung der Routen, die von diesem BGP-Lautsprecher gelernt wurden. INT

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. Zeichenfolge

DeviceProperties

Name BESCHREIBUNG Wert
deviceModel Gerätemodell Zeichenfolge
deviceVendor Name des Geräteherstellers. Zeichenfolge
linkSpeedInMbps Linkgeschwindigkeit. INT

O365PolicyProperties

Name BESCHREIBUNG Wert
breakOutCategories Office365-Breakoutkategorien. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Name BESCHREIBUNG Wert
allow Kennzeichnen, um die Kategorie zulassen zu steuern. bool
default Kennzeichnen, um die Standardkategorie zu steuern. bool
optimize Kennzeichnen, um die Kategorie optimieren zu steuern. bool

Subresource

Name BESCHREIBUNG Wert
id Ressourcen-ID Zeichenfolge
Name BESCHREIBUNG Wert
id Ressourcen-ID Zeichenfolge
name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge
properties Eigenschaften des VPN-Standortlinks. VpnSiteLinkProperties

VpnSiteLinkProperties

Name BESCHREIBUNG Wert
bgpProperties Der Satz von bgp-Eigenschaften. VpnLinkBgpSettings
fqdn FQDN von vpn-site-link. Zeichenfolge
ipAddress Die IP-Adresse für den vpn-site-link. Zeichenfolge
linkProperties Die Eigenschaften des Linkanbieters. VpnLinkProviderProperties

VpnLinkBgpSettings

Name BESCHREIBUNG Wert
Asn Asn des BGP-Lautsprechers. INT
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Sprechers. Zeichenfolge

VpnLinkProviderProperties

Name BESCHREIBUNG Wert
linkProviderName Name des Linkanbieters. Zeichenfolge
linkSpeedInMbps Linkgeschwindigkeit. INT

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellt Virtual WAN Ressourcen

Bereitstellen in Azure
Mit dieser Vorlage können Sie Virtual WAN-Ressourcen erstellen, einschließlich Virtual WAN, Virtual Hub, VPN Gateway, VPN-Standort und einer VPN-Verbindung.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp vpnSites kann mit Vorgängen bereitgestellt werden, die folgendes zielten:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/vpnSites-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

vpnSites

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.Network/vpnSites"
apiVersion Die Ressourcen-API-Version '2021-03-01'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen, Unterstriche, Punkte und Bindestriche.

Beginnen Sie mit einem alphanumerischen Zeichen. Enden Sie mit einem alphanumerischen Zeichen oder einem Unterstrich.
location Ressourcenspeicherort Zeichenfolge
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties Eigenschaften des VPN-Standorts. VpnSiteProperties

VpnSiteProperties

Name BESCHREIBUNG Wert
addressSpace Der AddressSpace, der 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 den VPN-Standort. Zeichenfolge
isSecuritySite IsSecuritySite-Flag. bool
o365Policy Office365-Richtlinie. O365PolicyProperties
siteKey Der Schlüssel für vpn-site, der für Verbindungen verwendet werden kann. Zeichenfolge
virtualWan Der VirtualWAN, zu dem die vpnSite gehört. Subresource
vpnSiteLinks Liste aller VPN-Site-Links. VpnSiteLink[]

AddressSpace

Name BESCHREIBUNG Wert
addressPrefixes Eine Liste der Adressblöcke, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind. string[]

BgpSettings

Name BESCHREIBUNG Wert
Asn Asn des BGP-Lautsprechers. INT

Einschränkungen:
Min-Wert = 0
Max. Wert = 4294967295
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Sprechers. Zeichenfolge
bgpPeeringAddresses BGP-Peeringadresse mit IP-Konfigurations-ID für das Gateway für virtuelle Netzwerke. IPConfigurationBgpPeeringAddress[]
peerWeight Die Gewichtung, die den Routen hinzugefügt wurde, die von diesem BGP-Sprecher gelernt wurden. INT

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. Zeichenfolge

DeviceProperties

Name BESCHREIBUNG Wert
deviceModel Gerätemodell Zeichenfolge
deviceVendor Name des Geräteherstellers. Zeichenfolge
linkSpeedInMbps Linkgeschwindigkeit. INT

O365PolicyProperties

Name BESCHREIBUNG Wert
breakOutCategories Office365-Breakoutkategorien. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Name BESCHREIBUNG Wert
allow Flag zum Steuern der Kategorie zulassen. bool
default Flag zum Steuern der Standardkategorie. bool
optimize Flag zum Steuern der Optimierungskategorie. bool

Subresource

Name BESCHREIBUNG Wert
id Ressourcen-ID Zeichenfolge
Name BESCHREIBUNG Wert
id Ressourcen-ID Zeichenfolge
name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge
properties Eigenschaften des VPN-Standortlinks. VpnSiteLinkProperties

VpnSiteLinkProperties

Name BESCHREIBUNG Wert
bgpProperties Der Satz von bgp-Eigenschaften. VpnLinkBgpSettings
fqdn FQDN von vpn-site-link. Zeichenfolge
ipAddress Die IP-Adresse für vpn-site-link. Zeichenfolge
linkProperties Die Eigenschaften des Linkanbieters. VpnLinkProviderProperties

VpnLinkBgpSettings

Name BESCHREIBUNG Wert
Asn Die ASN des BGP-Sprechers. INT
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Sprechers. Zeichenfolge

VpnLinkProviderProperties

Name BESCHREIBUNG Wert
linkProviderName Name des Linkanbieters. Zeichenfolge
linkSpeedInMbps Linkgeschwindigkeit. INT

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellt Virtual WAN Ressourcen

Bereitstellen in Azure
Mit dieser Vorlage können Sie virtuelle WAN-Ressourcen erstellen, einschließlich Virtual WAN, Virtual Hub, VPN Gateway, VPN-Standort und vpn Connecton.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp vpnSites kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/vpnSites-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Terraform hinzu.

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

Eigenschaftswerte

vpnSites

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Network/vpnSites@2021-03-01"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen, Unterstriche, Punkte und Bindestriche.

Beginnen Sie mit einem alphanumerischen Zeichen. Enden Sie mit einem alphanumerischen Zeichen oder einem Unterstrich.
location Ressourcenspeicherort Zeichenfolge
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte.
properties Eigenschaften des VPN-Standorts. VpnSiteProperties

VpnSiteProperties

Name BESCHREIBUNG Wert
addressSpace Der AddressSpace, der 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 den VPN-Standort. Zeichenfolge
isSecuritySite IsSecuritySite-Flag. bool
o365Policy Office365-Richtlinie. O365PolicyProperties
siteKey Der Schlüssel für vpn-site, der für Verbindungen verwendet werden kann. Zeichenfolge
virtualWan Der VirtualWAN, zu dem die vpnSite gehört. Subresource
vpnSiteLinks Liste aller VPN-Standortlinks. VpnSiteLink[]

AddressSpace

Name BESCHREIBUNG Wert
addressPrefixes Eine Liste der Adressblöcke, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind. string[]

BgpSettings

Name BESCHREIBUNG Wert
Asn Die ASN des BGP-Sprechers. INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Sprechers. Zeichenfolge
bgpPeeringAddresses BGP-Peeringadresse mit IP-Konfigurations-ID für das Gateway für virtuelle Netzwerke. IPConfigurationBgpPeeringAddress[]
peerWeight Die Gewichtung, die den Routen hinzugefügt wurde, die von diesem BGP-Sprecher gelernt wurden. INT

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. Zeichenfolge

DeviceProperties

Name BESCHREIBUNG Wert
deviceModel Gerätemodell Zeichenfolge
deviceVendor Name des Geräteherstellers. Zeichenfolge
linkSpeedInMbps Linkgeschwindigkeit. INT

O365PolicyProperties

Name BESCHREIBUNG Wert
breakOutCategories Office365-Breakoutkategorien. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Name BESCHREIBUNG Wert
allow Flag zum Steuern der Kategorie zulassen. bool
default Flag zum Steuern der Standardkategorie. bool
optimize Flag zum Steuern der Optimierungskategorie. bool

Subresource

Name BESCHREIBUNG Wert
id Ressourcen-ID Zeichenfolge
Name BESCHREIBUNG Wert
id Ressourcen-ID Zeichenfolge
name Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden. Zeichenfolge
properties Eigenschaften des VPN-Standortlinks. VpnSiteLinkProperties

VpnSiteLinkProperties

Name BESCHREIBUNG Wert
bgpProperties Der Satz von bgp-Eigenschaften. VpnLinkBgpSettings
fqdn FQDN von vpn-site-link. Zeichenfolge
ipAddress Die IP-Adresse für vpn-site-link. Zeichenfolge
linkProperties Die Eigenschaften des Linkanbieters. VpnLinkProviderProperties

VpnLinkBgpSettings

Name BESCHREIBUNG Wert
Asn Die ASN des BGP-Sprechers. INT
bgpPeeringAddress Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Sprechers. Zeichenfolge

VpnLinkProviderProperties

Name BESCHREIBUNG Wert
linkProviderName Name des Linkanbieters. Zeichenfolge
linkSpeedInMbps Linkgeschwindigkeit. INT