Certificate - Add
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=2023-11-01.18.0
POST {batchUrl}/certificates?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. |
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 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 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. explizit festlegen, 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 Hex-Ziffern (sie kann Leerzeichen enthalten, diese werden jedoch entfernt). |
thumbprintAlgorithm | True |
string |
Der Algorithmus, der zum Ableiten des Fingerabdrucks verwendet wird. Dies muss sha1 sein. |
certificateFormat |
Das Format der Zertifikatdaten. |
||
password |
string |
Das Kennwort für den Zugriff auf den privaten Schlüssel des Zertifikats. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
201 Created |
Die Anforderung an den Batch-Dienst war erfolgreich. 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 add
Beispielanforderung
POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0
{
"thumbprintAlgorithm": "sha1",
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"data": "#####...",
"certificateFormat": "pfx",
"password": "<ExamplePassword>"
}
Beispiel für eine Antwort
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 |
Das Format der Zertifikatdaten. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird. |
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, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält. |
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 |
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. |
thumbprint |
string |
Der X.509-Fingerabdruck des Zertifikats. Dies ist eine Sequenz von bis zu 40 Hex-Ziffern (sie kann Leerzeichen enthalten, diese werden jedoch 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 wird.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Meldung. |