Service Microsoft.ApiManagement

  • Article

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 des ressources

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

resource symbolicname 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: 'string'
        natGatewayState: 'string'
        publicIpAddressId: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
        zones: [
          'string'
        ]
      }
    ]
    apiVersionConstraint: {
      minApiVersion: 'string'
    }
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    configurationApi: {
      legacyApi: 'string'
    }
    customProperties: {
      {customized property}: 'string'
    }
    developerPortalStatus: 'string'
    disableGateway: bool
    enableClientCertificate: bool
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        certificateSource: 'string'
        certificateStatus: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        identityClientId: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    legacyPortalStatus: 'string'
    natGatewayState: 'string'
    notificationSenderEmail: 'string'
    privateEndpointConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
        type: 'string'
      }
    ]
    publicIpAddressId: 'string'
    publicNetworkAccess: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    restore: bool
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  zones: [
    'string'
  ]
}

Valeurs de propriétés

service

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

Limite de caractères : 1-50

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.

Le nom de la ressource doit être unique dans Azure.
location Emplacement de la ressource. chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Propriétés de la référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
identité Identité de service managée du service Gestion des API. ApiManagementServiceIdentity
properties Propriétés du service Gestion des API. ApiManagementServiceProperties (obligatoire)
zones Liste des zones de disponibilité indiquant d’où doit provenir la ressource. string[]

ApiManagementServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obligatoire)
userAssignedIdentities Liste des identités d’utilisateur associées à la ressource. Identité de l’utilisateur
les références de clé de dictionnaire seront des ID de ressource ARM au format :
’/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserIdentityProperties

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. string
principalId ID principal de l’identité affectée par l’utilisateur. string

ApiManagementServiceProperties

Nom Description Valeur
additionalLocations Emplacements de centre de données supplémentaires du service Gestion des API. AdditionalLocation[]
apiVersionConstraint Contrainte de version des API du plan de contrôle pour le service Gestion des API. ApiVersionConstraint
certificates Liste des certificats qui doivent être installés dans le service Gestion des API. Le nombre maximal de certificats pris en charge pouvant être installés est de 10. CertificateConfiguration[]
configurationApi Configuration de l’API de configuration du service Gestion des API. ConfigurationApi
customProperties Propriétés personnalisées du service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive le chiffrement TLS_RSA_WITH_3DES_EDE_CBC_SHA pour tous les tls(1.0, 1.1 et 1.2).
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 sur un service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 peut être utilisé pour activer le protocole HTTP2 sur un service Gestion des API.
Si vous ne spécifiez aucune de ces propriétés lors de l’opération PATCH, les valeurs par défaut des propriétés omises sont rétablies. Pour tous les paramètres sauf Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou False avant. La valeur par défaut du paramètre Http2 est False.

Vous pouvez désactiver l’un des chiffrements suivants à l’aide des paramètres Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]suivants : TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Par exemple, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. La valeur par défaut est true pour eux.
Remarque : Les chiffrements suivants ne peuvent pas être désactivés, car ils sont requis par les composants de plateforme internes : TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus État du portail des développeurs dans ce service Gestion des API. 'Désactivé'
'Enabled'
disableGateway Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans master région. bool
enableClientCertificate Propriété destinée uniquement à être utilisée pour le service de référence SKU Consommation. Cela applique un certificat client à présenter à chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle. bool
hostnameConfigurations Configuration de nom d’hôte personnalisée du service Gestion des API. HostnameConfiguration[]
legacyPortalStatus État du portail hérité dans le service Gestion des API. 'Désactivé'
'Enabled'
natGatewayState La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API. 'Désactivé'
'Enabled'
notificationSenderEmail Email adresse à partir de laquelle la notification sera envoyée. string
privateEndpointConnections Liste des connexions de point de terminaison privé de ce service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Adresse IP V4 de la référence SKU Standard publique à associer à Réseau virtuel service déployé dans la région. Pris en charge uniquement pour les références SKU Développeur et Premium déployées dans Réseau virtuel. string
publicNetworkAccess Indique si l’accès au point de terminaison public est autorisé pour ce service Gestion des API. La valeur est facultative, mais si elle est transmise, doit être « Activé » ou « Désactivé ». Si « Désactivé », les points de terminaison privés sont la méthode d’accès exclusif. La valeur par défaut est « Enabled » 'Désactivé'
'Enabled'
publisherEmail E-mail de l’éditeur. string (obligatoire)
publisherName Nom de l’éditeur. string (obligatoire)
restauration Annulez la suppression du service Gestion des API s’il a été précédemment supprimé de manière réversible. Si cet indicateur est spécifié et défini sur True, toutes les autres propriétés sont ignorées. bool
virtualNetworkConfiguration Configuration de réseau virtuel du service Gestion des API. VirtualNetworkConfiguration
virtualNetworkType Type de VPN dans lequel Gestion des API service doit être configuré. Aucun (valeur par défaut) signifie que le service Gestion des API ne fait partie d’aucun Réseau virtuel, externe signifie que le déploiement Gestion des API est configuré à l’intérieur d’un Réseau virtuel ayant un point de terminaison accessible sur Internet, et interne signifie que Gestion des API Le déploiement est configuré à l’intérieur d’un Réseau virtuel ayant un point de terminaison intranet uniquement. 'External'
'Interne'
'None'

AdditionalLocation

Nom Description Valeur
disableGateway Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans cet emplacement supplémentaire. bool
location Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. string (obligatoire)
natGatewayState La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API. 'Désactivé'
'Enabled'
publicIpAddressId Adresse IP V4 de la référence SKU Standard publique à associer à Réseau virtuel service déployé à l’emplacement. Pris en charge uniquement pour la référence SKU Premium déployée dans Réseau virtuel. string
sku Propriétés de la référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
virtualNetworkConfiguration Configuration du réseau virtuel pour l’emplacement. VirtualNetworkConfiguration
zones Liste des zones de disponibilité indiquant d’où doit provenir la ressource. string[]

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). Pour Consommation, la capacité de référence SKU doit être spécifiée comme étant 0. int (obligatoire)
name Nom de la référence SKU. 'De base'
'BasicV2'
'Consommation'
'Développeur'
'Isolé'
'Premium'
'Standard'
'StandardV2' (obligatoire)

VirtualNetworkConfiguration

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

ApiVersionConstraint

Nom Description Valeur
minApiVersion Limitez les appels d’API de plan de contrôle à Gestion des API service dont la version est égale ou plus récente que cette valeur. string

CertificateConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation
certificatePassword Mot de passe du certificat. string
encodedCertificate Certificat codé en base64. string
storeName Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seuls Root et CertificateAuthority sont des emplacements valides. 'CertificateAuthority'
'Root' (obligatoire)

CertificateInformation

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

ConfigurationApi

Nom Description Valeur
legacyApi Indique si l’API de configuration héritée (v1) doit être exposée sur le service Gestion des API. La valeur est facultative, mais doit être « Enabled » ou « Disabled ». Si « Désactivé », l’API de configuration héritée (v1) ne sera pas disponible pour les passerelles auto-hébergées. La valeur par défaut est « Enabled » 'Désactivé'
'Enabled'

ApiManagementServiceBasePropertiesCustomProperties

Nom Description Valeur
{propriété personnalisée} string

HostnameConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation
certificatePassword Mot de passe du certificat. string
certificateSource Source du certificat. 'BuiltIn'
'Personnalisé'
'KeyVault'
'Managed'
certificateStatus État du certificat. 'Completed'
'Failed'
'InProgress'
defaultSslBinding Spécifiez true pour configurer le certificat associé à ce nom d’hôte en tant que certificat SSL par défaut. Si un client n’envoie pas l’en-tête SNI, il s’agit du certificat qui sera contesté. La propriété est utile si un service a plusieurs noms d’hôte personnalisés activés et qu’il doit décider du certificat SSL par défaut. Paramètre appliqué uniquement au type de nom d’hôte de la passerelle. bool
encodedCertificate Certificat codé en base64. string
hostName Nom d’hôte à configurer sur le service Gestion des API. string (obligatoire)
identityClientId ClientId d’identité managée affectée par le système ou par l’utilisateur, tel que généré par Azure AD, qui dispose d’un accès GET au coffre de clés contenant le certificat SSL. string
keyVaultId URL du secret KeyVault contenant le certificat SSL. Si l’URL absolue contenant la version est fournie, la mise à jour automatique du certificat SSL ne fonctionnera pas. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi. Le secret doit être de type application/x-pkcs12 string
negotiateClientCertificate Spécifiez true pour toujours négocier le certificat client sur le nom d’hôte. La valeur par défaut est false. bool
type Type de nom d’hôte. 'ConfigurationApi'
'DeveloperPortal'
'Management'
'Portail'
'Proxy'
'Scm' (obligatoire)

RemotePrivateEndpointConnectionWrapper

Nom Description Valeur
id ID de ressource de connexion de point de terminaison privé string
name Nom de la connexion de point de terminaison privé string
properties Propriétés de ressource. PrivateEndpointConnectionWrapperProperties
type Type de ressource de connexion de point de terminaison privé string

PrivateEndpointConnectionWrapperProperties

Nom Description Valeur
privateEndpoint Ressource du point de terminaison privé. ArmIdWrapper
privateLinkServiceConnectionState Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. PrivateLinkServiceConnectionState (obligatoire)

ArmIdWrapper

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

PrivateLinkServiceConnectionState

Nom Description Valeur
actionsRequired Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. string
description Motif de l’approbation/du rejet de la connexion. string
status Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. 'Approuvé'
'En attente'
« Rejeté »

Modèles de démarrage rapide

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

Modèle Description
Créer une instance de 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
Déployer Gestion des API avec un Azure Cache pour Redis externe

Déployer sur Azure		 Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Consommation avec un Azure Cache pour Redis instance externe comme cache externe Gestion des API.
Déployer Gestion des API dans un réseau virtuel externe avec une adresse IP publique

Déployer sur Azure		 Ce modèle montre comment créer une instance d’Azure Gestion des API 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. Le instance est déployé dans deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
Créer un Gestion des API instance avec des noms d’hôte personnalisés

Déployer sur Azure		 Ce modèle montre comment créer une instance d’Azure Gestion des API avec un nom d’hôte personnalisé pour le portail et plusieurs noms d’hôte personnalisés pour le proxy
Créer des Gestion des API dans un réseau virtuel interne avec App Gateway

Déployer sur Azure		 Ce modèle montre comment créer un 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 interne avec une adresse IP publique

Déployer sur Azure		 Ce modèle montre comment créer une instance d’Azure Gestion des API 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. Le instance est déployé dans deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
Créer un Gestion des API instance ayant une identité MSI

Déployer sur Azure		 Ce modèle crée une instance de développeur d’Azure Gestion des API ayant une identité MSI
Créer un niveau Premium multirégion Gestion des API instance

Déployer sur Azure		 Ce modèle montre comment créer un Gestion des API instance avec des emplacements supplémentaires. L’emplacement principal est identique à l’emplacement du groupe de ressources. Pour les emplacements supplémentaires, le modèle affiche NorthCentralUs et USA Est 2. L’emplacement principal doit être différent des autres emplacements.
Créer Gestion des API avec le proxy personnalisé ssl à l’aide de KeyVault

Déployer sur Azure		 Ce modèle montre comment créer un instance d’Azure Gestion des API et configurer un nom d’hôte personnalisé pour le proxy avec un certificat SSL à partir du coffre de clés.
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 extraire le certificat SSL de KeyVault et le maintient à jour en vérifiant toutes les 4 heures.
Créer et surveiller des Gestion des API instance

Déployer sur Azure		 Ce modèle crée une instance du service Azure Gestion des API et de l’espace de travail Log Analytics et configure la surveillance de votre service Gestion des API avec Log Analytics
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.
Déployer Gestion des API dans des zones de disponibilité

Déployer sur Azure		 Ce modèle crée une instance Premium d’Azure Gestion des API et se déploie dans une zone de disponibilité
Créer une instance de Gestion des API à l’aide d’un modèle

Déployer sur Azure		 Ce modèle crée un instance développeur d’Azure Gestion des API
Front Door Standard/Premium avec origine Gestion des API

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

Déployer sur Azure		 Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.
Application Gateway avec l’Gestion des API interne et l’application web

Déployer sur Azure		 Application Gateway le routage du trafic Internet vers un réseau virtuel (mode interne) Gestion des API instance qui dessert une API web hébergée dans une application web Azure.

Définition de ressources 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 d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service, ajoutez le json suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string"
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "string",
        "natGatewayState": "string",
        "publicIpAddressId": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        },
        "zones": [ "string" ]
      }
    ],
    "apiVersionConstraint": {
      "minApiVersion": "string"
    },
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "configurationApi": {
      "legacyApi": "string"
    },
    "customProperties": {
      "{customized property}": "string"
    },
    "developerPortalStatus": "string",
    "disableGateway": "bool",
    "enableClientCertificate": "bool",
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "certificateSource": "string",
        "certificateStatus": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "identityClientId": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "legacyPortalStatus": "string",
    "natGatewayState": "string",
    "notificationSenderEmail": "string",
    "privateEndpointConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        },
        "type": "string"
      }
    ],
    "publicIpAddressId": "string",
    "publicNetworkAccess": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "restore": "bool",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "zones": [ "string" ]
}

Valeurs de propriétés

service

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service'
apiVersion Version de l’API de ressource '2023-05-01-preview'
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-50

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.

Le nom de la ressource doit être unique dans Azure.
location Emplacement de la ressource. string (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Propriétés de la référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
identité Identité de service managée du service Gestion des API. ApiManagementServiceIdentity
properties Propriétés du service Gestion des API. ApiManagementServiceProperties (obligatoire)
zones Liste des zones de disponibilité indiquant d’où doit provenir la ressource. string[]

ApiManagementServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obligatoire)
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Identité de l’utilisateur
les références de clé de dictionnaire seront des ID de ressource ARM au format :
’/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserIdentityProperties

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. string
principalId ID principal de l’identité affectée par l’utilisateur. string

ApiManagementServiceProperties

Nom Description Valeur
additionalLocations Emplacements de centre de données supplémentaires du service Gestion des API. AdditionalLocation[]
apiVersionConstraint Contrainte de version api du plan de contrôle pour le service Gestion des API. ApiVersionConstraint
certificates Liste des certificats qui doivent être installés dans le service Gestion des API. Le nombre maximal de certificats pris en charge pouvant être installés est de 10. CertificateConfiguration[]
configurationApi Configuration de l’API de configuration du service Gestion des API. ConfigurationApi
customProperties Propriétés personnalisées du service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive le chiffrement TLS_RSA_WITH_3DES_EDE_CBC_SHA pour tous les tls(1.0, 1.1 et 1.2).
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 sur un service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 peut être utilisé pour activer le protocole HTTP2 sur un service Gestion des API.
Si vous ne spécifiez aucune de ces propriétés lors de l’opération PATCH, les valeurs par défaut des propriétés omises sont rétablies. Pour tous les paramètres sauf Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou False avant. La valeur par défaut du paramètre Http2 est False.

Vous pouvez désactiver l’un des chiffrements suivants à l’aide des paramètres Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]suivants : TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Par exemple, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. La valeur par défaut est true pour eux.
Remarque : Les chiffrements suivants ne peuvent pas être désactivés, car ils sont requis par les composants de plateforme internes : TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus État du portail des développeurs dans ce service Gestion des API. 'Désactivé'
'Enabled'
disableGateway Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans master région. bool
enableClientCertificate Propriété destinée uniquement à être utilisée pour le service de référence SKU Consommation. Cela applique un certificat client à présenter à chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle. bool
hostnameConfigurations Configuration de nom d’hôte personnalisée du service Gestion des API. HostnameConfiguration[]
legacyPortalStatus État du portail hérité dans le service Gestion des API. 'Désactivé'
'Enabled'
natGatewayState La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API. 'Désactivé'
'Enabled'
notificationSenderEmail Email adresse à partir de laquelle la notification sera envoyée. string
privateEndpointConnections Liste des connexions de point de terminaison privé de ce service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Adresse IP V4 de la référence SKU Standard publique à associer à Réseau virtuel service déployé dans la région. Pris en charge uniquement pour les références SKU Développeur et Premium déployées dans Réseau virtuel. string
publicNetworkAccess Indique si l’accès au point de terminaison public est autorisé pour ce service Gestion des API. La valeur est facultative, mais si elle est transmise, doit être « Activé » ou « Désactivé ». Si « Désactivé », les points de terminaison privés sont la méthode d’accès exclusif. La valeur par défaut est « Enabled » 'Désactivé'
'Enabled'
publisherEmail E-mail de l’éditeur. string (obligatoire)
publisherName Nom de l’éditeur. string (obligatoire)
restauration Annulez la suppression du service Gestion des API s’il a été précédemment supprimé de manière réversible. Si cet indicateur est spécifié et défini sur True, toutes les autres propriétés sont ignorées. bool
virtualNetworkConfiguration Configuration de réseau virtuel du service Gestion des API. VirtualNetworkConfiguration
virtualNetworkType Type de VPN dans lequel Gestion des API service doit être configuré. Aucun (valeur par défaut) signifie que le service Gestion des API ne fait partie d’aucun Réseau virtuel, externe signifie que le déploiement Gestion des API est configuré à l’intérieur d’un Réseau virtuel ayant un point de terminaison accessible sur Internet, et interne signifie que Gestion des API Le déploiement est configuré à l’intérieur d’un Réseau virtuel ayant un point de terminaison intranet uniquement. 'External'
'Interne'
'None'

AdditionalLocation

Nom Description Valeur
disableGateway Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans cet emplacement supplémentaire. bool
location Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. string (obligatoire)
natGatewayState La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API. 'Désactivé'
'Enabled'
publicIpAddressId Adresse IP V4 de la référence SKU Standard publique à associer à Réseau virtuel service déployé à l’emplacement. Pris en charge uniquement pour la référence SKU Premium déployée dans Réseau virtuel. string
sku Propriétés de la référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
virtualNetworkConfiguration Configuration du réseau virtuel pour l’emplacement. VirtualNetworkConfiguration
zones Liste des zones de disponibilité indiquant d’où doit provenir la ressource. string[]

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). Pour Consommation, la capacité de référence SKU doit être spécifiée comme étant 0. int (obligatoire)
name Nom de la référence SKU. 'De base'
'BasicV2'
'Consommation'
'Développeur'
'Isolé'
'Premium'
'Standard'
'StandardV2' (obligatoire)

VirtualNetworkConfiguration

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

ApiVersionConstraint

Nom Description Valeur
minApiVersion Limitez les appels d’API de plan de contrôle à Gestion des API service dont la version est égale ou plus récente que cette valeur. string

CertificateConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation
certificatePassword Mot de passe du certificat. string
encodedCertificate Certificat codé en base64. string
storeName Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seuls Root et CertificateAuthority sont des emplacements valides. 'CertificateAuthority'
'Root' (obligatoire)

CertificateInformation

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

ConfigurationApi

Nom Description Valeur
legacyApi Indique si l’API de configuration héritée (v1) doit être exposée sur le service Gestion des API. La valeur est facultative, mais doit être « Enabled » ou « Disabled ». Si « Désactivé », l’API de configuration héritée (v1) ne sera pas disponible pour les passerelles auto-hébergées. La valeur par défaut est « Enabled » 'Désactivé'
'Enabled'

ApiManagementServiceBasePropertiesCustomProperties

Nom Description Valeur
{propriété personnalisée} string

HostnameConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation
certificatePassword Mot de passe du certificat. string
certificateSource Source de certificat. 'BuiltIn'
'Personnalisé'
'KeyVault'
'Géré'
certificateStatus État du certificat. 'Terminé'
'Échec'
'InProgress'
defaultSslBinding Spécifiez true pour configurer le certificat associé à ce nom d’hôte en tant que certificat SSL par défaut. Si un client n’envoie pas l’en-tête SNI, il s’agit du certificat qui sera contesté. La propriété est utile si un service a plusieurs noms d’hôte personnalisés activés et qu’il doit décider du certificat ssl par défaut. Paramètre appliqué uniquement au type de nom d’hôte de la passerelle. bool
encodéCertificate Certificat encodé en Base64. string
hostName Nom d’hôte à configurer sur le service Gestion des API. chaîne (obligatoire)
identityClientId ClientId d’identité managée affectée par le système ou l’utilisateur, généré par Azure AD, qui dispose d’un accès GET au keyVault contenant le certificat SSL. string
keyVaultId Url du secret KeyVault contenant le certificat SSL. Si l’URL absolue contenant la version est fournie, la mise à jour automatique du certificat ssl ne fonctionnera pas. Pour cela, le service Gestion des API doit être configuré avec aka.ms/apimmsi. Le secret doit être de type application/x-pkcs12 string
negotiateClientCertificate Spécifiez true pour toujours négocier le certificat client sur le nom d’hôte. La valeur par défaut est false. bool
type Type de nom d’hôte. 'ConfigurationApi'
'DeveloperPortal'
'Gestion'
'Portail'
'Proxy'
'Scm' (obligatoire)

RemotePrivateEndpointConnectionWrapper

Nom Description Valeur
id ID de ressource de connexion de point de terminaison privé string
name Nom de la connexion du point de terminaison privé string
properties Propriétés de ressource. PrivateEndpointConnectionWrapperProperties
type Type de ressource de connexion de point de terminaison privé string

PrivateEndpointConnectionWrapperProperties

Nom Description Valeur
privateEndpoint Ressource du point de terminaison privé. ArmIdWrapper
privateLinkServiceConnectionState Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. PrivateLinkServiceConnectionState (obligatoire)

ArmIdWrapper

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

PrivateLinkServiceConnectionState

Nom Description Valeur
actionsRequired Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. string
description Raison de l’approbation/du rejet de la connexion. string
status Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. 'Approuvé'
'En attente'
« Rejeté »

Modèles de démarrage rapide

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

Modèle Description
Créer une instance de 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
Déployer Gestion des API avec un Azure Cache pour Redis externe

Déployer sur Azure		 Ce modèle montre comment créer un instance d’Azure Gestion des API dans le niveau Consommation avec un Azure Cache pour Redis instance externe comme cache externe Gestion des API.
Déployer Gestion des API dans un réseau virtuel externe avec une adresse IP publique

Déployer sur Azure		 Ce modèle montre comment créer une instance d’Azure Gestion des API 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. Le instance est déployé dans deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
Créer un Gestion des API instance avec des noms d’hôte personnalisés

Déployer sur Azure		 Ce modèle montre comment créer un instance d’Azure Gestion des API avec un nom d’hôte personnalisé pour le portail et plusieurs noms d’hôte personnalisés pour le proxy
Créer des Gestion des API dans un réseau virtuel interne avec App Gateway

Déployer sur Azure		 Ce modèle montre comment créer un instance d’Azure Gestion des API sur un réseau privé protégé par Azure Application Gateway.
Déployer Gestion des API dans un réseau virtuel interne avec une adresse IP publique

Déployer sur Azure		 Ce modèle montre comment créer une instance d’Azure Gestion des API 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. Le instance est déployé dans deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement.
Créer un Gestion des API instance ayant l’identité MSI

Déployer sur Azure		 Ce modèle crée une instance de développeur d’Azure Gestion des API ayant une identité MSI
Créer un niveau Premium multirégion Gestion des API instance

Déployer sur Azure		 Ce modèle montre comment créer une Gestion des API instance avec des emplacements supplémentaires. L’emplacement principal est identique à 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 autres emplacements.
Créer des Gestion des API avec le proxy ssl personnalisé à l’aide de KeyVault

Déployer sur Azure		 Ce modèle montre comment créer un instance d’Azure Gestion des API et configurer le nom d’hôte personnalisé pour le proxy avec un certificat ssl à partir du coffre de clés.
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 extraire le certificat SSL de KeyVault et le maintient à jour en vérifiant toutes les 4 heures.
Créer et superviser des Gestion des API instance

Déployer sur Azure		 Ce modèle crée une instance du service Azure Gestion des API et de l’espace de travail Log Analytics et configure la surveillance de votre service Gestion des API avec Log Analytics
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.
Déployer Gestion des API dans des zones de disponibilité

Déployer sur Azure		 Ce modèle crée une instance Premium d’Azure Gestion des API et se déploie dans une zone de disponibilité
Créer une instance de Gestion des API à l’aide d’un modèle

Déployer sur Azure		 Ce modèle crée un instance développeur d’Azure Gestion des API
Front Door Standard/Premium avec origine Gestion des API

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

Déployer sur Azure		 Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.
Application Gateway avec Gestion des API interne et Web App

Déployer sur Azure		 Application Gateway le routage du trafic Internet vers un réseau virtuel (mode interne) Gestion des API instance qui traite une API web hébergée dans une application web Azure.

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 des ressources

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          disableGateway = bool
          location = "string"
          natGatewayState = "string"
          publicIpAddressId = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
          zones = [
            "string"
          ]
        }
      ]
      apiVersionConstraint = {
        minApiVersion = "string"
      }
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      configurationApi = {
        legacyApi = "string"
      }
      customProperties = {
        {customized property} = "string"
      }
      developerPortalStatus = "string"
      disableGateway = bool
      enableClientCertificate = bool
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          certificateSource = "string"
          certificateStatus = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          identityClientId = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      legacyPortalStatus = "string"
      natGatewayState = "string"
      notificationSenderEmail = "string"
      privateEndpointConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
          type = "string"
        }
      ]
      publicIpAddressId = "string"
      publicNetworkAccess = "string"
      publisherEmail = "string"
      publisherName = "string"
      restore = bool
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

Valeurs de propriétés

service

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service@2023-05-01-preview »
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-50

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.

Le nom de la ressource doit être unique dans Azure.
location Emplacement de la ressource. string (obligatoire)
parent_id Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. string (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
sku Propriétés de la référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
identité Identité de service managée du service Gestion des API. ApiManagementServiceIdentity
properties Propriétés du service Gestion des API. ApiManagementServiceProperties (obligatoire)
zones Liste des zones de disponibilité indiquant d’où doit provenir la ressource. string[]

ApiManagementServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités du service. « SystemAssigned »
« SystemAssigned, UserAssigned »
« UserAssigned » (obligatoire)
identity_ids Liste des identités utilisateur associées à la ressource. Identité de l’utilisateur
les références de clé de dictionnaire seront des ID de ressource ARM au format :
’/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 Tableau d’ID d’identité utilisateur.

ApiManagementServiceIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserIdentityProperties

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. string
principalId ID principal de l’identité affectée par l’utilisateur. string

ApiManagementServiceProperties

Nom Description Valeur
additionalLocations Emplacements de centre de données supplémentaires du service Gestion des API. AdditionalLocation[]
apiVersionConstraint Contrainte de version api du plan de contrôle pour le service Gestion des API. ApiVersionConstraint
certificates Liste des certificats qui doivent être installés dans le service Gestion des API. Le nombre maximal de certificats pris en charge pouvant être installés est de 10. CertificateConfiguration[]
configurationApi Configuration de l’API de configuration du service Gestion des API. ConfigurationApi
customProperties Propriétés personnalisées du service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive le chiffrement TLS_RSA_WITH_3DES_EDE_CBC_SHA pour tous les tls(1.0, 1.1 et 1.2).
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 sur un service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 peut être utilisé pour activer le protocole HTTP2 sur un service Gestion des API.
Si vous ne spécifiez aucune de ces propriétés lors de l’opération PATCH, les valeurs par défaut des propriétés omises sont rétablies. Pour tous les paramètres sauf Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou False avant. La valeur par défaut du paramètre Http2 est False.

Vous pouvez désactiver l’un des chiffrements suivants à l’aide des paramètres Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]suivants : TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Par exemple, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. La valeur par défaut est true pour eux.
Remarque : Les chiffrements suivants ne peuvent pas être désactivés, car ils sont requis par les composants de plateforme internes : TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus État du portail des développeurs dans ce service Gestion des API. « Désactivé »
« Activé »
disableGateway Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans master région. bool
enableClientCertificate Propriété destinée uniquement à être utilisée pour le service SKU Consommation. Cela applique un certificat client à présenter à chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle. bool
hostnameConfigurations Configuration de nom d’hôte personnalisée du service Gestion des API. HostnameConfiguration[]
legacyPortalStatus État du portail hérité dans le service Gestion des API. « Désactivé »
« Activé »
natGatewayState La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API. « Désactivé »
« Activé »
notificationSenderEmail Email adresse à partir de laquelle la notification sera envoyée. string
privateEndpointConnections Liste des connexions de point de terminaison privé de ce service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Adresse IP V4 de la référence SKU SKU publique à associer à Réseau virtuel service déployé dans la région. Pris en charge uniquement pour les références SKU Développeur et Premium déployées dans Réseau virtuel. string
publicNetworkAccess Indique si l’accès au point de terminaison public est autorisé ou non pour ce service Gestion des API. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled ». Si « Désactivé », les points de terminaison privés sont la méthode d’accès exclusif. La valeur par défaut est « Enabled » « Désactivé »
« Activé »
publisherEmail E-mail de l’éditeur. chaîne (obligatoire)
publisherName Nom de l’éditeur. chaîne (obligatoire)
restauration Annulez la suppression du service de gestion des API s’il a été précédemment supprimé de manière réversible. Si cet indicateur est spécifié et défini sur True, toutes les autres propriétés seront ignorées. bool
virtualNetworkConfiguration Configuration du réseau virtuel du service Gestion des API. VirtualNetworkConfiguration
virtualNetworkType Type de VPN dans lequel Gestion des API service doit être configuré. None (Valeur par défaut) signifie que le service Gestion des API ne fait partie d’aucun Réseau virtuel, External signifie que le déploiement Gestion des API est configuré à l’intérieur d’un Réseau virtuel disposant d’un point de terminaison internet, et Interne signifie que Gestion des API le déploiement est configuré à l’intérieur d’un Réseau virtuel disposant d’un point de terminaison intranet uniquement. « Externe »
« Interne »
"None"

AdditionalLocation

Nom Description Valeur
disableGateway Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans cet emplacement supplémentaire. bool
location Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. chaîne (obligatoire)
natGatewayState La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API. « Désactivé »
« Activé »
publicIpAddressId Adresse IP V4 de la référence SKU SKU publique à associer à Réseau virtuel service déployé à l’emplacement. Pris en charge uniquement pour la référence SKU Premium déployée dans Réseau virtuel. string
sku Propriétés de la référence SKU du service Gestion des API. ApiManagementServiceSkuProperties (obligatoire)
virtualNetworkConfiguration Configuration du réseau virtuel pour l’emplacement. VirtualNetworkConfiguration
zones Liste des zones de disponibilité indiquant d’où doit provenir la ressource. string[]

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). Pour Consommation, la capacité de référence SKU doit être spécifiée comme 0. int (obligatoire)
name Nom de la référence SKU. "Basic"
« BasicV2 »
« Consommation »
« Développeur »
« Isolé »
« Premium »
« Standard »
« StandardV2 » (obligatoire)

VirtualNetworkConfiguration

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

ApiVersionConstraint

Nom Description Valeur
minApiVersion Limitez les appels d’API de plan de contrôle à Gestion des API service dont la version est égale ou plus récente que cette valeur. string

CertificateConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation
certificatePassword Mot de passe du certificat. string
encodedCertificate Certificat codé en base64. string
storeName Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seuls Root et CertificateAuthority sont des emplacements valides. « CertificateAuthority »
« Root » (obligatoire)

CertificateInformation

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

ConfigurationApi

Nom Description Valeur
legacyApi Indique si l’API de configuration héritée (v1) doit être exposée sur le service Gestion des API. La valeur est facultative, mais doit être « Enabled » ou « Disabled ». Si « Désactivé », l’API de configuration héritée (v1) ne sera pas disponible pour les passerelles auto-hébergées. La valeur par défaut est « Enabled » « Désactivé »
« Activé »

ApiManagementServiceBasePropertiesCustomProperties

Nom Description Valeur
{propriété personnalisée} string

HostnameConfiguration

Nom Description Valeur
certificat Informations sur le certificat. CertificateInformation
certificatePassword Mot de passe du certificat. string
certificateSource Source du certificat. « BuiltIn »
"Custom"
« KeyVault »
« Géré »
certificateStatus État du certificat. « Terminé »
« Échec »
« InProgress »
defaultSslBinding Spécifiez true pour configurer le certificat associé à ce nom d’hôte en tant que certificat SSL par défaut. Si un client n’envoie pas l’en-tête SNI, il s’agit du certificat qui sera contesté. La propriété est utile si un service a plusieurs noms d’hôte personnalisés activés et qu’il doit décider du certificat SSL par défaut. Paramètre appliqué uniquement au type de nom d’hôte de la passerelle. bool
encodedCertificate Certificat codé en base64. string
hostName Nom d’hôte à configurer sur le service Gestion des API. string (obligatoire)
identityClientId ClientId d’identité managée affectée par le système ou par l’utilisateur, tel que généré par Azure AD, qui dispose d’un accès GET au coffre de clés contenant le certificat SSL. string
keyVaultId URL du secret KeyVault contenant le certificat SSL. Si l’URL absolue contenant la version est fournie, la mise à jour automatique du certificat SSL ne fonctionnera pas. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi. Le secret doit être de type application/x-pkcs12 string
negotiateClientCertificate Spécifiez true pour toujours négocier le certificat client sur le nom d’hôte. La valeur par défaut est false. bool
type Type de nom d’hôte. « ConfigurationApi »
« DeveloperPortal »
« Gestion »
« Portail »
« Proxy »
« Scm » (obligatoire)

RemotePrivateEndpointConnectionWrapper

Nom Description Valeur
id ID de ressource de connexion de point de terminaison privé string
name Nom de la connexion de point de terminaison privé string
properties Propriétés de ressource. PrivateEndpointConnectionWrapperProperties
type Type de ressource de connexion de point de terminaison privé string

PrivateEndpointConnectionWrapperProperties

Nom Description Valeur
privateEndpoint Ressource du point de terminaison privé. ArmIdWrapper
privateLinkServiceConnectionState Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. PrivateLinkServiceConnectionState (obligatoire)

ArmIdWrapper

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

PrivateLinkServiceConnectionState

Nom Description Valeur
actionsRequired Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. string
description Motif de l’approbation/du rejet de la connexion. string
status Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. « Approuvé »
« En attente »
« Rejeté »