Certificate - List

Référence

Service:: Batch Service

Version d'API:: 2024-07-01.20.0

Répertorie tous les certificats qui ont été ajoutés 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.

GET {batchUrl}/certificates?api-version=2024-07-01.20.0

Avec des paramètres facultatifs:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&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.
$filter	query		string	Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Clause OData $select.
maxresults	query		integer int32	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 certificats peut être retourné.
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.

Réponses

Nom

Type

Description

200 OK

CertificateListResult

Réponse contenant la liste des certificats.

En-têtes

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

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 list

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "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	Certificat qui peut être installé sur les nœuds de calcul et qui peut être utilisé pour authentifier les opérations sur l’ordinateur.
CertificateListResult	Résultat de la liste des certificats dans le compte.
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 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.

Certificate

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
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 dans 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 a entré son état précédent. Cette propriété n’est pas définie si le certificat est dans son état actif initial.
publicData	string	Partie publique du certificat en tant que fichier .cer codé en base 64.
state	CertificateState	État actuel du certificat.
stateTransitionTime	string	Heure à laquelle le certificat a entré son état actuel.
thumbprint	string	Empreinte numérique 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.

CertificateListResult

Résultat de la liste des certificats dans le compte.

Nom	Type	Description
odata.nextLink	string	URL permettant d’obtenir le jeu de résultats suivant.
value	Certificate[]	Liste des certificats.

CertificateState

État du certificat.

Nom	Type	Description
active	string	Le certificat est disponible pour une utilisation 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 quand ils redémarrent.) Vous pouvez utiliser l’opération d’annulation de suppression de certificat pour annuler la suppression, ou l’opération supprimer le certificat pour réessayer la suppression.
deleting	string	L’utilisateur a demandé la suppression du certificat, mais l’opération de suppression n’a pas encore été effectué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 programme.
message	string	Message décrivant l’erreur de suppression de certificat, destiné à être adapté à l’affichage 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 contient seulement 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 de la paire nom-valeur.
value	string	Valeur de la paire nom-valeur.