Sdílet prostřednictvím


Microsoft.Network vpnSites 2024-05-01

Definice prostředku Bicep

Typ prostředku vpnSites je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Network/vpnSites, přidejte do šablony následující bicep.

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'
  }
}

Hodnoty vlastností

Adresní prostor

Jméno Popis Hodnota
addressPrefixes Seznam bloků adres vyhrazených pro tuto virtuální síť v zápisu CIDR string[]
ipamPoolPrefixAllocations Seznam fondů IPAM, které přidělují předpony IP adres. IpamPoolPrefixAllocation[]

BgpSettings

Jméno Popis Hodnota
Asn ASN mluvčího protokolu BGP. Int

Omezení:
Minimální hodnota = 0
Maximální hodnota = 4294967295
bgpPeeringAddress Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. řetězec
bgpPeeringAddresses Adresa partnerského vztahu protokolu BGP s ID konfigurace PROTOKOLU IP pro bránu virtuální sítě. IPConfigurationBgpPeeringAddress[]
peerWeight Váha přidaná do tras získaných z tohoto mluvčího protokolu BGP. Int

DeviceProperties

Jméno Popis Hodnota
deviceModel Model zařízení řetězec
deviceVendor Název dodavatele zařízení. řetězec
linkSpeedInMbps Rychlost propojení. Int

IpamPoolPrefixAllocation

Jméno Popis Hodnota
numberOfIpAddresses Počet IP adres, které se mají přidělit řetězec
tůň IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

Jméno Popis Hodnota
id ID prostředku přidruženého prostředku Azure IpamPool. řetězec

IPConfigurationBgpPeeringAddress

Jméno Popis Hodnota
customBgpIpAddresses Seznam vlastních adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP. string[]
ipconfigurationId ID konfigurace PROTOKOLU IP, která patří k bráně. řetězec

Microsoft.Network/vpnSites

Jméno Popis Hodnota
umístění Umístění prostředku řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti lokality VPN. VpnSiteProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

O365BreakOutCategoryPolicies

Jméno Popis Hodnota
povolit Příznak pro řízení povolené kategorie. Bool
výchozí Příznak pro řízení výchozí kategorie Bool
optimalizovat Příznak pro řízení kategorie optimalizace Bool

O365PolicyProperties

Jméno Popis Hodnota
breakOutCategories Kategorie breakoutů v Office365 O365BreakOutCategoryPolicies

Značky prostředků

Jméno Popis Hodnota

Podsourc

Jméno Popis Hodnota
id ID prostředku. řetězec

VpnLinkBgpSettings

Jméno Popis Hodnota
Asn ASN mluvčího protokolu BGP. Int
bgpPeeringAddress Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. řetězec

VpnLinkProviderProperties

Jméno Popis Hodnota
linkProviderName Název zprostředkovatele propojení řetězec
linkSpeedInMbps Rychlost propojení. Int
Jméno Popis Hodnota
id ID prostředku. řetězec
Jméno Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku. řetězec
vlastnosti Vlastnosti propojení lokality VPN VpnSiteLinkProperties

VpnSiteLinkProperties

Jméno Popis Hodnota
bgpProperties Sada vlastností protokolu bgp. VpnLinkBgpSettings
Fqdn Plně kvalifikovaný název domény vpn-site-link. řetězec
ipAddress IP adresa pro vpn-site-link. řetězec
linkProperties Vlastnosti zprostředkovatele propojení. vpnLinkProviderProperties

VpnSiteProperties

Jméno Popis Hodnota
addressSpace AddressSpace, který obsahuje pole rozsahů IP adres. AddressSpace
bgpProperties Sada vlastností protokolu bgp. BgpSettings
deviceProperties Vlastnosti zařízení. DeviceProperties
ipAddress IP adresa pro vpn-site. řetězec
isSecuritySite Příznak IsSecuritySite. Bool
o365Policy Zásady Office365 O365PolicyProperties
siteKey Klíč pro vpn-site, který lze použít pro připojení. řetězec
VirtualWan VirtualWAN, do které vpnSite patří. subresource
vpnSiteLinks Seznam všech propojení lokalit vpn VpnSiteLink[]

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ prostředku.

Soubor Bicep Popis
vytváření prostředků virtual WAN Tato šablona umožňuje vytvářet prostředky virtuální sítě WAN, včetně služby Virtual WAN, virtual hubu, brány VPN, lokality VPN a služby VPN Connecton.

Definice prostředku šablony ARM

Typ prostředku vpnSites je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Network/vpnSites, přidejte do šablony následující JSON.

{
  "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"
  }
}

Hodnoty vlastností

Adresní prostor

Jméno Popis Hodnota
addressPrefixes Seznam bloků adres vyhrazených pro tuto virtuální síť v zápisu CIDR string[]
ipamPoolPrefixAllocations Seznam fondů IPAM, které přidělují předpony IP adres. IpamPoolPrefixAllocation[]

BgpSettings

Jméno Popis Hodnota
Asn ASN mluvčího protokolu BGP. Int

Omezení:
Minimální hodnota = 0
Maximální hodnota = 4294967295
bgpPeeringAddress Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. řetězec
bgpPeeringAddresses Adresa partnerského vztahu protokolu BGP s ID konfigurace PROTOKOLU IP pro bránu virtuální sítě. IPConfigurationBgpPeeringAddress[]
peerWeight Váha přidaná do tras získaných z tohoto mluvčího protokolu BGP. Int

DeviceProperties

Jméno Popis Hodnota
deviceModel Model zařízení řetězec
deviceVendor Název dodavatele zařízení. řetězec
linkSpeedInMbps Rychlost propojení. Int

IpamPoolPrefixAllocation

Jméno Popis Hodnota
numberOfIpAddresses Počet IP adres, které se mají přidělit řetězec
tůň IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

Jméno Popis Hodnota
id ID prostředku přidruženého prostředku Azure IpamPool. řetězec

IPConfigurationBgpPeeringAddress

Jméno Popis Hodnota
customBgpIpAddresses Seznam vlastních adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP. string[]
ipconfigurationId ID konfigurace PROTOKOLU IP, která patří k bráně. řetězec

Microsoft.Network/vpnSites

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-05-01'
umístění Umístění prostředku řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti lokality VPN. VpnSiteProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.Network/vpnSites

O365BreakOutCategoryPolicies

Jméno Popis Hodnota
povolit Příznak pro řízení povolené kategorie. Bool
výchozí Příznak pro řízení výchozí kategorie Bool
optimalizovat Příznak pro řízení kategorie optimalizace Bool

O365PolicyProperties

Jméno Popis Hodnota
breakOutCategories Kategorie breakoutů v Office365 O365BreakOutCategoryPolicies

Značky prostředků

Jméno Popis Hodnota

Podsourc

Jméno Popis Hodnota
id ID prostředku. řetězec

VpnLinkBgpSettings

Jméno Popis Hodnota
Asn ASN mluvčího protokolu BGP. Int
bgpPeeringAddress Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. řetězec

VpnLinkProviderProperties

Jméno Popis Hodnota
linkProviderName Název zprostředkovatele propojení řetězec
linkSpeedInMbps Rychlost propojení. Int
Jméno Popis Hodnota
id ID prostředku. řetězec
Jméno Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku. řetězec
vlastnosti Vlastnosti propojení lokality VPN VpnSiteLinkProperties

VpnSiteLinkProperties

Jméno Popis Hodnota
bgpProperties Sada vlastností protokolu bgp. VpnLinkBgpSettings
Fqdn Plně kvalifikovaný název domény vpn-site-link. řetězec
ipAddress IP adresa pro vpn-site-link. řetězec
linkProperties Vlastnosti zprostředkovatele propojení. vpnLinkProviderProperties

VpnSiteProperties

Jméno Popis Hodnota
addressSpace AddressSpace, který obsahuje pole rozsahů IP adres. AddressSpace
bgpProperties Sada vlastností protokolu bgp. BgpSettings
deviceProperties Vlastnosti zařízení. DeviceProperties
ipAddress IP adresa pro vpn-site. řetězec
isSecuritySite Příznak IsSecuritySite. Bool
o365Policy Zásady Office365 O365PolicyProperties
siteKey Klíč pro vpn-site, který lze použít pro připojení. řetězec
VirtualWan VirtualWAN, do které vpnSite patří. subresource
vpnSiteLinks Seznam všech propojení lokalit vpn VpnSiteLink[]

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona Popis
vytváření prostředků virtual WAN

nasazení do Azure
Tato šablona umožňuje vytvářet prostředky virtuální sítě WAN, včetně služby Virtual WAN, virtual hubu, brány VPN, lokality VPN a služby VPN Connecton.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku vpnSites je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Network/vpnSites, přidejte do šablony následující Terraform.

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
            }
          }
        }
      ]
    }
  })
}

Hodnoty vlastností

Adresní prostor

Jméno Popis Hodnota
addressPrefixes Seznam bloků adres vyhrazených pro tuto virtuální síť v zápisu CIDR string[]
ipamPoolPrefixAllocations Seznam fondů IPAM, které přidělují předpony IP adres. IpamPoolPrefixAllocation[]

BgpSettings

Jméno Popis Hodnota
Asn ASN mluvčího protokolu BGP. Int

Omezení:
Minimální hodnota = 0
Maximální hodnota = 4294967295
bgpPeeringAddress Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. řetězec
bgpPeeringAddresses Adresa partnerského vztahu protokolu BGP s ID konfigurace PROTOKOLU IP pro bránu virtuální sítě. IPConfigurationBgpPeeringAddress[]
peerWeight Váha přidaná do tras získaných z tohoto mluvčího protokolu BGP. Int

DeviceProperties

Jméno Popis Hodnota
deviceModel Model zařízení řetězec
deviceVendor Název dodavatele zařízení. řetězec
linkSpeedInMbps Rychlost propojení. Int

IpamPoolPrefixAllocation

Jméno Popis Hodnota
numberOfIpAddresses Počet IP adres, které se mají přidělit řetězec
tůň IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

Jméno Popis Hodnota
id ID prostředku přidruženého prostředku Azure IpamPool. řetězec

IPConfigurationBgpPeeringAddress

Jméno Popis Hodnota
customBgpIpAddresses Seznam vlastních adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP. string[]
ipconfigurationId ID konfigurace PROTOKOLU IP, která patří k bráně. řetězec

Microsoft.Network/vpnSites

Jméno Popis Hodnota
umístění Umístění prostředku řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti lokality VPN. VpnSiteProperties
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.Network/vpnSites@2024-05-01

O365BreakOutCategoryPolicies

Jméno Popis Hodnota
povolit Příznak pro řízení povolené kategorie. Bool
výchozí Příznak pro řízení výchozí kategorie Bool
optimalizovat Příznak pro řízení kategorie optimalizace Bool

O365PolicyProperties

Jméno Popis Hodnota
breakOutCategories Kategorie breakoutů v Office365 O365BreakOutCategoryPolicies

Značky prostředků

Jméno Popis Hodnota

Podsourc

Jméno Popis Hodnota
id ID prostředku. řetězec

VpnLinkBgpSettings

Jméno Popis Hodnota
Asn ASN mluvčího protokolu BGP. Int
bgpPeeringAddress Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. řetězec

VpnLinkProviderProperties

Jméno Popis Hodnota
linkProviderName Název zprostředkovatele propojení řetězec
linkSpeedInMbps Rychlost propojení. Int
Jméno Popis Hodnota
id ID prostředku. řetězec
Jméno Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku. řetězec
vlastnosti Vlastnosti propojení lokality VPN VpnSiteLinkProperties

VpnSiteLinkProperties

Jméno Popis Hodnota
bgpProperties Sada vlastností protokolu bgp. VpnLinkBgpSettings
Fqdn Plně kvalifikovaný název domény vpn-site-link. řetězec
ipAddress IP adresa pro vpn-site-link. řetězec
linkProperties Vlastnosti zprostředkovatele propojení. vpnLinkProviderProperties

VpnSiteProperties

Jméno Popis Hodnota
addressSpace AddressSpace, který obsahuje pole rozsahů IP adres. AddressSpace
bgpProperties Sada vlastností protokolu bgp. BgpSettings
deviceProperties Vlastnosti zařízení. DeviceProperties
ipAddress IP adresa pro vpn-site. řetězec
isSecuritySite Příznak IsSecuritySite. Bool
o365Policy Zásady Office365 O365PolicyProperties
siteKey Klíč pro vpn-site, který lze použít pro připojení. řetězec
VirtualWan VirtualWAN, do které vpnSite patří. subresource
vpnSiteLinks Seznam všech propojení lokalit vpn VpnSiteLink[]