Certificate - Add

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Fügt dem angegebenen Konto ein Zertifikat hinzu.
Warnung: Dieser Vorgang ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung.

POST {batchUrl}/certificates?api-version=2024-07-01.20.0
Mit optionalen Parametern: 
POST {batchUrl}/certificates?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.
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.

Anforderungstext

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

Name Erforderlich Typ Beschreibung
data True

string

Der base64-codierte Inhalt des Zertifikats. Die maximale Größe beträgt 10 KB.
thumbprint True

string

Der X.509-Fingerabdruck des Zertifikats. Dies ist eine Sequenz von bis zu 40 Hexadezimierungen (es kann Leerzeichen enthalten, aber diese werden entfernt).
thumbprintAlgorithm True

string

Der Algorithmus, der zum Ableiten des Fingerabdrucks verwendet wird. Dies muss sha1 sein.
certificateFormat

CertificateFormat

Das Format der Zertifikatdaten.
password

string

Das Kennwort für den Zugriff auf den privaten Schlüssel des Zertifikats.
Dies muss weggelassen werden, wenn das Zertifikatformat cer ist.

Antworten

Name Typ Beschreibung
201 Created

Die Anforderung an den Batchdienst war erfolgreich.

Header

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

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 add

Beispielanforderung

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



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

Beispiel für eine Antwort

Statuscode:
201

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

Ein Zertifikat, das auf Computeknoten installiert werden kann und zum Authentifizieren von Vorgängen auf dem Computer verwendet werden kann.
CertificateFormat

Das Format der Zertifikatdaten.
ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

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.

CertificateAddParameter

Ein Zertifikat, das auf Computeknoten installiert werden kann und zum Authentifizieren von Vorgängen auf dem Computer verwendet werden kann.

Name Typ Beschreibung
certificateFormat

CertificateFormat

Das Format der Zertifikatdaten.
data

string

Der base64-codierte Inhalt des Zertifikats. Die maximale Größe beträgt 10 KB.
password

string

Das Kennwort für den Zugriff auf den privaten Schlüssel des Zertifikats.
Dies muss weggelassen werden, wenn das Zertifikatformat cer ist.
thumbprint

string

Der X.509-Fingerabdruck des Zertifikats. Dies ist eine Sequenz von bis zu 40 Hexadezimierungen (es kann Leerzeichen enthalten, aber diese werden entfernt).
thumbprintAlgorithm

string

Der Algorithmus, der zum Ableiten des Fingerabdrucks verwendet wird. Dies muss sha1 sein.

CertificateFormat

Das Format der Zertifikatdaten.

Name Typ Beschreibung
cer

string

Das Zertifikat ist ein base64-codiertes X.509-Zertifikat.
pfx

string

Das Zertifikat ist ein PFX (PKCS#12) formatiertes Zertifikat oder eine Zertifikatkette.

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.