Partager via

Certificate - Add

  • Référence
Service:
Batch Service
Version d'API:
2024-07-01.20.0

Ajoute un certificat au compte spécifié.
Avertissement : cette opération est déconseillée et sera supprimée après février 2024. Utilisez plutôt l''extension Azure KeyVault.

POST {batchUrl}/certificates?api-version=2024-07-01.20.0
Avec des paramètres facultatifs: 
POST {batchUrl}/certificates?timeout={timeout}&api-version=2024-07-01.20.0

Paramètres URI

Nom Dans Obligatoire Type Description
batchUrl
 path True

string

URL de base pour toutes les demandes de service Azure Batch.
api-version
 query True

string

Version de l’API cliente.
timeout
 query

integer

int32

Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place.

En-tête de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom Obligatoire Type Description
client-request-id

string

uuid

L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indique si le serveur doit retourner l’ID client-request-id dans la réponse.
ocp-date

string

date-time-rfc1123

Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

Corps de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom Obligatoire Type Description
data True

string

Contenu codé en base64 du certificat. La taille maximale est de 10 Ko.
thumbprint True

string

Empreinte numérique X.509 du certificat. Il s’agit d’une séquence de jusqu’à 40 chiffres hexadécimaux (il peut inclure des espaces, mais ceux-ci sont supprimés).
thumbprintAlgorithm True

string

Algorithme utilisé pour dériver l’empreinte numérique. Cela doit être sha1.
certificateFormat

CertificateFormat

Format des données de certificat.
password

string

Mot de passe pour accéder à la clé privée du certificat.
Cela doit être omis si le format de certificat est cer.

Réponses

Nom Type Description
201 Created

La demande adressée au service Batch a réussi.

En-têtes

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Erreur du service Batch.

Sécurité

azure_auth

Flux de code d’authentification Microsoft Entra OAuth 2.0

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

Authorization

Type: apiKey
Dans: header

Exemples

Certificate add

Exemple de requête

POST account.region.batch.azure.com/certificates?api-version=2024-07-01.20.0



{
  "thumbprintAlgorithm": "sha1",
  "thumbprint": "0123456789abcdef0123456789abcdef01234567",
  "data": "#####...",
  "certificateFormat": "pfx",
  "password": "<ExamplePassword>"
}

Exemple de réponse

Code d’état:
201

Définitions

Nom Description
BatchError

Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
CertificateAddParameter

Certificat qui peut être installé sur les nœuds de calcul et qui peut être utilisé pour authentifier les opérations sur l’ordinateur.
CertificateFormat

Format des données de certificat.
ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom Type Description
code

string

Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message

ErrorMessage

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values

BatchErrorDetail[]

Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom Type Description
key

string

Identificateur spécifiant la signification de la propriété Value.
value

string

Informations supplémentaires incluses dans la réponse d’erreur.

CertificateAddParameter

Certificat qui peut être installé sur les nœuds de calcul et qui peut être utilisé pour authentifier les opérations sur l’ordinateur.

Nom Type Description
certificateFormat

CertificateFormat

Format des données de certificat.
data

string

Contenu codé en base64 du certificat. La taille maximale est de 10 Ko.
password

string

Mot de passe pour accéder à la clé privée du certificat.
Cela doit être omis si le format de certificat est cer.
thumbprint

string

Empreinte numérique X.509 du certificat. Il s’agit d’une séquence de jusqu’à 40 chiffres hexadécimaux (il peut inclure des espaces, mais ceux-ci sont supprimés).
thumbprintAlgorithm

string

Algorithme utilisé pour dériver l’empreinte numérique. Cela doit être sha1.

CertificateFormat

Format des données de certificat.

Nom Type Description
cer

string

Le certificat est un certificat X.509 codé en base64.
pfx

string

Le certificat est une chaîne de certificats ou de certificats au format PFX (PKCS#12).

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom Type Description
lang

string

Code de langue du message d’erreur
value

string

Texte du message.