Certificate - Get
Ruft Informationen zum angegebenen Zertifikat ab.
Warnung: Dieser Vorgang ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .
GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?api-version=2023-11-01.18.0
GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
thumbprint
|
path | True |
string |
Der Fingerabdruck des abzurufenden Zertifikats. |
thumbprint
|
path | True |
string |
Der Algorithmus, der zum Ableiten des Fingerabdruckparameters verwendet wird. Dies muss sha1 sein. |
api-version
|
query | True |
string |
Client-API-Version. |
$select
|
query |
string |
Eine OData $select-Klausel. |
|
timeout
|
query |
integer int32 |
Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden. |
Anforderungsheader
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
client-request-id |
string uuid |
Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Gibt an, ob der Server die client-request-ID in der Antwort zurückgeben soll. |
|
ocp-date |
string date-time-rfc1123 |
Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die das Zertifikat enthält. Header
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Authorization
Typ:
apiKey
In:
header
Beispiele
Certificate get
Beispielanforderung
GET account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)?api-version=2023-11-01.18.0
Beispiel für eine Antwort
{
"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"
}
]
}
}
Definitionen
Name | Beschreibung |
---|---|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Certificate |
Ein Zertifikat, das auf Computeknoten installiert werden kann und zum Authentifizieren von Vorgängen auf dem Computer verwendet werden kann. |
Certificate |
Der Status des Zertifikats. |
Delete |
Fehler beim Löschen eines Zertifikats durch den Batch-Dienst. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde. |
Name |
Stellt ein Name-Wert-Paar dar. |
BatchError
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
message |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler. |
BatchErrorDetail
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt. |
value |
string |
Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind. |
Certificate
Ein Zertifikat, das auf Computeknoten installiert werden kann und zum Authentifizieren von Vorgängen auf dem Computer verwendet werden kann.
Name | Typ | Beschreibung |
---|---|---|
deleteCertificateError |
Der Fehler, der beim letzten Versuch aufgetreten ist, dieses Zertifikat zu löschen. |
|
previousState |
Der vorherige Status des Zertifikats. |
|
previousStateTransitionTime |
string |
Der Zeitpunkt, zu dem das Zertifikat in seinen vorherigen Zustand eingetreten ist. |
publicData |
string |
Der öffentliche Teil des Zertifikats als Base64-codierte .cer-Datei. |
state |
Der aktuelle Status des Zertifikats. |
|
stateTransitionTime |
string |
Der Zeitpunkt, zu dem das Zertifikat in seinen aktuellen Zustand gelangt ist. |
thumbprint |
string |
Der X.509-Fingerabdruck des Zertifikats. Dies ist eine Sequenz von bis zu 40 Hexadezimalstellen. |
thumbprintAlgorithm |
string |
Der Algorithmus, der zum Ableiten des Fingerabdrucks verwendet wird. |
url |
string |
Die URL des Zertifikats. |
CertificateState
Der Status des Zertifikats.
Name | Typ | Beschreibung |
---|---|---|
active |
string |
Das Zertifikat ist für die Verwendung in Pools verfügbar. |
deletefailed |
string |
Der Benutzer hat das Löschen des Zertifikats angefordert, aber es gibt Pools, die weiterhin Verweise auf das Zertifikat haben, oder es ist weiterhin auf einem oder mehreren Knoten installiert. (Letzteres kann auftreten, wenn das Zertifikat aus dem Pool entfernt wurde, der Computeknoten jedoch noch nicht neu gestartet wurde. Computeknoten aktualisieren ihre Zertifikate nur, wenn sie neu gestartet werden.) Sie können den Vorgang zum Löschen des Zertifikats abbrechen verwenden, um den Löschvorgang abzubrechen, oder den Vorgang zum Löschen des Zertifikats, um den Löschvorgang erneut zu versuchen. |
deleting |
string |
Der Benutzer hat angefordert, dass das Zertifikat gelöscht werden soll, aber der Löschvorgang wurde noch nicht abgeschlossen. Sie dürfen beim Erstellen oder Aktualisieren von Pools nicht auf das Zertifikat verweisen. |
DeleteCertificateError
Fehler beim Löschen eines Zertifikats durch den Batch-Dienst.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler beim Löschen des Zertifikats. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
message |
string |
Eine Meldung, die den Fehler beim Löschen des Zertifikats beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
values |
Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Zertifikatlöschfehler. |
ErrorMessage
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Meldung. |
NameValuePair
Stellt ein Name-Wert-Paar dar.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name im Name-Wert-Paar. |
value |
string |
Der Wert im Name-Wert-Paar. |