Microsoft.Network/vpnSites 2022-09-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep-resourcedefinitie

Het resourcetype vpnSites kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Network/vpnSites-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Network/vpnSites@2022-09-01' = {
  location: 'string'
  name: 'string'
  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
          }
        }
      }
    ]
  }
  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 Beperkingen: Minimumwaarde = 0 Maximumwaarde = 4294967295
bgpPeeringAddress	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.	snaar
bgpPeeringAddresses	BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.	Int

DeviceProperties

Naam	Beschrijving	Waarde
deviceModel	Model van het apparaat.	snaar
deviceVendor	Naam van de leverancier van het apparaat.	snaar
linkSpeedInMbps	Snelheid van koppeling.	Int

IPConfigurationBgpPeeringAddress

Naam	Beschrijving	Waarde
customBgpIpAddresses	De lijst met aangepaste BGP-peeringadressen die deel uitmaken van ip-configuratie.	tekenreeks[]
ipconfigurationId	De id van de IP-configuratie die deel uitmaakt van de gateway.	snaar

Microsoft.Network/vpnSites

Naam	Beschrijving	Waarde
plaats	Resourcelocatie.	snaar
naam	De resourcenaam	tekenreeks (vereist)
Eigenschappen	Eigenschappen van de VPN-site.	VpnSiteProperties-
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

O365BreakOutCategoryPolicies

Naam	Beschrijving	Waarde
toestaan	Vlag om de categorie Toestaan te beheren.	Bool
verstek	Vlag om de standaardcategorie te beheren.	Bool
optimaliseren	Vlag om de categorie optimaliseren te beheren.	Bool

O365PolicyProperties

Naam	Beschrijving	Waarde
breakOutCategorieën	Aparte categorieën voor Office365.	O365BreakOutCategoryPolicies

ResourceTags

Naam	Beschrijving	Waarde

SubResource

Naam	Beschrijving	Waarde
legitimatiebewijs	Resource-id.	snaar

VpnLinkBgpSettings

Naam	Beschrijving	Waarde
Asn	De ASN van de BGP-spreker.	Int
bgpPeeringAddress	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.	snaar

VpnLinkProviderProperties

Naam	Beschrijving	Waarde
linkProviderName	Naam van de koppelingsprovider.	snaar
linkSpeedInMbps	Snelheid van koppeling.	Int

VpnSiteLink

Naam	Beschrijving	Waarde
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 de VPN-sitekoppeling.	VpnSiteLinkProperties-

VpnSiteLinkProperties

Naam	Beschrijving	Waarde
bgpProperties	De set bgp-eigenschappen.	VpnLinkBgpSettings
Fqdn	FQDN van vpn-site-link.	snaar
ipAddress	Het IP-adres voor de vpn-site-link.	snaar
linkProperties	De eigenschappen van de koppelingsprovider.	VpnLinkProviderProperties-

VpnSiteProperties

Naam	Beschrijving	Waarde
addressSpace	De AddressSpace die een matrix met IP-adresbereiken bevat.	AddressSpace
bgpProperties	De set bgp-eigenschappen.	BgpSettings
deviceProperties	De apparaateigenschappen.	DeviceProperties-
ipAddress	Het IP-adres voor de vpn-site.	snaar
isSecuritySite	IsSecuritySite-vlag.	Bool
o365Policy	Office365-beleid.	O365PolicyProperties-
siteKey	De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.	snaar
virtualWan	De VirtualWAN waartoe de vpnSite behoort.	SubResource-
vpnSiteLinks	Lijst met alle vpn-sitekoppelingen.	VpnSiteLink[]

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand	Beschrijving
Virtual WAN-resources maken	Met deze sjabloon kunt u virtuele 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:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Network/vpnSites-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Network/vpnSites",
  "apiVersion": "2022-09-01",
  "name": "string",
  "location": "string",
  "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"
          }
        }
      }
    ]
  },
  "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 Beperkingen: Minimumwaarde = 0 Maximumwaarde = 4294967295
bgpPeeringAddress	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.	snaar
bgpPeeringAddresses	BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.	Int

DeviceProperties

Naam	Beschrijving	Waarde
deviceModel	Model van het apparaat.	snaar
deviceVendor	Naam van de leverancier van het apparaat.	snaar
linkSpeedInMbps	Snelheid van koppeling.	Int

IPConfigurationBgpPeeringAddress

Naam	Beschrijving	Waarde
customBgpIpAddresses	De lijst met aangepaste BGP-peeringadressen die deel uitmaken van ip-configuratie.	tekenreeks[]
ipconfigurationId	De id van de IP-configuratie die deel uitmaakt van de gateway.	snaar

Microsoft.Network/vpnSites

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2022-09-01'
plaats	Resourcelocatie.	snaar
naam	De resourcenaam	tekenreeks (vereist)
Eigenschappen	Eigenschappen van de VPN-site.	VpnSiteProperties-
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type	Het resourcetype	'Microsoft.Network/vpnSites'

O365BreakOutCategoryPolicies

Naam	Beschrijving	Waarde
toestaan	Vlag om de categorie Toestaan te beheren.	Bool
verstek	Vlag om de standaardcategorie te beheren.	Bool
optimaliseren	Vlag om de categorie optimaliseren te beheren.	Bool

O365PolicyProperties

Naam	Beschrijving	Waarde
breakOutCategorieën	Aparte categorieën voor Office365.	O365BreakOutCategoryPolicies

ResourceTags

Naam	Beschrijving	Waarde

SubResource

Naam	Beschrijving	Waarde
legitimatiebewijs	Resource-id.	snaar

VpnLinkBgpSettings

Naam	Beschrijving	Waarde
Asn	De ASN van de BGP-spreker.	Int
bgpPeeringAddress	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.	snaar

VpnLinkProviderProperties

Naam	Beschrijving	Waarde
linkProviderName	Naam van de koppelingsprovider.	snaar
linkSpeedInMbps	Snelheid van koppeling.	Int

VpnSiteLink

Naam	Beschrijving	Waarde
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 de VPN-sitekoppeling.	VpnSiteLinkProperties-

VpnSiteLinkProperties

Naam	Beschrijving	Waarde
bgpProperties	De set bgp-eigenschappen.	VpnLinkBgpSettings
Fqdn	FQDN van vpn-site-link.	snaar
ipAddress	Het IP-adres voor de vpn-site-link.	snaar
linkProperties	De eigenschappen van de koppelingsprovider.	VpnLinkProviderProperties-

VpnSiteProperties

Naam	Beschrijving	Waarde
addressSpace	De AddressSpace die een matrix met IP-adresbereiken bevat.	AddressSpace
bgpProperties	De set bgp-eigenschappen.	BgpSettings
deviceProperties	De apparaateigenschappen.	DeviceProperties-
ipAddress	Het IP-adres voor de vpn-site.	snaar
isSecuritySite	IsSecuritySite-vlag.	Bool
o365Policy	Office365-beleid.	O365PolicyProperties-
siteKey	De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.	snaar
virtualWan	De VirtualWAN waartoe de vpnSite behoort.	SubResource-
vpnSiteLinks	Lijst met alle vpn-sitekoppelingen.	VpnSiteLink[]

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	Beschrijving
Virtual WAN-resources maken	Met deze sjabloon kunt u virtuele WAN-resources maken, waaronder Virtual WAN, Virtual Hub, VPN Gateway, VPN-site en een VPN Connecton.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype vpnSites kan worden geïmplementeerd met bewerkingen die zijn gericht op:

resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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@2022-09-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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

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 Beperkingen: Minimumwaarde = 0 Maximumwaarde = 4294967295
bgpPeeringAddress	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.	snaar
bgpPeeringAddresses	BGP-peeringadres met IP-configuratie-id voor virtuele netwerkgateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	Het gewicht toegevoegd aan routes die zijn geleerd van deze BGP-luidspreker.	Int

DeviceProperties

Naam	Beschrijving	Waarde
deviceModel	Model van het apparaat.	snaar
deviceVendor	Naam van de leverancier van het apparaat.	snaar
linkSpeedInMbps	Snelheid van koppeling.	Int

IPConfigurationBgpPeeringAddress

Naam	Beschrijving	Waarde
customBgpIpAddresses	De lijst met aangepaste BGP-peeringadressen die deel uitmaken van ip-configuratie.	tekenreeks[]
ipconfigurationId	De id van de IP-configuratie die deel uitmaakt van de gateway.	snaar

Microsoft.Network/vpnSites

Naam	Beschrijving	Waarde
plaats	Resourcelocatie.	snaar
naam	De resourcenaam	tekenreeks (vereist)
Eigenschappen	Eigenschappen van de VPN-site.	VpnSiteProperties-
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden.
type	Het resourcetype	"Microsoft.Network/vpnSites@2022-09-01"

O365BreakOutCategoryPolicies

Naam	Beschrijving	Waarde
toestaan	Vlag om de categorie Toestaan te beheren.	Bool
verstek	Vlag om de standaardcategorie te beheren.	Bool
optimaliseren	Vlag om de categorie optimaliseren te beheren.	Bool

O365PolicyProperties

Naam	Beschrijving	Waarde
breakOutCategorieën	Aparte categorieën voor Office365.	O365BreakOutCategoryPolicies

ResourceTags

Naam	Beschrijving	Waarde

SubResource

Naam	Beschrijving	Waarde
legitimatiebewijs	Resource-id.	snaar

VpnLinkBgpSettings

Naam	Beschrijving	Waarde
Asn	De ASN van de BGP-spreker.	Int
bgpPeeringAddress	Het BGP-peeringadres en de BGP-id van deze BGP-spreker.	snaar

VpnLinkProviderProperties

Naam	Beschrijving	Waarde
linkProviderName	Naam van de koppelingsprovider.	snaar
linkSpeedInMbps	Snelheid van koppeling.	Int

VpnSiteLink

Naam	Beschrijving	Waarde
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 de VPN-sitekoppeling.	VpnSiteLinkProperties-

VpnSiteLinkProperties

Naam	Beschrijving	Waarde
bgpProperties	De set bgp-eigenschappen.	VpnLinkBgpSettings
Fqdn	FQDN van vpn-site-link.	snaar
ipAddress	Het IP-adres voor de vpn-site-link.	snaar
linkProperties	De eigenschappen van de koppelingsprovider.	VpnLinkProviderProperties-

VpnSiteProperties

Naam	Beschrijving	Waarde
addressSpace	De AddressSpace die een matrix met IP-adresbereiken bevat.	AddressSpace
bgpProperties	De set bgp-eigenschappen.	BgpSettings
deviceProperties	De apparaateigenschappen.	DeviceProperties-
ipAddress	Het IP-adres voor de vpn-site.	snaar
isSecuritySite	IsSecuritySite-vlag.	Bool
o365Policy	Office365-beleid.	O365PolicyProperties-
siteKey	De sleutel voor vpn-site die kan worden gebruikt voor verbindingen.	snaar
virtualWan	De VirtualWAN waartoe de vpnSite behoort.	SubResource-
vpnSiteLinks	Lijst met alle vpn-sitekoppelingen.	VpnSiteLink[]

Delen via

Microsoft.Network vpnSites 2022-09-01

Bicep-resourcedefinitie

Resource-indeling

Eigenschapswaarden

AddressSpace

BgpSettings

DeviceProperties

IPConfigurationBgpPeeringAddress

Microsoft.Network/vpnSites

O365BreakOutCategoryPolicies

O365PolicyProperties

ResourceTags

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSiteLink

VpnSiteLinkProperties

VpnSiteProperties

Quickstart-voorbeelden

Resourcedefinitie van ARM-sjabloon

Resource-indeling

Eigenschapswaarden

AddressSpace

BgpSettings

DeviceProperties

IPConfigurationBgpPeeringAddress

Microsoft.Network/vpnSites

O365BreakOutCategoryPolicies

O365PolicyProperties

ResourceTags

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSiteLink

VpnSiteLinkProperties

VpnSiteProperties

Quickstart-sjablonen

Resourcedefinitie van Terraform (AzAPI-provider)

Resource-indeling

Eigenschapswaarden

AddressSpace

BgpSettings

DeviceProperties

IPConfigurationBgpPeeringAddress

Microsoft.Network/vpnSites

O365BreakOutCategoryPolicies

O365PolicyProperties

ResourceTags

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSiteLink

VpnSiteLinkProperties

VpnSiteProperties

Feedback

Aanvullende resources