Certificate - List

Referencia

Service:: Batch Service

API Version:: 2023-11-01.18.0

Felsorolja a megadott fiókhoz hozzáadott összes tanúsítványt.
Figyelmeztetés: Ez a művelet elavult, és 2024 februárja után törlődik. Használja inkább az Azure KeyVault bővítményt .

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
api-version	query	True	string	Ügyfél API-verziója.
$filter	query		string	OData $filter záradék. A szűrő felépítésével kapcsolatos további információkért lásd: https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	OData $select záradék.
maxresults	query		integer int32	A válaszban visszaadandó elemek maximális száma. Legfeljebb 1000 tanúsítvány adható vissza.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Válaszok

Name

Típus

Description

200 OK

CertificateListResult

A tanúsítványok listáját tartalmazó válasz.

Headers

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

Other Status Codes

A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

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"
          }
        ]
      }
    }
  ]
}

Definíciók

Name	Description
BatchError	A Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail	A Azure Batch hibaválaszban szereplő további információk egy eleme.
Certificate	A számítási csomópontokra telepíthető tanúsítvány, amely a gépen végzett műveletek hitelesítésére használható.
CertificateListResult	A tanúsítványok fiókban való listázásának eredménye.
CertificateState	A tanúsítvány állapota.
DeleteCertificateError	A Batch szolgáltatás hibát észlelt a tanúsítvány törlésekor.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.
NameValuePair	Név-érték párokat jelöl.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Az Érték tulajdonság jelentését meghatározó azonosító.
value	string	A hibaválaszban szereplő további információk.

Certificate

A számítási csomópontokra telepíthető tanúsítvány, amely a gépen végzett műveletek hitelesítésére használható.

Name	Típus	Description
deleteCertificateError	DeleteCertificateError	A tanúsítvány törlésére tett utolsó kísérlet során előforduló hiba. Ez a tulajdonság csak akkor van beállítva, ha a tanúsítvány DeleteFailed állapotban van.
previousState	CertificateState	A tanúsítvány előző állapota. Ez a tulajdonság nincs beállítva, ha a tanúsítvány kezdeti aktív állapotban van.
previousStateTransitionTime	string	Az az időpont, amikor a tanúsítvány az előző állapotba lépett. Ez a tulajdonság nincs beállítva, ha a tanúsítvány kezdeti Aktív állapotban van.
publicData	string	A tanúsítvány nyilvános része base-64 kódolású .cer fájlként.
state	CertificateState	A tanúsítvány aktuális állapota.
stateTransitionTime	string	A tanúsítvány aktuális állapotának megadásának időpontja.
thumbprint	string	A tanúsítvány X.509 ujjlenyomata. Ez egy legfeljebb 40 hexa számjegyből álló sorozat.
thumbprintAlgorithm	string	Az ujjlenyomat származtatásához használt algoritmus.
url	string	A tanúsítvány URL-címe.

CertificateListResult

A tanúsítványok fiókban való listázásának eredménye.

Name	Típus	Description
odata.nextLink	string	A következő eredményhalmaz lekéréséhez tartozó URL-cím.
value	Certificate[]	A tanúsítványok listája.

CertificateState

A tanúsítvány állapota.

Name	Típus	Description
active	string	A tanúsítvány a készletekben használható.
deletefailed	string	A felhasználó kérte a tanúsítvány törlését, de vannak olyan készletek, amelyek továbbra is hivatkoznak a tanúsítványra, vagy még mindig telepítve van egy vagy több csomóponton. (Ez utóbbi akkor fordulhat elő, ha a tanúsítványt eltávolították a készletből, de a számítási csomópont még nem újraindult. A számítási csomópontok csak újraindításkor frissítik a tanúsítványaikat.) A törlés visszavonásához használhatja a Tanúsítvány törlése műveletet, vagy a Tanúsítvány törlése műveletet a törlés újrapróbálkozásához.
deleting	string	A felhasználó kérte a tanúsítvány törlését, de a törlési művelet még nem fejeződött be. Előfordulhat, hogy a készletek létrehozásakor vagy frissítésekor nem hivatkozik a tanúsítványra.

DeleteCertificateError

A Batch szolgáltatás hibát észlelt a tanúsítvány törlésekor.

Name	Típus	Description
code	string	A tanúsítvány törlési hibájának azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	string	A tanúsítványtörlési hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	NameValuePair[]	A tanúsítványtörléssel kapcsolatos további hibaadatok listája. Ez a lista olyan részleteket tartalmaz, mint a tanúsítványra hivatkozó aktív készletek és számítási csomópontok. Ha azonban sok erőforrás hivatkozik a tanúsítványra, a lista csak az első százat tartalmazza.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.

NameValuePair

Név-érték párokat jelöl.

Name	Típus	Description
name	string	A név-érték párban lévő név.
value	string	A név-érték párban lévő érték.