Partager via

VpnSites Microsoft.Network 2022-05-01

  • Article

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 de ressource

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

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

Valeurs de propriété

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. corde
bgpPeeringAddresses Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP. Int

DeviceProperties

Nom Description Valeur
deviceModel Modèle de l’appareil. corde
deviceVendor Nom du fournisseur de l’appareil. corde
linkSpeedInMbps Vitesse du lien. 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. corde

Microsoft.Network/vpnSites

Nom Description Valeur
emplacement Emplacement des ressources. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du site VPN. vpnSiteProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

O365BreakOutCategoryPolicies

Nom Description Valeur
permettre Indicateur permettant de contrôler la catégorie d’autorisation. Bool
faire défaut Indicateur pour contrôler la catégorie par défaut. Bool
optimiser Indicateur pour contrôler la catégorie d’optimisation. Bool

O365PolicyProperties

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

ResourceTags

Nom Description Valeur

Sous-ressource

Nom Description Valeur
id ID de ressource. corde

VpnLinkBgpSettings

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

VpnLinkProviderProperties

Nom Description Valeur
linkProviderName Nom du fournisseur de liens. corde
linkSpeedInMbps Vitesse du lien. Int
Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés 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 du vpn-site-link. corde
ipAddress Adresse IP du vpn-site-link. corde
linkProperties Propriétés du fournisseur de liens. VpnLinkProviderProperties

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 site vpn. corde
isSecuritySite Indicateur IsSecuritySite. Bool
o365Policy Stratégie Office365. O365PolicyProperties
siteKey Clé pour vpn-site qui peut être utilisée pour les connexions. corde
virtualWan VirtualWAN auquel appartient le vpnSite. SubResource
vpnSiteLinks Liste de tous les liens de site vpn. vpnSiteLink[]

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
crée des ressources Virtual WAN Ce modèle vous permet de créer des ressources virtual WAN, notamment Virtual WAN, Virtual Hub, passerelle VPN, site VPN et connexion VPN.

Définition de ressource 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 de ressource

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

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

Valeurs de propriété

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. corde
bgpPeeringAddresses Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP. Int

DeviceProperties

Nom Description Valeur
deviceModel Modèle de l’appareil. corde
deviceVendor Nom du fournisseur de l’appareil. corde
linkSpeedInMbps Vitesse du lien. 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. corde

Microsoft.Network/vpnSites

Nom Description Valeur
apiVersion Version de l’API '2022-05-01'
emplacement Emplacement des ressources. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du site VPN. vpnSiteProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Network/vpnSites'

O365BreakOutCategoryPolicies

Nom Description Valeur
permettre Indicateur permettant de contrôler la catégorie d’autorisation. Bool
faire défaut Indicateur pour contrôler la catégorie par défaut. Bool
optimiser Indicateur pour contrôler la catégorie d’optimisation. Bool

O365PolicyProperties

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

ResourceTags

Nom Description Valeur

Sous-ressource

Nom Description Valeur
id ID de ressource. corde

VpnLinkBgpSettings

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

VpnLinkProviderProperties

Nom Description Valeur
linkProviderName Nom du fournisseur de liens. corde
linkSpeedInMbps Vitesse du lien. Int
Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés 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 du vpn-site-link. corde
ipAddress Adresse IP du vpn-site-link. corde
linkProperties Propriétés du fournisseur de liens. VpnLinkProviderProperties

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 site vpn. corde
isSecuritySite Indicateur IsSecuritySite. Bool
o365Policy Stratégie Office365. O365PolicyProperties
siteKey Clé pour vpn-site qui peut être utilisée pour les connexions. corde
virtualWan VirtualWAN auquel appartient le vpnSite. SubResource
vpnSiteLinks Liste de tous les liens de site vpn. vpnSiteLink[]

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 virtual WAN, 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 de ressource

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

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

Valeurs de propriété

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. corde
bgpPeeringAddresses Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel. IPConfigurationBgpPeeringAddress[]
peerWeight Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP. Int

DeviceProperties

Nom Description Valeur
deviceModel Modèle de l’appareil. corde
deviceVendor Nom du fournisseur de l’appareil. corde
linkSpeedInMbps Vitesse du lien. 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. corde

Microsoft.Network/vpnSites

Nom Description Valeur
emplacement Emplacement des ressources. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du site VPN. vpnSiteProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Network/vpnSites@2022-05-01 »

O365BreakOutCategoryPolicies

Nom Description Valeur
permettre Indicateur permettant de contrôler la catégorie d’autorisation. Bool
faire défaut Indicateur pour contrôler la catégorie par défaut. Bool
optimiser Indicateur pour contrôler la catégorie d’optimisation. Bool

O365PolicyProperties

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

ResourceTags

Nom Description Valeur

Sous-ressource

Nom Description Valeur
id ID de ressource. corde

VpnLinkBgpSettings

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

VpnLinkProviderProperties

Nom Description Valeur
linkProviderName Nom du fournisseur de liens. corde
linkSpeedInMbps Vitesse du lien. Int
Nom Description Valeur
id ID de ressource. corde
nom Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource. corde
Propriétés 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 du vpn-site-link. corde
ipAddress Adresse IP du vpn-site-link. corde
linkProperties Propriétés du fournisseur de liens. VpnLinkProviderProperties

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 site vpn. corde
isSecuritySite Indicateur IsSecuritySite. Bool
o365Policy Stratégie Office365. O365PolicyProperties
siteKey Clé pour vpn-site qui peut être utilisée pour les connexions. corde
virtualWan VirtualWAN auquel appartient le vpnSite. SubResource
vpnSiteLinks Liste de tous les liens de site vpn. vpnSiteLink[]