Partager via


Microsoft.Network vpnSites 2020-11-01

Définition de ressource Bicep

Le type de ressource vpnSites peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Network/vpnSites, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

vpnSites

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par un caractère alphanumérique. Doit se terminer par un caractère alphanumérique ou un trait de soulignement.
location Emplacement de la ressource. string
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du site VPN. VpnSiteProperties

VpnSiteProperties

Nom Description Valeur
addressSpace AddressSpace qui contient un tableau de plages d’adresses IP. AddressSpace
bgpProperties Ensemble de propriétés bgp. BgpSettings
deviceProperties Propriétés de l’appareil. DeviceProperties
ipAddress Adresse IP du vpn-site. string
isSecuritySite Indicateur IsSecuritySite. bool
o365Policy Stratégie Office365. O365PolicyProperties
siteKey Clé pour vpn-site qui peut être utilisée pour les connexions. string
virtualWan VirtualWAN auquel le vpnSite appartient. Sous-ressource
vpnSiteLinks Liste de tous les liens de site VPN. VpnSiteLink[]

AddressSpace

Nom Description Valeur
addressPrefixes Liste des blocs d’adresses réservés à ce réseau virtuel en notation CIDR. string[]

BgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. int

Contraintes :
Valeur minimale = 0
Valeur maximale = 4294967295
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. string
bgpPeeringAddresses Adresse de peering BGP avec ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Le poids ajouté aux itinéraires appris à partir de cet orateur BGP. int

IPConfigurationBgpPeeringAddress

Nom Description Valeur
customBgpIpAddresses Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP. string[]
ipconfigurationId ID de la configuration IP qui appartient à la passerelle. string

DeviceProperties

Nom Description Valeur
deviceModel Modèle de l’appareil. string
deviceVendor Nom du fournisseur de l’appareil. string
linkSpeedInMbps Vitesse de liaison. int

O365PolicyProperties

Nom Description Valeur
breakOutCategories Catégories en petits groupes Office365. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Nom Description Valeur
allow Indicateur pour contrôler la catégorie d’autorisation. bool
default Indicateur pour contrôler la catégorie par défaut. bool
optimize Indicateur pour contrôler la catégorie d’optimisation. bool

Sous-ressource

Nom Description Valeur
id ID de la ressource string
Nom Description Valeur
id ID de la ressource string
name Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. string
properties Propriétés du lien de site VPN. VpnSiteLinkProperties

VpnSiteLinkProperties

Nom Description Valeur
bgpProperties Ensemble de propriétés bgp. VpnLinkBgpSettings
fqdn Nom de domaine complet de vpn-site-link. string
ipAddress Adresse IP du vpn-site-link. string
linkProperties Propriétés du fournisseur de liens. VpnLinkProviderProperties

VpnLinkBgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. int
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. string

VpnLinkProviderProperties

Nom Description Valeur
linkProviderName Nom du fournisseur de liens. string
linkSpeedInMbps Vitesse de liaison. int

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Crée des ressources Virtual WAN

Déployer sur Azure
Ce modèle vous permet de créer des ressources WAN virtuelles, notamment Virtual WAN, Virtual Hub, passerelle VPN, site VPN et connexion VPN.

Définition de ressources de modèle ARM

Le type de ressource vpnSites peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Network/vpnSites, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

vpnSites

Nom Description Valeur
type Type de ressource « Microsoft.Network/vpnSites »
apiVersion Version de l’API de ressource '2020-11-01'
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par un caractère alphanumérique. Doit se terminer par un caractère alphanumérique ou un trait de soulignement.
location Emplacement de la ressource. string
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du site VPN. VpnSiteProperties

VpnSiteProperties

Nom Description Valeur
addressSpace AddressSpace qui contient un tableau de plages d’adresses IP. AddressSpace
bgpProperties Ensemble de propriétés bgp. BgpSettings
deviceProperties Propriétés de l’appareil. DeviceProperties
ipAddress Adresse IP du vpn-site. string
isSecuritySite Indicateur IsSecuritySite. bool
o365Policy Stratégie Office365. O365PolicyProperties
siteKey Clé pour vpn-site qui peut être utilisée pour les connexions. string
virtualWan VirtualWAN auquel le vpnSite appartient. Sous-ressource
vpnSiteLinks Liste de tous les liens de site VPN. VpnSiteLink[]

AddressSpace

Nom Description Valeur
addressPrefixes Liste des blocs d’adresses réservés à ce réseau virtuel en notation CIDR. string[]

BgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. int

Contraintes :
Valeur minimale = 0
Valeur maximale = 4294967295
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. string
bgpPeeringAddresses Adresse de peering BGP avec ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris par ce haut-parleur BGP. int

IPConfigurationBgpPeeringAddress

Nom Description Valeur
customBgpIpAddresses Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP. string[]
ipconfigurationId ID de la configuration IP qui appartient à la passerelle. string

DeviceProperties

Nom Description Valeur
deviceModel Modèle de l’appareil. string
deviceVendor Nom du fournisseur de l’appareil. string
linkSpeedInMbps Vitesse de liaison. int

O365PolicyProperties

Nom Description Valeur
breakOutCategories Catégories de petits groupes Office365. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Nom Description Valeur
allow Indicateur permettant de contrôler la catégorie d’autorisation. bool
default Indicateur pour contrôler la catégorie par défaut. bool
optimize Indicateur pour contrôler la catégorie d’optimisation. bool

SubResource

Nom Description Valeur
id ID de la ressource string
Nom Description Valeur
id ID de la ressource string
name Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. string
properties Propriétés du lien de site VPN. VpnSiteLinkProperties

VpnSiteLinkProperties

Nom Description Valeur
bgpProperties Ensemble de propriétés bgp. VpnLinkBgpSettings
fqdn Nom de domaine complet de vpn-site-link. string
ipAddress Adresse ip pour vpn-site-link. string
linkProperties Propriétés du fournisseur de liens. VpnLinkProviderProperties

VpnLinkBgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. int
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de ce haut-parleur BGP. string

VpnLinkProviderProperties

Nom Description Valeur
linkProviderName Nom du fournisseur de liens. string
linkSpeedInMbps Vitesse de liaison. int

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Crée des ressources Virtual WAN

Déployer sur Azure
Ce modèle vous permet de créer des ressources WAN virtuelles, notamment Virtual WAN, Virtual Hub, passerelle VPN, site VPN et connexion VPN.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource vpnSites peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Network/vpnSites, ajoutez le Terraform suivant à votre modèle.

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

Valeurs de propriétés

vpnSites

Nom Description Valeur
type Type de ressource « Microsoft.Network/vpnSites@2020-11-01 »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques, traits de soulignement, points et traits d’union.

Doit commencer par un caractère alphanumérique. Doit se terminer par un caractère alphanumérique ou un trait de soulignement.
location Emplacement de la ressource. string
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés du site VPN. VpnSiteProperties

VpnSiteProperties

Nom Description Valeur
addressSpace AddressSpace qui contient un tableau de plages d’adresses IP. AddressSpace
bgpProperties Ensemble de propriétés bgp. BgpSettings
deviceProperties Propriétés de l’appareil. DeviceProperties
ipAddress Adresse IP du vpn-site. string
isSecuritySite Indicateur IsSecuritySite. bool
o365Policy Stratégie Office365. O365PolicyProperties
siteKey Clé pour vpn-site qui peut être utilisée pour les connexions. string
virtualWan VirtualWAN auquel le vpnSite appartient. Sous-ressource
vpnSiteLinks Liste de tous les liens de site VPN. VpnSiteLink[]

AddressSpace

Nom Description Valeur
addressPrefixes Liste des blocs d’adresses réservés à ce réseau virtuel en notation CIDR. string[]

BgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. int

Contraintes :
Valeur minimale = 0
Valeur maximale = 4294967295
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. string
bgpPeeringAddresses Adresse de peering BGP avec ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Le poids ajouté aux itinéraires appris à partir de cet orateur BGP. int

IPConfigurationBgpPeeringAddress

Nom Description Valeur
customBgpIpAddresses Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP. string[]
ipconfigurationId ID de la configuration IP qui appartient à la passerelle. string

DeviceProperties

Nom Description Valeur
deviceModel Modèle de l’appareil. string
deviceVendor Nom du fournisseur de l’appareil. string
linkSpeedInMbps Vitesse de liaison. int

O365PolicyProperties

Nom Description Valeur
breakOutCategories Catégories en petits groupes Office365. O365BreakOutCategoryPolicies

O365BreakOutCategoryPolicies

Nom Description Valeur
allow Indicateur pour contrôler la catégorie d’autorisation. bool
default Indicateur pour contrôler la catégorie par défaut. bool
optimize Indicateur pour contrôler la catégorie d’optimisation. bool

Sous-ressource

Nom Description Valeur
id ID de la ressource string
Nom Description Valeur
id ID de la ressource string
name Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. string
properties Propriétés du lien de site VPN. VpnSiteLinkProperties

VpnSiteLinkProperties

Nom Description Valeur
bgpProperties Ensemble de propriétés bgp. VpnLinkBgpSettings
fqdn Nom de domaine complet de vpn-site-link. string
ipAddress Adresse IP du vpn-site-link. string
linkProperties Propriétés du fournisseur de liens. VpnLinkProviderProperties

VpnLinkBgpSettings

Nom Description Valeur
Asn ASN de l’orateur BGP. int
bgpPeeringAddress Adresse de peering BGP et identificateur BGP de cet orateur BGP. string

VpnLinkProviderProperties

Nom Description Valeur
linkProviderName Nom du fournisseur de liens. string
linkSpeedInMbps Vitesse de liaison. int