Sdílet prostřednictvím

Certificate - Add

  • Reference
Služba:
Batch Service
Verze rozhraní API:
2024-07-01.20.0

Přidá certifikát do zadaného účtu.
Upozornění: Tato operace je zastaralá a bude odebrána po únoru 2024. Místo toho použijte rozšíření Azure KeyVault.

POST {batchUrl}/certificates?api-version=2024-07-01.20.0
S volitelnými parametry: 
POST {batchUrl}/certificates?timeout={timeout}&api-version=2024-07-01.20.0

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
batchUrl
 path True

string

Základní adresa URL pro všechny požadavky služby Azure Batch.
api-version
 query True

string

Verze rozhraní API klienta.
timeout
 query

integer

int32

Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

Hlavička požadavku

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

Name Vyžadováno Typ Description
client-request-id

string

uuid

Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date

string

date-time-rfc1123

Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Text požadavku

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

Name Vyžadováno Typ Description
data True

string

Obsah certifikátu s kódováním base64. Maximální velikost je 10 kB.
thumbprint True

string

Kryptografický otisk X.509 certifikátu. Jedná se o posloupnost až 40 šestnáctkových číslic (může obsahovat mezery, ale ty se odeberou).
thumbprintAlgorithm True

string

Algoritmus použitý k odvození kryptografického otisku. To musí být sha1.
certificateFormat

CertificateFormat

Formát dat certifikátu.
password

string

Heslo pro přístup k privátnímu klíči certifikátu.
Pokud je formát certifikátu cer, musí se tento parametr vynechat.

Odpovědi

Name Typ Description
201 Created

Požadavek na službu Batch byl úspěšný.

Hlavičky

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

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

Tok ověřovacího kódu Microsoft Entra OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

Certificate add

Ukázkový požadavek

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



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

Ukázková odpověď

Stavový kód:
201

Definice

Name Description
BatchError

Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
CertificateAddParameter

Certifikát, který se dá nainstalovat na výpočetní uzly a dá se použít k ověřování operací na počítači.
CertificateFormat

Formát dat certifikátu.
ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message

ErrorMessage

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values

BatchErrorDetail[]

Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name Typ Description
key

string

Identifikátor určující význam vlastnosti Value.
value

string

Další informace zahrnuté v odpovědi na chybu.

CertificateAddParameter

Certifikát, který se dá nainstalovat na výpočetní uzly a dá se použít k ověřování operací na počítači.

Name Typ Description
certificateFormat

CertificateFormat

Formát dat certifikátu.
data

string

Obsah certifikátu s kódováním base64. Maximální velikost je 10 kB.
password

string

Heslo pro přístup k privátnímu klíči certifikátu.
Pokud je formát certifikátu cer, musí se tento parametr vynechat.
thumbprint

string

Kryptografický otisk X.509 certifikátu. Jedná se o posloupnost až 40 šestnáctkových číslic (může obsahovat mezery, ale ty se odeberou).
thumbprintAlgorithm

string

Algoritmus použitý k odvození kryptografického otisku. To musí být sha1.

CertificateFormat

Formát dat certifikátu.

Name Typ Description
cer

string

Certifikát je certifikát X.509 s kódováním base64.
pfx

string

Certifikát je certifikát ve formátu PFX (PKCS#12) nebo řetěz certifikátů.

ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name Typ Description
lang

string

Kód jazyka chybové zprávy
value

string

Text zprávy.