Partager via


Service Microsoft.ApiManagement/certificats 2023-05-01-preview

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-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

Valeurs de propriété

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

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. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
mot de passe Mot de passe du certificat corde

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/certificates

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
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. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

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-05-01-preview",
  "name": "string",
  "properties": {
    "data": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "password": "string"
  }
}

Valeurs de propriété

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

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. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
mot de passe Mot de passe du certificat corde

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/certificates

Nom Description Valeur
apiVersion Version de l’API '2023-05-01-preview'
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés Détails de la création ou de la mise à jour des propriétés du certificat. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/certificates'

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-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

Valeurs de propriété

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

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. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
mot de passe Mot de passe du certificat corde

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/certificates

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
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. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
type Type de ressource « Microsoft.ApiManagement/service/certificates@2023-05-01-preview »