Partager via


Service Microsoft.ApiManagement 2016-10-10

Définition de ressource Bicep

Le type de ressource de service 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.ApiManagement/service, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

AdditionalRegion

Nom Description Valeur
emplacement Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. chaîne (obligatoire)
skuType Type de référence SKU à l’emplacement. 'Développeur'
'Premium'
'Standard' (obligatoire)
skuUnitCount Nombre d’unités de référence SKU à l’emplacement. Le nombre maximal d’unités de référence SKU dépend du SkuType. Le nombre maximal autorisé pour la référence SKU développeur est 1, pour la référence SKU Standard est 4 et pour la référence SKU Premium est 10, à un emplacement. Int

Contraintes:
Valeur maximale = 10
vpnconfiguration Configuration du réseau virtuel pour l’emplacement. virtualNetworkConfiguration

ApiManagementServiceProperties

Nom Description Valeur
additionalLocations Emplacements de centre de données supplémentaires du service Gestion des API. AdditionalRegion[]
addresserEmail Adresse e-mail de l’expéditeur. corde
customProperties Propriétés personnalisées du service Gestion des API, telles que la désactivation de TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuration personnalisée du nom d’hôte du service Gestion des API. HostnameConfiguration[]
publisherEmail E-mail de l’éditeur. corde

Contraintes:
Longueur maximale = (obligatoire)
publisherName Nom du serveur de publication. chaîne (obligatoire)
vpnconfiguration Configuration du réseau virtuel du service Gestion des API. virtualNetworkConfiguration
vpnType Type de VPN dans lequel le service Gestion des API doit être configuré. Aucune (valeur par défaut) signifie que le service Gestion des API ne fait pas partie d’un réseau virtuel, externe signifie que le déploiement gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison accessible sur Internet, et que le déploiement interne de gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison intranet uniquement. 'Externe'
'Interne'
'None'

ApiManagementServicePropertiesCustomProperties

Nom Description Valeur

ApiManagementServiceSkuProperties

Nom Description Valeur
capacité Capacité de la référence SKU (nombre d’unités déployées de la référence SKU). La valeur par défaut est 1. Int
nom Nom de la référence SKU. 'Développeur'
'Premium'
'Standard' (obligatoire)

CertificateInformation

Nom Description Valeur
expiration Date d’expiration du certificat. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601. chaîne (obligatoire)
Objet Objet du certificat. chaîne (obligatoire)
Empreinte Empreinte numérique du certificat. chaîne (obligatoire)

HostnameConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation (obligatoire)
nom d’hôte Nom d’hôte. chaîne (obligatoire)
type Type de nom d’hôte. 'Management'
'Portal'
'Proxy'
'Scm' (obligatoire)

Microsoft.ApiManagement/service

Nom Description Valeur
emplacement Emplacement des ressources. chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire)
Propriétés Propriétés du service Gestion des API. ApiManagementServiceProperties (obligatoire)
Sku Propriétés de référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceTags

Nom Description Valeur

VirtualNetworkConfiguration

Nom Description Valeur
emplacement Emplacement du réseau virtuel. corde
subnetResourceId ID de ressource complet d’un sous-réseau dans un réseau virtuel dans lequel déployer le service Gestion des API. corde

Contraintes:
Modèle = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Exemples de démarrage rapide

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

Fichier Bicep Description
Application Gateway avec gestion des API internes et d’application web Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure.
Créer une instance gestion des API de niveau Premium multirégion Ce modèle montre comment créer une instance Gestion des API avec des emplacements supplémentaires. L’emplacement principal est le même que l’emplacement du groupe de ressources. Pour d’autres emplacements, le modèle affiche NorthCentralUs et USA Est2. L’emplacement principal doit être différent des emplacements supplémentaires.
Créer une instance Gestion des API avec msi Identity Ce modèle crée une instance de développeur de Gestion des API Azure ayant une identité MSI
Créer une instance Gestion des API à l’aide d’un modèle Ce modèle crée une instance de développeur de Gestion des API Azure
Créer un service Gestion des API avec un point de terminaison privé Ce modèle crée un service Gestion des API, un réseau virtuel et un point de terminaison privé exposant le service Gestion des API au réseau virtuel.
Créer un service Gestion des API avec SSL à partir de KeyVault Ce modèle déploie un service Gestion des API configuré avec l’identité affectée par l’utilisateur. Il utilise cette identité pour récupérer le certificat SSL à partir de KeyVault et le maintient à jour en vérifiant toutes les 4 heures.
Créer une gestion des API dans un réseau virtuel interne avec app Gateway Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Déployer gestion des API dans un réseau virtuel externe avec d’adresses IP publiques Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode externe et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
Déployer gestion des API dans un réseau virtuel interne avec d’adresses IP publiques Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode interne et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
déployer la gestion des API dans des zones de disponibilité Ce modèle crée une instance Premium de Gestion des API Azure et se déploie dans une zone de disponibilité
Déployer la gestion des API avec un cache Azure externe pour Redis Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Consommation avec une instance Azure Cache pour Redis externe en tant que cache externe gestion des API.
Front Door Standard/Premium avec l’origine gestion des API Ce modèle crée une instance Front Door Premium et gestion des API et utilise un groupe de sécurité réseau et une stratégie de gestion des API globale pour vérifier que le trafic est passé par l’origine Front Door.

Définition de ressource de modèle ARM

Le type de ressource de service 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.ApiManagement/service, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AdditionalRegion

Nom Description Valeur
emplacement Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. chaîne (obligatoire)
skuType Type de référence SKU à l’emplacement. 'Développeur'
'Premium'
'Standard' (obligatoire)
skuUnitCount Nombre d’unités de référence SKU à l’emplacement. Le nombre maximal d’unités de référence SKU dépend du SkuType. Le nombre maximal autorisé pour la référence SKU développeur est 1, pour la référence SKU Standard est 4 et pour la référence SKU Premium est 10, à un emplacement. Int

Contraintes:
Valeur maximale = 10
vpnconfiguration Configuration du réseau virtuel pour l’emplacement. virtualNetworkConfiguration

ApiManagementServiceProperties

Nom Description Valeur
additionalLocations Emplacements de centre de données supplémentaires du service Gestion des API. AdditionalRegion[]
addresserEmail Adresse e-mail de l’expéditeur. corde
customProperties Propriétés personnalisées du service Gestion des API, telles que la désactivation de TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuration personnalisée du nom d’hôte du service Gestion des API. HostnameConfiguration[]
publisherEmail E-mail de l’éditeur. corde

Contraintes:
Longueur maximale = (obligatoire)
publisherName Nom du serveur de publication. chaîne (obligatoire)
vpnconfiguration Configuration du réseau virtuel du service Gestion des API. virtualNetworkConfiguration
vpnType Type de VPN dans lequel le service Gestion des API doit être configuré. Aucune (valeur par défaut) signifie que le service Gestion des API ne fait pas partie d’un réseau virtuel, externe signifie que le déploiement gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison accessible sur Internet, et que le déploiement interne de gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison intranet uniquement. 'Externe'
'Interne'
'None'

ApiManagementServicePropertiesCustomProperties

Nom Description Valeur

ApiManagementServiceSkuProperties

Nom Description Valeur
capacité Capacité de la référence SKU (nombre d’unités déployées de la référence SKU). La valeur par défaut est 1. Int
nom Nom de la référence SKU. 'Développeur'
'Premium'
'Standard' (obligatoire)

CertificateInformation

Nom Description Valeur
expiration Date d’expiration du certificat. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601. chaîne (obligatoire)
Objet Objet du certificat. chaîne (obligatoire)
Empreinte Empreinte numérique du certificat. chaîne (obligatoire)

HostnameConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation (obligatoire)
nom d’hôte Nom d’hôte. chaîne (obligatoire)
type Type de nom d’hôte. 'Management'
'Portal'
'Proxy'
'Scm' (obligatoire)

Microsoft.ApiManagement/service

Nom Description Valeur
apiVersion Version de l’API '2016-10-10'
emplacement Emplacement des ressources. chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire)
Propriétés Propriétés du service Gestion des API. ApiManagementServiceProperties (obligatoire)
Sku Propriétés de référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.ApiManagement/service'

ResourceTags

Nom Description Valeur

VirtualNetworkConfiguration

Nom Description Valeur
emplacement Emplacement du réseau virtuel. corde
subnetResourceId ID de ressource complet d’un sous-réseau dans un réseau virtuel dans lequel déployer le service Gestion des API. corde

Contraintes:
Modèle = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Modèles de démarrage rapide

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

Modèle Description
Application Gateway avec gestion des API internes et d’application web

Déployer sur Azure
Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure.
Créer une instance gestion des API de niveau Premium multirégion

Déployer sur Azure
Ce modèle montre comment créer une instance Gestion des API avec des emplacements supplémentaires. L’emplacement principal est le même que l’emplacement du groupe de ressources. Pour d’autres emplacements, le modèle affiche NorthCentralUs et USA Est2. L’emplacement principal doit être différent des emplacements supplémentaires.
Créer une instance Gestion des API et toutes les sous-ressources à l’aide d’un modèle

Déployer sur Azure
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer une instance Gestion des API avec msi Identity

Déployer sur Azure
Ce modèle crée une instance de développeur de Gestion des API Azure ayant une identité MSI
Créer une instance Gestion des API à l’aide d’un modèle

Déployer sur Azure
Ce modèle crée une instance de développeur de Gestion des API Azure
Créer une instance Gestion des API avec des noms d’hôte personnalisés

Déployer sur Azure
Ce modèle montre comment créer une instance de Gestion des API Azure avec un nom d’hôte personnalisé pour le portail et plusieurs noms d’hôte personnalisés pour le proxy
Créer un service Gestion des API avec un point de terminaison privé

Déployer sur Azure
Ce modèle crée un service Gestion des API, un réseau virtuel et un point de terminaison privé exposant le service Gestion des API au réseau virtuel.
Créer un service Gestion des API avec SSL à partir de KeyVault

Déployer sur Azure
Ce modèle déploie un service Gestion des API configuré avec l’identité affectée par l’utilisateur. Il utilise cette identité pour récupérer le certificat SSL à partir de KeyVault et le maintient à jour en vérifiant toutes les 4 heures.
créer et surveiller l’instance Gestion des API

Déployer sur Azure
Ce modèle crée une instance du service Gestion des API Azure et de l’espace de travail Log Analytics et configure la surveillance de votre service Gestion des API avec Log Analytics
Créer une gestion des API dans un réseau virtuel interne avec app Gateway

Déployer sur Azure
Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Créer une gestion des API avec ssl proxy personnalisé à l’aide de KeyVault

Déployer sur Azure
Ce modèle montre comment créer une instance de Gestion des API Azure et configurer un nom d’hôte personnalisé pour le proxy avec un certificat ssl à partir de keyvault.
Créer Azure Front Door devant la Gestion des API Azure

Déployer sur Azure
Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Gestion des API Azure.
Déployer gestion des API dans un réseau virtuel externe avec d’adresses IP publiques

Déployer sur Azure
Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode externe et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
Déployer gestion des API dans un réseau virtuel interne avec d’adresses IP publiques

Déployer sur Azure
Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode interne et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
déployer la gestion des API dans des zones de disponibilité

Déployer sur Azure
Ce modèle crée une instance Premium de Gestion des API Azure et se déploie dans une zone de disponibilité
Déployer la gestion des API avec un cache Azure externe pour Redis

Déployer sur Azure
Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Consommation avec une instance Azure Cache pour Redis externe en tant que cache externe gestion des API.
Front Door Standard/Premium avec l’origine gestion des API

Déployer sur Azure
Ce modèle crée une instance Front Door Premium et gestion des API et utilise un groupe de sécurité réseau et une stratégie de gestion des API globale pour vérifier que le trafic est passé par l’origine Front Door.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de service 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.ApiManagement/service, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

Valeurs de propriété

AdditionalRegion

Nom Description Valeur
emplacement Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. chaîne (obligatoire)
skuType Type de référence SKU à l’emplacement. 'Développeur'
'Premium'
'Standard' (obligatoire)
skuUnitCount Nombre d’unités de référence SKU à l’emplacement. Le nombre maximal d’unités de référence SKU dépend du SkuType. Le nombre maximal autorisé pour la référence SKU développeur est 1, pour la référence SKU Standard est 4 et pour la référence SKU Premium est 10, à un emplacement. Int

Contraintes:
Valeur maximale = 10
vpnconfiguration Configuration du réseau virtuel pour l’emplacement. virtualNetworkConfiguration

ApiManagementServiceProperties

Nom Description Valeur
additionalLocations Emplacements de centre de données supplémentaires du service Gestion des API. AdditionalRegion[]
addresserEmail Adresse e-mail de l’expéditeur. corde
customProperties Propriétés personnalisées du service Gestion des API, telles que la désactivation de TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuration personnalisée du nom d’hôte du service Gestion des API. HostnameConfiguration[]
publisherEmail E-mail de l’éditeur. corde

Contraintes:
Longueur maximale = (obligatoire)
publisherName Nom du serveur de publication. chaîne (obligatoire)
vpnconfiguration Configuration du réseau virtuel du service Gestion des API. virtualNetworkConfiguration
vpnType Type de VPN dans lequel le service Gestion des API doit être configuré. Aucune (valeur par défaut) signifie que le service Gestion des API ne fait pas partie d’un réseau virtuel, externe signifie que le déploiement gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison accessible sur Internet, et que le déploiement interne de gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison intranet uniquement. 'Externe'
'Interne'
'None'

ApiManagementServicePropertiesCustomProperties

Nom Description Valeur

ApiManagementServiceSkuProperties

Nom Description Valeur
capacité Capacité de la référence SKU (nombre d’unités déployées de la référence SKU). La valeur par défaut est 1. Int
nom Nom de la référence SKU. 'Développeur'
'Premium'
'Standard' (obligatoire)

CertificateInformation

Nom Description Valeur
expiration Date d’expiration du certificat. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601. chaîne (obligatoire)
Objet Objet du certificat. chaîne (obligatoire)
Empreinte Empreinte numérique du certificat. chaîne (obligatoire)

HostnameConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation (obligatoire)
nom d’hôte Nom d’hôte. chaîne (obligatoire)
type Type de nom d’hôte. 'Management'
'Portal'
'Proxy'
'Scm' (obligatoire)

Microsoft.ApiManagement/service

Nom Description Valeur
emplacement Emplacement des ressources. chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire)
Propriétés Propriétés du service Gestion des API. ApiManagementServiceProperties (obligatoire)
Sku Propriétés de référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.ApiManagement/service@2016-10-10 »

ResourceTags

Nom Description Valeur

VirtualNetworkConfiguration

Nom Description Valeur
emplacement Emplacement du réseau virtuel. corde
subnetResourceId ID de ressource complet d’un sous-réseau dans un réseau virtuel dans lequel déployer le service Gestion des API. corde

Contraintes:
Modèle = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$