Service Microsoft.ApiManagement 2021-08-01

Article
07/24/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez commandes de déploiement de 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 le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: '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'
      }
    ]
    customProperties: {
      {customized property}: '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'
      }
    ]
    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é

service

Nom	Description	Valeur
nom	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1 à 50 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique. Le nom de la ressource doit être unique dans Azure.
emplacement	Emplacement des ressources.	chaîne (obligatoire)
étiquettes	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
Sku	Propriétés de référence SKU du service Gestion des API.	ApiManagementServiceSkuProperties (obligatoire)
identité	Identité de service managée du service Gestion des API.	ApiManagementServiceIdentity
Propriétés	Propriétés du service Gestion des API.	ApiManagementServiceProperties (obligatoire)
zones	Liste des zones de disponibilité indiquant à partir de laquelle la ressource doit provenir.	string[]

ApiManagementServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affecté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 dans le formulaire : '/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.	corde
principalId	ID principal de l’identité affectée par l’utilisateur.	corde

ApiManagementServiceProperties

Nom	Description	Valeur
additionalLocations	Emplacements de centre de données supplémentaires du service Gestion des API.	AdditionalLocation[]
apiVersionConstraint	Contrainte de version api de plan de contrôle pour le service Gestion des API.	ApiVersionConstraint
Certificats	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[]
customProperties	Propriétés personnalisées du service Gestion des API. La définition `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` désactive la TLS_RSA_WITH_3DES_EDE_CBC_SHA de chiffrement pour toutes les versions 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 des 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 des 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 sur l’opération PATCH, les valeurs des propriétés omises sont réinitialisées à leurs valeurs par défaut. Pour tous les paramètres, à l’exception de Http2, la valeur par défaut est `True` si le service a été créé avant le 1er avril 2018 et `False` sinon. 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]`: 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 la plateforme interne : 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
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans la région maître.	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 sur chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle.	Bool
hostnameConfigurations	Configuration personnalisée du nom d’hôte du service Gestion des API.	HostnameConfiguration[]
notificationSenderEmail	Adresse e-mail à partir de laquelle la notification sera envoyée.	corde Contraintes: Longueur maximale = 100
privateEndpointConnections	Liste des connexions de point de terminaison privé de ce service.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Adresse IP V4 de référence SKU standard publique à associer au service déployé de réseau virtuel dans la région. Prise en charge uniquement pour le déploiement de la référence SKU Développeur et Premium dans un réseau virtuel.	corde
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 passée, 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é' 'Activé'
publisherEmail	E-mail de l’éditeur.	chaîne (obligatoire) Contraintes: Longueur maximale = 100
publisherName	Nom du serveur de publication.	chaîne (obligatoire) Contraintes: Longueur maximale = 100
restaurer	Annuler la suppression réversible du service Gestion des API s’il était 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 du réseau virtuel du service Gestion des API.	virtualNetworkConfiguration
virtualNetworkType	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'

AdditionalLocation

Nom	Description	Valeur
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans cet emplacement supplémentaire.	Bool
emplacement	Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure.	chaîne (obligatoire)
publicIpAddressId	Adresse IP V4 de référence SKU standard publique à associer au service déployé par le réseau virtuel à l’emplacement. Prise en charge uniquement pour la référence SKU Premium déployée dans un réseau virtuel.	corde
Sku	Propriétés de 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 à partir de laquelle la ressource doit provenir.	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 la capacité de référence SKU Consommation, vous devez spécifier la valeur 0.	int (obligatoire)
nom	Nom de la référence SKU.	'De base' 'Consommation' 'Développeur' 'Isolé' 'Premium' 'Standard' (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.	corde Contraintes: Modèle = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

ApiVersionConstraint

Nom	Description	Valeur
minApiVersion	Limitez les appels d’API du plan de contrôle au service Gestion des API avec une version égale ou ultérieure à cette valeur.	corde

CertificateConfiguration

Nom	Description	Valeur
certificat	Informations sur le certificat.	CertificateInformation
certificatePassword	Mot de passe du certificat.	corde
encodedCertificate	Certificat codé en base64.	corde
storeName	Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seules les emplacements 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` 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)

ApiManagementServiceBasePropertiesCustomProperties

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

HostnameConfiguration

Nom	Description	Valeur
certificat	Informations sur le certificat.	CertificateInformation
certificatePassword	Mot de passe du certificat.	corde
certificateSource	Source du certificat.	'BuiltIn' 'Custom' 'KeyVault' 'Managed'
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 proxy.	Bool
encodedCertificate	Certificat codé en base64.	corde
hostName	Nom d’hôte à configurer sur le service Gestion des API.	chaîne (obligatoire)
identityClientId	Id client d’identité managée affectée par le système ou l’utilisateur généré par Azure AD, qui a accès GET au coffre de clés contenant le certificat SSL.	corde
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	corde
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.	'DeveloperPortal' 'Management' 'Portal' 'Proxy' 'Scm' (obligatoire)

RemotePrivateEndpointConnectionWrapper

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

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.	corde
description	Raison de l’approbation/rejet de la connexion.	corde
statut	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 Gestion des API et toutes les sous-ressources à l’aide d’un modèle	Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
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.
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.
Créer une instance Gestion des API avec des noms d’hôte personnalisés	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 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 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.
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 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 gestion des API avec ssl proxy personnalisé à l’aide de KeyVault	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 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 et surveiller l’instance Gestion des API	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 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.
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é
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
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.
Créer Azure Front Door devant la Gestion des API Azure	Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Gestion des API Azure.
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.

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez commandes de déploiement de 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 le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2021-08-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "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"
      }
    ],
    "customProperties": {
      "{customized property}": "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"
      }
    ],
    "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é

service

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service'
apiVersion	Version de l’API de ressource	'2021-08-01'
nom	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1 à 50 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique. Le nom de la ressource doit être unique dans Azure.
emplacement	Emplacement des ressources.	chaîne (obligatoire)
étiquettes	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
Sku	Propriétés de référence SKU du service Gestion des API.	ApiManagementServiceSkuProperties (obligatoire)
identité	Identité de service managée du service Gestion des API.	ApiManagementServiceIdentity
Propriétés	Propriétés du service Gestion des API.	ApiManagementServiceProperties (obligatoire)
zones	Liste des zones de disponibilité indiquant à partir de laquelle la ressource doit provenir.	string[]

ApiManagementServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affecté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 dans le formulaire : '/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.	corde
principalId	ID principal de l’identité affectée par l’utilisateur.	corde

ApiManagementServiceProperties

Nom	Description	Valeur
additionalLocations	Emplacements de centre de données supplémentaires du service Gestion des API.	AdditionalLocation[]
apiVersionConstraint	Contrainte de version api de plan de contrôle pour le service Gestion des API.	ApiVersionConstraint
Certificats	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[]
customProperties	Propriétés personnalisées du service Gestion des API. La définition `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` désactive la TLS_RSA_WITH_3DES_EDE_CBC_SHA de chiffrement pour toutes les versions 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 des 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 des 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 sur l’opération PATCH, les valeurs des propriétés omises sont réinitialisées à leurs valeurs par défaut. Pour tous les paramètres, à l’exception de Http2, la valeur par défaut est `True` si le service a été créé avant le 1er avril 2018 et `False` sinon. 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]`: 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 la plateforme interne : 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
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans la région maître.	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 sur chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle.	Bool
hostnameConfigurations	Configuration personnalisée du nom d’hôte du service Gestion des API.	HostnameConfiguration[]
notificationSenderEmail	Adresse e-mail à partir de laquelle la notification sera envoyée.	corde Contraintes: Longueur maximale = 100
privateEndpointConnections	Liste des connexions de point de terminaison privé de ce service.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Adresse IP V4 de référence SKU standard publique à associer au service déployé de réseau virtuel dans la région. Prise en charge uniquement pour le déploiement de la référence SKU Développeur et Premium dans un réseau virtuel.	corde
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 passée, 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é' 'Activé'
publisherEmail	E-mail de l’éditeur.	chaîne (obligatoire) Contraintes: Longueur maximale = 100
publisherName	Nom du serveur de publication.	chaîne (obligatoire) Contraintes: Longueur maximale = 100
restaurer	Annuler la suppression réversible du service Gestion des API s’il était 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 du réseau virtuel du service Gestion des API.	virtualNetworkConfiguration
virtualNetworkType	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'

AdditionalLocation

Nom	Description	Valeur
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans cet emplacement supplémentaire.	Bool
emplacement	Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure.	chaîne (obligatoire)
publicIpAddressId	Adresse IP V4 de référence SKU standard publique à associer au service déployé par le réseau virtuel à l’emplacement. Prise en charge uniquement pour la référence SKU Premium déployée dans un réseau virtuel.	corde
Sku	Propriétés de 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 à partir de laquelle la ressource doit provenir.	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 la capacité de référence SKU Consommation, vous devez spécifier la valeur 0.	int (obligatoire)
nom	Nom de la référence SKU.	'De base' 'Consommation' 'Développeur' 'Isolé' 'Premium' 'Standard' (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.	corde Contraintes: Modèle = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

ApiVersionConstraint

Nom	Description	Valeur
minApiVersion	Limitez les appels d’API du plan de contrôle au service Gestion des API avec une version égale ou ultérieure à cette valeur.	corde

CertificateConfiguration

Nom	Description	Valeur
certificat	Informations sur le certificat.	CertificateInformation
certificatePassword	Mot de passe du certificat.	corde
encodedCertificate	Certificat codé en base64.	corde
storeName	Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seules les emplacements 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` 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)

ApiManagementServiceBasePropertiesCustomProperties

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

HostnameConfiguration

Nom	Description	Valeur
certificat	Informations sur le certificat.	CertificateInformation
certificatePassword	Mot de passe du certificat.	corde
certificateSource	Source du certificat.	'BuiltIn' 'Custom' 'KeyVault' 'Managed'
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 proxy.	Bool
encodedCertificate	Certificat codé en base64.	corde
hostName	Nom d’hôte à configurer sur le service Gestion des API.	chaîne (obligatoire)
identityClientId	Id client d’identité managée affectée par le système ou l’utilisateur généré par Azure AD, qui a accès GET au coffre de clés contenant le certificat SSL.	corde
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	corde
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.	'DeveloperPortal' 'Management' 'Portal' 'Proxy' 'Scm' (obligatoire)

RemotePrivateEndpointConnectionWrapper

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

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.	corde
description	Raison de l’approbation/rejet de la connexion.	corde
statut	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 Gestion des API et toutes les sous-ressources à l’aide d’un modèle	Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
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.
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.
Créer une instance Gestion des API avec des noms d’hôte personnalisés	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 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 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.
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 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 gestion des API avec ssl proxy personnalisé à l’aide de KeyVault	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 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 et surveiller l’instance Gestion des API	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 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.
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é
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
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.
Créer Azure Front Door devant la Gestion des API Azure	Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Gestion des API Azure.
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.

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@2021-08-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          disableGateway = bool
          location = "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"
        }
      ]
      customProperties = {
        {customized property} = "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"
        }
      ]
      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é

service

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service@2021-08-01 »
nom	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1 à 50 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique. Le nom de la ressource doit être unique dans Azure.
emplacement	Emplacement des ressources.	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
étiquettes	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes.
Sku	Propriétés de référence SKU du service Gestion des API.	ApiManagementServiceSkuProperties (obligatoire)
identité	Identité de service managée du service Gestion des API.	ApiManagementServiceIdentity
Propriétés	Propriétés du service Gestion des API.	ApiManagementServiceProperties (obligatoire)
zones	Liste des zones de disponibilité indiquant à partir de laquelle la ressource doit provenir.	string[]

ApiManagementServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affecté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 dans le formulaire : '/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.	corde
principalId	ID principal de l’identité affectée par l’utilisateur.	corde

ApiManagementServiceProperties

Nom	Description	Valeur
additionalLocations	Emplacements de centre de données supplémentaires du service Gestion des API.	AdditionalLocation[]
apiVersionConstraint	Contrainte de version api de plan de contrôle pour le service Gestion des API.	ApiVersionConstraint
Certificats	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[]
customProperties	Propriétés personnalisées du service Gestion des API. La définition `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` désactive la TLS_RSA_WITH_3DES_EDE_CBC_SHA de chiffrement pour toutes les versions 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 des 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 des 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 sur l’opération PATCH, les valeurs des propriétés omises sont réinitialisées à leurs valeurs par défaut. Pour tous les paramètres, à l’exception de Http2, la valeur par défaut est `True` si le service a été créé avant le 1er avril 2018 et `False` sinon. 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]`: 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 la plateforme interne : 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
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans la région maître.	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 sur chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle.	Bool
hostnameConfigurations	Configuration personnalisée du nom d’hôte du service Gestion des API.	HostnameConfiguration[]
notificationSenderEmail	Adresse e-mail à partir de laquelle la notification sera envoyée.	corde Contraintes: Longueur maximale = 100
privateEndpointConnections	Liste des connexions de point de terminaison privé de ce service.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Adresse IP V4 de référence SKU standard publique à associer au service déployé de réseau virtuel dans la région. Prise en charge uniquement pour le déploiement de la référence SKU Développeur et Premium dans un réseau virtuel.	corde
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 passée, 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é » « Activé »
publisherEmail	E-mail de l’éditeur.	chaîne (obligatoire) Contraintes: Longueur maximale = 100
publisherName	Nom du serveur de publication.	chaîne (obligatoire) Contraintes: Longueur maximale = 100
restaurer	Annuler la suppression réversible du service Gestion des API s’il était 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 du réseau virtuel du service Gestion des API.	virtualNetworkConfiguration
virtualNetworkType	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 » « Aucun »

AdditionalLocation

Nom	Description	Valeur
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans cet emplacement supplémentaire.	Bool
emplacement	Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure.	chaîne (obligatoire)
publicIpAddressId	Adresse IP V4 de référence SKU standard publique à associer au service déployé par le réseau virtuel à l’emplacement. Prise en charge uniquement pour la référence SKU Premium déployée dans un réseau virtuel.	corde
Sku	Propriétés de 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 à partir de laquelle la ressource doit provenir.	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 la capacité de référence SKU Consommation, vous devez spécifier la valeur 0.	int (obligatoire)
nom	Nom de la référence SKU.	« De base » « Consommation » « Développeur » « Isolé » « Premium » « Standard » (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.	corde Contraintes: Modèle = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

ApiVersionConstraint

Nom	Description	Valeur
minApiVersion	Limitez les appels d’API du plan de contrôle au service Gestion des API avec une version égale ou ultérieure à cette valeur.	corde

CertificateConfiguration

Nom	Description	Valeur
certificat	Informations sur le certificat.	CertificateInformation
certificatePassword	Mot de passe du certificat.	corde
encodedCertificate	Certificat codé en base64.	corde
storeName	Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seules les emplacements 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` 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)

ApiManagementServiceBasePropertiesCustomProperties

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

HostnameConfiguration

Nom	Description	Valeur
certificat	Informations sur le certificat.	CertificateInformation
certificatePassword	Mot de passe du certificat.	corde
certificateSource	Source du 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 proxy.	Bool
encodedCertificate	Certificat codé en base64.	corde
hostName	Nom d’hôte à configurer sur le service Gestion des API.	chaîne (obligatoire)
identityClientId	Id client d’identité managée affectée par le système ou l’utilisateur généré par Azure AD, qui a accès GET au coffre de clés contenant le certificat SSL.	corde
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	corde
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.	« DeveloperPortal » « Gestion » « Portail » « Proxy » « Scm » (obligatoire)

RemotePrivateEndpointConnectionWrapper

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

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.	corde
description	Raison de l’approbation/rejet de la connexion.	corde
statut	Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.	« Approuvé » « En attente » « Rejeté »

Partager via

Service Microsoft.ApiManagement 2021-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Modèles de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Commentaires

Ressources supplémentaires