Certificate - Add

Service:

Batch Service

API Version:

2023-11-01.18.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=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/certificates?timeout={timeout}&api-version=2023-11-01.18.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 que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Nom	Obligatoire	Type	Description
client-request-id		string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner le 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 actuelle de l’horloge système ; définissez-la 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 encodé en base64 du certificat. La taille maximale est de 10 Ko.
thumbprint	True	string	Empreinte X.509 du certificat. Il s’agit d’une séquence de jusqu’à 40 chiffres hexadécimaux (elle peut inclure des espaces, mais ceux-ci sont supprimés).
thumbprintAlgorithm	True	string	Algorithme utilisé pour dériver l’empreinte numérique. Il doit s’agir de sha1.
certificateFormat		CertificateFormat	Format des données de certificat.
password		string	Mot de passe permettant d’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. Headers 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 OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

Certificate add

Sample Request

HTTP

POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0



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

Sample Response

Status code:

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	Un certificat qui peut être installé sur les nœuds de calcul et 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 programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être affiché 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

Un certificat qui peut être installé sur les nœuds de calcul et 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 encodé en base64 du certificat. La taille maximale est de 10 Ko.
password	string	Mot de passe permettant d’accéder à la clé privée du certificat. Cela doit être omis si le format de certificat est cer.
thumbprint	string	Empreinte X.509 du certificat. Il s’agit d’une séquence de jusqu’à 40 chiffres hexadécimaux (elle peut inclure des espaces, mais ceux-ci sont supprimés).
thumbprintAlgorithm	string	Algorithme utilisé pour dériver l’empreinte numérique. Il doit s’agir de 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 un certificat ou une chaîne 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.