Service Microsoft.ApiManagement 2019-01-01
- dernière
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
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@2019-01-01' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
additionalLocations: [
{
location: 'string'
sku: {
capacity: int
name: 'string'
}
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
}
]
certificates: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
encodedCertificate: 'string'
storeName: 'string'
}
]
customProperties: {
{customized property}: 'string'
}
enableClientCertificate: bool
hostnameConfigurations: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
defaultSslBinding: bool
encodedCertificate: 'string'
hostName: 'string'
keyVaultId: 'string'
negotiateClientCertificate: bool
type: 'string'
}
]
notificationSenderEmail: 'string'
publisherEmail: 'string'
publisherName: 'string'
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valeurs de propriété
AdditionalLocation
| Nom | Description | Valeur |
|---|---|---|
| emplacement | Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. | chaîne (obligatoire) |
| 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 |
ApiManagementServiceBasePropertiesCustomProperties
| Nom | Description | Valeur |
|---|
ApiManagementServiceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité. Actuellement, le seul type pris en charge est « SystemAssigned ». | 'SystemAssigned' (obligatoire) |
ApiManagementServiceProperties
| Nom | Description | Valeur |
|---|---|---|
| additionalLocations | Emplacements de centre de données supplémentaires du service Gestion des API. | AdditionalLocation[] |
| 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éé le 1er avril 2018 ou 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 toutes ces valeurs. |
ApiManagementServiceBasePropertiesCustomProperties |
| 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 = |
| publisherEmail | E-mail de l’éditeur. | corde Contraintes: Longueur maximale = (obligatoire) |
| publisherName | Nom du serveur de publication. | corde Contraintes: Longueur maximale = (obligatoire) |
| 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' |
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). | Int |
| nom | Nom de la référence SKU. | 'De base' 'Consommation' 'Développeur' 'Premium' 'Standard' (obligatoire) |
ApimResourceTags
| Nom | Description | Valeur |
|---|
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) |
HostnameConfiguration
| Nom | Description | Valeur |
|---|---|---|
| certificat | Informations sur le certificat. | CertificateInformation |
| certificatePassword | Mot de passe du certificat. | corde |
| 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) |
| 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 MSI. 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) |
Microsoft.ApiManagement/service
| Nom | Description | Valeur |
|---|---|---|
| identité | Identité de service managée du service Gestion des API. | ApiManagementServiceIdentity |
| emplacement | Emplacement des ressources. | chaîne (obligatoire) |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire) |
| Propriétés | Propriétés du service Gestion des API. | ApiManagementServiceProperties (obligatoire) |
| Sku | Propriétés de référence SKU du service Gestion des API. | ApiManagementServiceSkuProperties (obligatoire) |
| étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
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/[^/]*$ |
Exemples de démarrage rapide
Les exemples de démarrage rapide suivants déploient ce type de ressource.
| Fichier Bicep | Description |
|---|---|
| Application Gateway avec gestion des API internes et d’application web | Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure. |
| Créer une instance gestion des API de niveau Premium multirégion | Ce modèle montre comment créer une instance Gestion des API avec des emplacements supplémentaires. L’emplacement principal est le même que l’emplacement du groupe de ressources. Pour d’autres emplacements, le modèle affiche NorthCentralUs et USA Est2. L’emplacement principal doit être différent des emplacements supplémentaires. |
| Créer une instance Gestion des API avec msi Identity | Ce modèle crée une instance de développeur de Gestion des API Azure ayant une identité MSI |
| Créer une instance Gestion des API à l’aide d’un modèle | Ce modèle crée une instance de développeur de Gestion des API Azure |
| Créer un service Gestion des API avec un point de terminaison privé | Ce modèle crée un service Gestion des API, un réseau virtuel et un point de terminaison privé exposant le service Gestion des API au réseau virtuel. |
| Créer un service Gestion des API avec SSL à partir de KeyVault | Ce modèle déploie un service Gestion des API configuré avec l’identité affectée par l’utilisateur. Il utilise cette identité pour récupérer le certificat SSL à partir de KeyVault et le maintient à jour en vérifiant toutes les 4 heures. |
| Créer une gestion des API dans un réseau virtuel interne avec app Gateway | Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway. |
| Déployer gestion des API dans un réseau virtuel externe avec d’adresses IP publiques | Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode externe et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement. |
| Déployer gestion des API dans un réseau virtuel interne avec d’adresses IP publiques | Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode interne et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement. |
| déployer la gestion des API dans des zones de disponibilité | Ce modèle crée une instance Premium de Gestion des API Azure et se déploie dans une zone de disponibilité |
| Déployer la gestion des API avec un cache Azure externe pour Redis | Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Consommation avec une instance Azure Cache pour Redis externe en tant que cache externe gestion des API. |
| Front Door Standard/Premium avec l’origine gestion des API | Ce modèle crée une instance Front Door Premium et gestion des API et utilise un groupe de sécurité réseau et une stratégie de gestion des API globale pour vérifier que le trafic est passé par l’origine Front Door. |
Définition de ressource de modèle ARM
Le type de ressource de service peut être déployé avec des opérations qui ciblent :
- 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": "2019-01-01",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"additionalLocations": [
{
"location": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
}
}
],
"certificates": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"encodedCertificate": "string",
"storeName": "string"
}
],
"customProperties": {
"{customized property}": "string"
},
"enableClientCertificate": "bool",
"hostnameConfigurations": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"defaultSslBinding": "bool",
"encodedCertificate": "string",
"hostName": "string",
"keyVaultId": "string",
"negotiateClientCertificate": "bool",
"type": "string"
}
],
"notificationSenderEmail": "string",
"publisherEmail": "string",
"publisherName": "string",
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valeurs de propriété
AdditionalLocation
| Nom | Description | Valeur |
|---|---|---|
| emplacement | Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. | chaîne (obligatoire) |
| 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 |
ApiManagementServiceBasePropertiesCustomProperties
| Nom | Description | Valeur |
|---|
ApiManagementServiceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité. Actuellement, le seul type pris en charge est « SystemAssigned ». | 'SystemAssigned' (obligatoire) |
ApiManagementServiceProperties
| Nom | Description | Valeur |
|---|---|---|
| additionalLocations | Emplacements de centre de données supplémentaires du service Gestion des API. | AdditionalLocation[] |
| 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éé le 1er avril 2018 ou 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 toutes ces valeurs. |
ApiManagementServiceBasePropertiesCustomProperties |
| 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 = |
| publisherEmail | E-mail de l’éditeur. | corde Contraintes: Longueur maximale = (obligatoire) |
| publisherName | Nom du serveur de publication. | corde Contraintes: Longueur maximale = (obligatoire) |
| 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' |
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). | Int |
| nom | Nom de la référence SKU. | 'De base' 'Consommation' 'Développeur' 'Premium' 'Standard' (obligatoire) |
ApimResourceTags
| Nom | Description | Valeur |
|---|
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) |
HostnameConfiguration
| Nom | Description | Valeur |
|---|---|---|
| certificat | Informations sur le certificat. | CertificateInformation |
| certificatePassword | Mot de passe du certificat. | corde |
| 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) |
| 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 MSI. 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) |
Microsoft.ApiManagement/service
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2019-01-01' |
| identité | Identité de service managée du service Gestion des API. | ApiManagementServiceIdentity |
| emplacement | Emplacement des ressources. | chaîne (obligatoire) |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire) |
| Propriétés | Propriétés du service Gestion des API. | ApiManagementServiceProperties (obligatoire) |
| Sku | Propriétés de référence SKU du service Gestion des API. | ApiManagementServiceSkuProperties (obligatoire) |
| étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
| type | Type de ressource | 'Microsoft.ApiManagement/service' |
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/[^/]*$ |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Application Gateway avec gestion des API internes et d’application web
|
Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure. |
|
Créer une instance gestion des API de niveau Premium multirégion
|
Ce modèle montre comment créer une instance Gestion des API avec des emplacements supplémentaires. L’emplacement principal est le même que l’emplacement du groupe de ressources. Pour d’autres emplacements, le modèle affiche NorthCentralUs et USA Est2. L’emplacement principal doit être différent des emplacements supplémentaires. |
|
Créer une instance Gestion des API 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 |
|
Créer une instance Gestion des API avec msi Identity
|
Ce modèle crée une instance de développeur de Gestion des API Azure ayant une identité MSI |
|
Créer une instance Gestion des API à l’aide d’un modèle
|
Ce modèle crée une instance de développeur de Gestion des API Azure |
|
Créer 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 un service Gestion des API avec un point de terminaison privé
|
Ce modèle crée un service Gestion des API, un réseau virtuel et un point de terminaison privé exposant le service Gestion des API au réseau virtuel. |
|
Créer un service Gestion des API avec SSL à partir de KeyVault
|
Ce modèle déploie un service Gestion des API configuré avec l’identité affectée par l’utilisateur. Il utilise cette identité pour récupérer le certificat SSL à partir de KeyVault et le maintient à jour en vérifiant toutes les 4 heures. |
|
créer 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 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. |
|
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 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. |
|
Déployer gestion des API dans un réseau virtuel externe avec d’adresses IP publiques
|
Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode externe et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement. |
|
Déployer gestion des API dans un réseau virtuel interne avec d’adresses IP publiques
|
Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Premium au sein du sous-réseau de votre réseau virtuel en mode interne et configurer les règles de groupe de sécurité réseau recommandées sur le sous-réseau. L’instance est déployée sur deux zones de disponibilité. Le modèle configure également une adresse IP publique à partir de votre abonnement. |
|
déployer la gestion des API dans des zones de disponibilité
|
Ce modèle crée une instance Premium de Gestion des API Azure et se déploie dans une zone de disponibilité |
|
Déployer la gestion des API avec un cache Azure externe pour Redis
|
Ce modèle montre comment créer une instance de Gestion des API Azure dans le niveau Consommation avec une instance Azure Cache pour Redis externe en tant que cache externe gestion des API. |
|
Front Door Standard/Premium avec l’origine gestion des API
|
Ce modèle crée une instance Front Door Premium et gestion des API et utilise un groupe de sécurité réseau et une stratégie de gestion des API globale pour vérifier que le trafic est passé par l’origine Front Door. |
Définition de ressource 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@2019-01-01"
name = "string"
identity = {
type = "string"
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
additionalLocations = [
{
location = "string"
sku = {
capacity = int
name = "string"
}
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
}
]
certificates = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
encodedCertificate = "string"
storeName = "string"
}
]
customProperties = {
{customized property} = "string"
}
enableClientCertificate = bool
hostnameConfigurations = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
defaultSslBinding = bool
encodedCertificate = "string"
hostName = "string"
keyVaultId = "string"
negotiateClientCertificate = bool
type = "string"
}
]
notificationSenderEmail = "string"
publisherEmail = "string"
publisherName = "string"
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
virtualNetworkType = "string"
}
})
}
Valeurs de propriété
AdditionalLocation
| Nom | Description | Valeur |
|---|---|---|
| emplacement | Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure. | chaîne (obligatoire) |
| 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 |
ApiManagementServiceBasePropertiesCustomProperties
| Nom | Description | Valeur |
|---|
ApiManagementServiceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité. Actuellement, le seul type pris en charge est « SystemAssigned ». | 'SystemAssigned' (obligatoire) |
ApiManagementServiceProperties
| Nom | Description | Valeur |
|---|---|---|
| additionalLocations | Emplacements de centre de données supplémentaires du service Gestion des API. | AdditionalLocation[] |
| 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éé le 1er avril 2018 ou 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 toutes ces valeurs. |
ApiManagementServiceBasePropertiesCustomProperties |
| 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 = |
| publisherEmail | E-mail de l’éditeur. | corde Contraintes: Longueur maximale = (obligatoire) |
| publisherName | Nom du serveur de publication. | corde Contraintes: Longueur maximale = (obligatoire) |
| 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' |
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). | Int |
| nom | Nom de la référence SKU. | 'De base' 'Consommation' 'Développeur' 'Premium' 'Standard' (obligatoire) |
ApimResourceTags
| Nom | Description | Valeur |
|---|
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) |
HostnameConfiguration
| Nom | Description | Valeur |
|---|---|---|
| certificat | Informations sur le certificat. | CertificateInformation |
| certificatePassword | Mot de passe du certificat. | corde |
| 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) |
| 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 MSI. 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) |
Microsoft.ApiManagement/service
| Nom | Description | Valeur |
|---|---|---|
| identité | Identité de service managée du service Gestion des API. | ApiManagementServiceIdentity |
| emplacement | Emplacement des ressources. | chaîne (obligatoire) |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire) |
| Propriétés | Propriétés du service Gestion des API. | ApiManagementServiceProperties (obligatoire) |
| Sku | Propriétés de référence SKU du service Gestion des API. | ApiManagementServiceSkuProperties (obligatoire) |
| étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
| type | Type de ressource | « Microsoft.ApiManagement/service@2019-01-01 » |
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/[^/]*$ |