Partager via


Service/certificats Microsoft.ApiManagement

Définition de ressource Bicep

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

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

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

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

Valeurs de propriété

service/certificats

Nom Description Valeur
nom Nom de la ressource

Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.
chaîne (obligatoire)

Limite de caractères : 1 à 80

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

Commencez par la lettre et terminez par alphanumérique.
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : service
Propriétés Détails de la création ou de la mise à jour des propriétés du certificat. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nom Description Valeur
données Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. corde
keyVault Détails de l’emplacement keyVault du certificat. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
mot de passe Mot de passe du certificat corde

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nom Description Valeur
identityClientId Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. corde
secretIdentifier Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi corde

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

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

Définition de ressource de modèle ARM

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

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

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

{
  "type": "Microsoft.ApiManagement/service/certificates",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "data": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "password": "string"
  }
}

Valeurs de propriété

service/certificats

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service/certificates'
apiVersion Version de l’API de ressource '2023-09-01-preview'
nom Nom de la ressource

Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.
chaîne (obligatoire)

Limite de caractères : 1 à 80

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

Commencez par la lettre et terminez par alphanumérique.
Propriétés Détails de la création ou de la mise à jour des propriétés du certificat. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nom Description Valeur
données Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. corde
keyVault Détails de l’emplacement keyVault du certificat. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
mot de passe Mot de passe du certificat corde

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nom Description Valeur
identityClientId Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. corde
secretIdentifier Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi corde

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

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

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

Valeurs de propriété

service/certificats

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/certificates@2023-09-01-preview »
nom Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1 à 80

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

Commencez par la lettre et terminez par alphanumérique.
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : de service
Propriétés Détails de la création ou de la mise à jour des propriétés du certificat. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nom Description Valeur
données Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. corde
keyVault Détails de l’emplacement keyVault du certificat. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
mot de passe Mot de passe du certificat corde

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nom Description Valeur
identityClientId Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. corde
secretIdentifier Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi corde