Certificate - Create Or Update
Crée ou met à jour le certificat utilisé pour l’authentification avec le serveur principal.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}?api-version=2021-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
certificate
|
path | True |
string minLength: 1maxLength: 80 pattern: ^[^*#&+:<>?]+$ |
Identificateur de l’entité de certificat. Doit être unique dans l’instance actuelle du service Gestion des API. |
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Nom du service Gestion des API. |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande cliente. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
If-Match |
string |
ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité. |
Corps de la demande
Nom | Type | Description |
---|---|---|
properties.data |
string |
Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. |
properties.keyVault |
Détails de l’emplacement keyVault du certificat. |
|
properties.password |
string |
Mot de passe du certificat |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Les détails du certificat ont été correctement mis à jour. En-têtes ETag: string |
|
201 Created |
Le nouveau certificat a été ajouté avec succès. En-têtes ETag: string |
|
Other Status Codes |
Réponse d’erreur décrivant pourquoi l’opération a échoué. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
Api |
Api |
ApiManagementCreateCertificate
Exemple de requête
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert?api-version=2021-08-01
{
"properties": {
"data": "****************Base 64 Encoded Certificate *******************************",
"password": "****Certificate Password******"
}
}
Exemple de réponse
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "tempcert",
"properties": {
"subject": "CN=contoso.com",
"thumbprint": "*******************3",
"expirationDate": "2018-03-17T21:55:07+00:00"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "tempcert",
"properties": {
"subject": "CN=contoso.com",
"thumbprint": "*******************3",
"expirationDate": "2018-03-17T21:55:07+00:00"
}
}
ApiManagementCreateCertificateWithKeyVault
Exemple de requête
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv?api-version=2021-08-01
{
"properties": {
"keyVault": {
"identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
"secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert"
}
}
}
Exemple de réponse
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCertkv",
"properties": {
"subject": "CN=*.msitesting.net",
"thumbprint": "EA**********************9AD690",
"expirationDate": "2037-01-01T07:00:00Z",
"keyVault": {
"secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
"identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
"lastStatus": {
"code": "Success",
"timeStampUtc": "2020-09-22T00:24:53.3191468Z"
}
}
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCertkv",
"properties": {
"subject": "CN=*.msitesting.net",
"thumbprint": "EA**********************9AD690",
"expirationDate": "2037-01-01T07:00:00Z",
"keyVault": {
"secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
"identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
"lastStatus": {
"code": "Success",
"timeStampUtc": "2020-09-22T00:24:53.3191468Z"
}
}
}
}
Définitions
Nom | Description |
---|---|
Certificate |
Détails du certificat. |
Certificate |
Détails de la création ou de la mise à jour du certificat. |
Error |
Contrat de champ d’erreur. |
Error |
Réponse d’erreur. |
Key |
Créez les détails du contrat KeyVault. |
Key |
Détails du contrat KeyVault. |
Key |
Émettre les propriétés de mise à jour du contrat. |
CertificateContract
Détails du certificat.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nom de la ressource |
properties.expirationDate |
string (date-time) |
Date d’expiration du certificat. La date est conforme au format suivant : |
properties.keyVault |
Détails de l’emplacement keyVault du certificat. |
|
properties.subject |
string |
Attribut objet du certificat. |
properties.thumbprint |
string |
Empreinte numérique du certificat. |
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
CertificateCreateOrUpdateParameters
Détails de la création ou de la mise à jour du certificat.
Nom | Type | Description |
---|---|---|
properties.data |
string |
Certificat codé en base 64 à l’aide de la représentation application/x-pkcs12. |
properties.keyVault |
Détails de l’emplacement keyVault du certificat. |
|
properties.password |
string |
Mot de passe du certificat |
ErrorFieldContract
Contrat de champ d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur au niveau de la propriété. |
message |
string |
Représentation lisible par l’homme de l’erreur au niveau de la propriété. |
target |
string |
Nom de la propriété. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error.code |
string |
Code d’erreur défini par le service. Ce code sert de sous-état pour le code d’erreur HTTP spécifié dans la réponse. |
error.details |
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation. |
|
error.message |
string |
Représentation lisible par l’homme de l’erreur. |
KeyVaultContractCreateProperties
Créez les détails du contrat KeyVault.
Nom | Type | Description |
---|---|---|
identityClientId |
string |
Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. |
secretIdentifier |
string |
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 |
KeyVaultContractProperties
Détails du contrat KeyVault.
Nom | Type | Description |
---|---|---|
identityClientId |
string |
Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. |
lastStatus |
Dernière synchronisation et état d’actualisation du secret à partir du coffre de clés. |
|
secretIdentifier |
string |
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 |
KeyVaultLastAccessStatusContractProperties
Émettre les propriétés de mise à jour du contrat.
Nom | Type | Description |
---|---|---|
code |
string |
Dernier code d’état pour la synchronisation et l’actualisation du secret à partir du coffre de clés. |
message |
string |
Détails de l’erreur sinon vide. |
timeStampUtc |
string (date-time) |
Dernière fois que le secret a été accédé. La date est conforme au format suivant : |