Certificate - Get

Référence

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtient des informations sur le certificat 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 .

GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?$select={$select}&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.
thumbprint	path	True	string	Empreinte numérique du certificat à obtenir.
thumbprintAlgorithm	path	True	string	Algorithme utilisé pour dériver le paramètre d’empreinte numérique. Il doit s’agir de sha1.
api-version	query	True	string	Version de l’API cliente.
$select	query		string	Clause de $select OData.
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	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.

Réponses

Nom	Type	Description
200 OK	Certificate	Réponse contenant le certificat. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch.

Nom

Type

Description

200 OK

Certificate

Réponse contenant le certificat.

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: 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 get

Sample Request

HTTP

GET account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "thumbprint": "0123456789abcdef0123456789abcdef01234567",
  "thumbprintAlgorithm": "sha1",
  "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)",
  "state": "deletefailed",
  "stateTransitionTime": "2014-07-31T21:12:58.236Z",
  "previousState": "deleting",
  "previousStateTransitionTime": "2014-07-31T21:11:58.236Z",
  "publicData": "#####...",
  "deleteCertificateError": {
    "code": "PoolsReferencingCertificate",
    "message": "The specified certificate is being used by the below mentioned pool(s)",
    "values": [
      {
        "name": "Pools",
        "value": "mypool1"
      }
    ]
  }
}

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.
Certificate	Un certificat qui peut être installé sur les nœuds de calcul et peut être utilisé pour authentifier les opérations sur l’ordinateur.
CertificateState	État du certificat.
DeleteCertificateError	Erreur rencontrée par le service Batch lors de la suppression d’un certificat.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
NameValuePair	Représente une paire nom-valeur.

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.

Certificate

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
deleteCertificateError	DeleteCertificateError	Erreur qui s’est produite lors de la dernière tentative de suppression de ce certificat. Cette propriété est définie uniquement si le certificat est à l’état DeleteFailed.
previousState	CertificateState	État précédent du certificat. Cette propriété n’est pas définie si le certificat est dans son état actif initial.
previousStateTransitionTime	string	Heure à laquelle le certificat est entré dans son état précédent. Cette propriété n’est pas définie si le certificat est dans son état initial Actif.
publicData	string	Partie publique du certificat sous la forme d’un fichier .cer encodé en base 64.
state	CertificateState	État actuel du certificat.
stateTransitionTime	string	Heure à laquelle le certificat est entré dans son état actuel.
thumbprint	string	Empreinte X.509 du certificat. Il s’agit d’une séquence de jusqu’à 40 chiffres hexadécimaux.
thumbprintAlgorithm	string	Algorithme utilisé pour dériver l’empreinte numérique.
url	string	URL du certificat.

CertificateState

État du certificat.

Nom	Type	Description
active	string	Le certificat peut être utilisé dans les pools.
deletefailed	string	L’utilisateur a demandé que le certificat soit supprimé, mais il existe des pools qui ont toujours des références au certificat, ou il est toujours installé sur un ou plusieurs nœuds. (Ce dernier peut se produire si le certificat a été supprimé du pool, mais que le nœud de calcul n’a pas encore redémarré. Les nœuds de calcul actualisent leurs certificats uniquement lorsqu’ils redémarrent.) Vous pouvez utiliser l’opération annuler la suppression du certificat pour annuler la suppression, ou l’opération supprimer le certificat pour réessayer la suppression.
deleting	string	L’utilisateur a demandé que le certificat soit supprimé, mais l’opération de suppression n’est pas encore terminée. Vous ne pouvez pas référencer le certificat lors de la création ou de la mise à jour de pools.

DeleteCertificateError

Erreur rencontrée par le service Batch lors de la suppression d’un certificat.

Nom	Type	Description
code	string	Identificateur de l’erreur de suppression de certificat. Les codes sont invariants et sont destinés à être consommés par programmation.
message	string	Message décrivant l’erreur de suppression de certificat, destiné à être affiché dans une interface utilisateur.
values	NameValuePair[]	Liste des détails d’erreur supplémentaires liés à l’erreur de suppression de certificat. Cette liste inclut des détails tels que les pools actifs et les nœuds de calcul référençant ce certificat. Toutefois, si un grand nombre de ressources font référence au certificat, la liste ne contient qu’environ la première centaine.

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.

NameValuePair

Représente une paire nom-valeur.

Nom	Type	Description
name	string	Nom dans la paire nom-valeur.
value	string	Valeur dans la paire nom-valeur.

Certificate - Get

Paramètres URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Scopes

Authorization

Exemples

Certificate get

Sample Request

Sample Response

Définitions

BatchError

BatchErrorDetail

Certificate

CertificateState

DeleteCertificateError

ErrorMessage

NameValuePair

Ressources supplémentaires