Certificate - Add

Service:

Batch Service

API Version:

2023-11-01.18.0

Lägger till ett certifikat till det angivna kontot.
Varning! Den här åtgärden är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället.

POST {batchUrl}/certificates?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/certificates?timeout={timeout}&api-version=2023-11-01.18.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
api-version	query	True	string	Klient-API-version.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt.

Begärandetext

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

Name	Obligatorisk	Typ	Description
data	True	string	Det base64-kodade innehållet i certifikatet. Den maximala storleken är 10 KB.
thumbprint	True	string	X.509-tumavtrycket för certifikatet. Det här är en sekvens med upp till 40 hexsiffror (det kan innehålla blanksteg men dessa tas bort).
thumbprintAlgorithm	True	string	Algoritmen som används för att härleda tumavtrycket. Det här måste vara sha1.
certificateFormat		CertificateFormat	Formatet för certifikatdata.
password		string	Lösenordet för att komma åt certifikatets privata nyckel. Detta måste utelämnas om certifikatformatet är cer.

Svar

Name	Typ	Description
201 Created		Begäran till Batch-tjänsten lyckades. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Certificate add

Sample Request

HTTP

POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0



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

Sample Response

Status code:

201

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
CertificateAddParameter	Ett certifikat som kan installeras på beräkningsnoder och som kan användas för att autentisera åtgärder på datorn.
CertificateFormat	Formatet för certifikatdata.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

CertificateAddParameter

Ett certifikat som kan installeras på beräkningsnoder och som kan användas för att autentisera åtgärder på datorn.

Name	Typ	Description
certificateFormat	CertificateFormat	Formatet för certifikatdata.
data	string	Det base64-kodade innehållet i certifikatet. Den maximala storleken är 10 KB.
password	string	Lösenordet för att komma åt certifikatets privata nyckel. Detta måste utelämnas om certifikatformatet är cer.
thumbprint	string	X.509-tumavtrycket för certifikatet. Det här är en sekvens med upp till 40 hexsiffror (det kan innehålla blanksteg men dessa tas bort).
thumbprintAlgorithm	string	Algoritmen som används för att härleda tumavtrycket. Det här måste vara sha1.

CertificateFormat

Formatet för certifikatdata.

Name	Typ	Description
cer	string	Certifikatet är ett base64-kodat X.509-certifikat.
pfx	string	Certifikatet är en PFX-formaterad certifikat- eller certifikatkedja (PKCS#12).

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.