Certificate - List

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.0

Listet alle Zertifikate auf, die dem angegebenen Konto hinzugefügt wurden.
Warnung: Dieser Vorgang ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung.

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

Mit optionalen Parametern:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
api-version	query	True	string	Client-API-Version.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Eine OData-$select-Klausel.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Zertifikate können zurückgegeben werden.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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 Clientanforderungs-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

CertificateListResult

Eine Antwort, die die Liste der Zertifikate enthält.

Header

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

Other Status Codes

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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 list

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	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.
CertificateListResult	Das Ergebnis der Auflistung der Zertifikate im Konto.
CertificateState	Der Status des Zertifikats.
DeleteCertificateError	Fehler beim Löschen eines Zertifikats durch den Batchdienst.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
NameValuePair	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 sollen programmgesteuert genutzt werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

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	DeleteCertificateError	Der Fehler, der beim letzten Versuch aufgetreten ist, dieses Zertifikat zu löschen. Diese Eigenschaft wird nur festgelegt, wenn sich das Zertifikat im Zustand "DeleteFailed" befindet.
previousState	CertificateState	Der vorherige Status des Zertifikats. Diese Eigenschaft wird nicht festgelegt, wenn sich das Zertifikat im anfangs aktiven Zustand befindet.
previousStateTransitionTime	string	Die Uhrzeit, zu der das Zertifikat seinen vorherigen Zustand eingegeben hat. Diese Eigenschaft wird nicht festgelegt, wenn sich das Zertifikat im anfangs aktiven Zustand befindet.
publicData	string	Der öffentliche Teil des Zertifikats als base64-codierte .cer Datei.
state	CertificateState	Der aktuelle Status des Zertifikats.
stateTransitionTime	string	Die Uhrzeit, zu der das Zertifikat seinen aktuellen Status eingegeben hat.
thumbprint	string	Der X.509-Fingerabdruck des Zertifikats. Dies ist eine Abfolge von bis zu 40 Hexziffern.
thumbprintAlgorithm	string	Der Algorithmus, der zum Ableiten des Fingerabdrucks verwendet wird.
url	string	Die URL des Zertifikats.

CertificateListResult

Das Ergebnis der Auflistung der Zertifikate im Konto.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	Certificate[]	Die Liste der Zertifikate.

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 angefordert, dass das Zertifikat gelöscht wird, aber es gibt Pools, die weiterhin Verweise auf das Zertifikat haben, oder es wird weiterhin auf einem oder mehreren Knoten installiert. (Letzteres kann auftreten, wenn das Zertifikat aus dem Pool entfernt wurde, aber der Computeknoten 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 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 wird, 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 Batchdienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler beim Löschen des Zertifikats. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	string	Eine Meldung zur Beschreibung des Zertifikatlöschfehlers, die für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	NameValuePair[]	Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Zertifikatlöschfehler. Diese Liste enthält Details wie die aktiven Pools und Computeknoten, die auf dieses Zertifikat verweisen. Wenn jedoch eine große Anzahl von Ressourcen auf das Zertifikat verweist, enthält die Liste nur etwa das erste Hundert.

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 Nachricht.

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.