Certificate - List

Reference

Service:: Batch Service

API Version:: 2023-11-01.18.0

Zobrazí seznam všech certifikátů, které byly přidány do zadaného účtu.
Upozornění: Tato operace je zastaralá a po únoru 2024 se odebere. Místo toho použijte rozšíření Azure KeyVault .

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

With optional parameters:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.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 Azure Batch služby.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Klauzule $select OData.
maxresults	query		integer int32	Maximální počet položek, které se mají v odpovědi vrátit. Může se vrátit maximálně 1000 certifikátů.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

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, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Odpovědi

Name

Typ

Description

200 OK

CertificateListResult

Odpověď obsahující seznam certifikátů.

Headers

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

Other Status Codes

Chyba ze služby Batch.

Zabezpečení

azure_auth

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

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

Scopes

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

Authorization

Type: apiKey
In: header

Příklady

Certificate list

Sample Request

HTTP

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

Sample Response

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

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
Certificate	Certifikát, který je možné nainstalovat na výpočetní uzly a použít k ověřování operací na počítači.
CertificateListResult	Výsledek výpisu certifikátů v účtu.
CertificateState	Stav certifikátu.
DeleteCertificateError	Při odstraňování certifikátu došlo ve službě Batch k chybě.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
NameValuePair	Představuje dvojici název-hodnota.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

Certificate

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

Name	Typ	Description
deleteCertificateError	DeleteCertificateError	Chyba, ke které došlo při posledním pokusu o odstranění tohoto certifikátu. Tato vlastnost je nastavena pouze v případě, že je certifikát ve stavu DeleteFailed.
previousState	CertificateState	Předchozí stav certifikátu. Tato vlastnost není nastavena, pokud je certifikát v počátečním aktivním stavu.
previousStateTransitionTime	string	Čas, kdy certifikát vstoupil do předchozího stavu. Tato vlastnost není nastavena, pokud je certifikát v počátečním aktivním stavu.
publicData	string	Veřejná část certifikátu jako soubor .cer kódování base-64.
state	CertificateState	Aktuální stav certifikátu.
stateTransitionTime	string	Čas, kdy certifikát vstoupil do aktuálního stavu.
thumbprint	string	Kryptografický otisk X.509 certifikátu. Jedná se o sekvenci až 40 šestnáctkových číslic.
thumbprintAlgorithm	string	Algoritmus použitý k odvození kryptografického otisku.
url	string	Adresa URL certifikátu.

CertificateListResult

Výsledek výpisu certifikátů v účtu.

Name	Typ	Description
odata.nextLink	string	Adresa URL pro získání další sady výsledků
value	Certificate[]	Seznam certifikátů.

CertificateState

Stav certifikátu.

Name	Typ	Description
active	string	Certifikát je k dispozici pro použití ve fondech.
deletefailed	string	Uživatel požádal o odstranění certifikátu, ale existují fondy, které stále obsahují odkazy na certifikát, nebo je stále nainstalovaný na jednom nebo více uzlech. (K tomu může dojít, pokud byl certifikát odebrán z fondu, ale výpočetní uzel se ještě nerestartoval. Výpočetní uzly aktualizují svoje certifikáty jenom při restartování.) Odstranění můžete zrušit pomocí operace zrušení odstranění certifikátu nebo operaci odstranění certifikátu a zkusit odstranění zopakovat.
deleting	string	Uživatel požádal o odstranění certifikátu, ale operace odstranění ještě nebyla dokončena. Při vytváření nebo aktualizaci fondů nesmíte odkazovat na certifikát.

DeleteCertificateError

Při odstraňování certifikátu došlo ve službě Batch k chybě.

Name	Typ	Description
code	string	Identifikátor chyby odstranění certifikátu. Kódy jsou neutrální a mají být využívány programově.
message	string	Zpráva popisující chybu odstranění certifikátu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	NameValuePair[]	Seznam dalších podrobností o chybách souvisejících s chybou odstranění certifikátu Tento seznam obsahuje podrobnosti, jako jsou aktivní fondy a výpočetní uzly odkazující na tento certifikát. Pokud však na certifikát odkazuje velký počet prostředků, seznam obsahuje pouze zhruba prvních sto prostředků.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

NameValuePair

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Název ve dvojici název-hodnota.
value	string	Hodnota ve dvojici název-hodnota.