Service/certificats Microsoft.ApiManagement
Définition de ressource Bicep
Le type de ressource service/certificats peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
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' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Valeurs de propriétés
service/certificates
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente pour 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 |
| properties | Détails de la création ou de la mise à jour des propriétés du certificat. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nom | Description | Valeur |
|---|---|---|
| data | Certificat encodé en base 64 à l’aide de la représentation application/x-pkcs12. | string |
| keyVault | Détails de l’emplacement KeyVault du certificat. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| mot de passe | Mot de passe du certificat | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés. | string |
| 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. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi | string |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Créer une instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle |
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités |
Définition de ressources de modèle ARM
Le type de ressource service/certificats peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
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és
service/certificates
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/certificates » |
| apiVersion | Version de l’API de ressource | « 2023-05-01-preview » |
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
| properties | Détails de la création ou de la mise à jour des propriétés du certificat. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nom | Description | Valeur |
|---|---|---|
| data | Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. | string |
| keyVault | Détails de l’emplacement du coffre de clés du certificat. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| mot de passe | Mot de passe du certificat | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés. | string |
| secretIdentifier | Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi | string |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Créer une instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle |
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 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 d’API, consultez journal des modifications.
Format des ressources
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"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
Valeurs de propriétés
service/certificates
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/certificates@2023-05-01-preview » |
| name | Nom de la ressource | string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : service |
| properties | Détails des propriétés de création ou de mise à jour du certificat. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nom | Description | Valeur |
|---|---|---|
| data | Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. | string |
| keyVault | Détails de l’emplacement du coffre de clés du certificat. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| mot de passe | Mot de passe du certificat | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés. | string |
| secretIdentifier | Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi | string |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour