Certificate - List By Batch Account

Služba:
Batch Management
Verze rozhraní API:
2024-07-01

Zobrazí seznam všech certifikátů v zadaném účtu.
Upozornění: Tato operace je zastaralá a bude odebrána po únoru 2024. Místo toho použijte rozšíření Azure KeyVault.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates?api-version=2024-07-01
S volitelnými parametry: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates?api-version=2024-07-01&maxresults={maxresults}&$select={$select}&$filter={$filter}

Parametry identifikátoru URI

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

string

minLength: 3
maxLength: 24
pattern: ^[a-zA-Z0-9]+$

Název pro batch účet, který musí být v rámci regionu jedinečný. Dávkové názvy účtů musí mít délku mezi 3 a 24 znaky a musí používat pouze čísla a malá písmena. Toto jméno se používá jako součást DNS jména, které slouží k přístupu k dávkové službě v regionu, kde je účet vytvořen. Například: http://accountname.region.batch.azure.com/.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId
 path True

string (uuid)

ID cílového předplatného. Hodnota musí být UUID.
api-version
 query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.
$filter
 query

string

Výraz filtru OData Platné vlastnosti pro filtrování jsou properties/provisioningState, properties/provisioningStateTransitionTime, name.
$select
 query

string

Čárkami oddělený seznam vlastností, které by se měly vrátit. například "properties/provisioningState". Pouze vlastnosti nejvyšší úrovně v rámci vlastností/ jsou platné pro výběr.
maxresults
 query

integer (int32)

Maximální počet položek, které se mají vrátit v odpovědi.

Odpovědi

Name Typ Description
200 OK

ListCertificatesResult

Operace Azure byla úspěšně dokončena.
Other Status Codes

CloudError

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

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

Rozsahy

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

Příklady

ListCertificates
ListCertificates - Filter and Select

ListCertificates

Ukázkový požadavek

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificates?api-version=2024-07-01

Ukázková odpověď

Stavový kód:
200 
{
  "nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates?api-version=2024-07-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse",
  "value": [
    {
      "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
      "type": "Microsoft.Batch/batchAccounts/certificates",
      "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
      "properties": {
        "format": "Pfx",
        "provisioningState": "Succeeded",
        "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
        "publicData": "MIICrjCCAZagAwI...",
        "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
        "thumbprintAlgorithm": "sha1"
      }
    }
  ]
}

ListCertificates - Filter and Select

Ukázkový požadavek

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificates?api-version=2024-07-01&$select=properties/format,properties/provisioningState&$filter=properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'

Ukázková odpověď

Stavový kód:
200 
{
  "value": [
    {
      "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
      "type": "Microsoft.Batch/batchAccounts/certificates",
      "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
      "properties": {
        "format": "Pfx",
        "provisioningState": "Failed"
      }
    },
    {
      "name": "sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1",
      "type": "Microsoft.Batch/batchAccounts/certificates",
      "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1",
      "properties": {
        "format": "Cer",
        "provisioningState": "Failed"
      }
    }
  ]
}

Definice

Name Description
Certificate

Obsahuje informace o certifikátu.
CertificateFormat

Formát certifikátu – Pfx nebo Cer. Pokud tuto hodnotu vynecháte, výchozí hodnota je Pfx.
CertificateProvisioningState

Aktuální stav provisioningu certifikátu.
CloudError

Odpověď na chybu ze služby Batch
CloudErrorBody

Odpověď na chybu ze služby Batch
createdByType

Typ identity, která prostředek vytvořila.
DeleteCertificateError

Odpověď na chybu ze služby Batch
ListCertificatesResult

Hodnoty vrácené operací Seznam
systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Certificate

Objekt

Obsahuje informace o certifikátu.

Name Typ Description
etag

string

ETag prostředku, který se používá pro příkazy souběžnosti.
id

string (arm-id)

Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Název prostředku
properties.deleteCertificateError

DeleteCertificateError

Chyba, ke které došlo při odstraňování certifikátu
Tato hodnota se vrátí pouze v případě, že je stav zřizování certifikátu neúspěšný.
properties.format

CertificateFormat

Formát certifikátu – Pfx nebo Cer. Pokud tuto hodnotu vynecháte, výchozí hodnota je Pfx.
properties.previousProvisioningState

CertificateProvisioningState

Předchozí zřízený stav prostředku
properties.previousProvisioningStateTransitionTime

string (date-time)

Čas, kdy certifikát vstoupil do předchozího stavu.
Čas, kdy certifikát vstoupil do předchozího stavu.
properties.provisioningState

CertificateProvisioningState

Zřízený stav prostředku
Zřízený stav prostředku
properties.provisioningStateTransitionTime

string (date-time)

Čas, kdy certifikát zadal svůj aktuální stav.
Čas, kdy certifikát zadal svůj aktuální stav.
properties.publicData

string

Veřejný klíč certifikátu.
properties.thumbprint

string

Kryptografický otisk certifikátu.
Musí se shodovat s kryptografickým otiskem z názvu.
properties.thumbprintAlgorithm

string

Algoritmus kryptografického otisku certifikátu.
Musí se shodovat s první částí názvu certifikátu. V současné době se vyžaduje, aby byl SHA1.
systemData

systemData

Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags

object

Značky prostředku.
type

string

Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

CertificateFormat

Výčet

Formát certifikátu – Pfx nebo Cer. Pokud tuto hodnotu vynecháte, výchozí hodnota je Pfx.

Hodnota Description
Pfx

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

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

CertificateProvisioningState

Výčet

Aktuální stav provisioningu certifikátu.

Hodnota Description
Succeeded

Certifikát je k dispozici pro použití ve fondech.
Deleting

Uživatel požádal o odstranění certifikátu, ale operace odstranění ještě nebyla dokončena. Při vytvářeníneboch
Failed

Uživatel požádal o odstranění certifikátu, ale stále existují fondy s odkazy na certifikát nebo je stále nainstalovaný na jednom nebo několika výpočetních uzlech. (K tomu může dojít, pokud byl certifikát odebrán z fondu, ale uzel se ještě nerestartoval. Uzly aktualizují certifikáty pouze při restartování.) Operaci zrušení odstranění certifikátu můžete použít ke zrušení odstranění nebo operaci odstranění certifikátu k opakování odstranění.

CloudError

Objekt

Odpověď na chybu ze služby Batch

Name Typ Description
error

CloudErrorBody

Text odpovědi na chybu.

CloudErrorBody

Objekt

Odpověď na chybu ze služby Batch

Name Typ Description
code

string

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

CloudErrorBody[]

Seznam dalších podrobností o chybě
message

string

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

string

Cíl konkrétní chyby. Například název vlastnosti v chybě.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota Description
User
Application
ManagedIdentity
Key

DeleteCertificateError

Objekt

Odpověď na chybu ze služby Batch

Name Typ Description
code

string

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

DeleteCertificateError[]

Seznam dalších podrobností o chybě
message

string

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

string

Cíl konkrétní chyby. Například název vlastnosti v chybě.

ListCertificatesResult

Objekt

Hodnoty vrácené operací Seznam

Name Typ Description
nextLink

string (uri)

Odkaz na další stránku položek
value

Certificate[]

Položky certifikátu na této stránce

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).
createdBy

string

Identita, která prostředek vytvořila.
createdByType

createdByType

Typ identity, která prostředek vytvořila.
lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)
lastModifiedBy

string

Identita, která naposledy změnila prostředek.
lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.