Dela via


Certificate - Get

Hämtar information om det angivna certifikatet.
Varning! Den här åtgärden är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället.

GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?api-version=2024-07-01.20.0
GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?$select={$select}&timeout={timeout}&api-version=2024-07-01.20.0

URI-parametrar

Name I Obligatorisk Typ Description
batchUrl
path True

string

Bas-URL:en för alla Azure Batch-tjänstbegäranden.

thumbprint
path True

string

Tumavtrycket för certifikatet som ska hämtas.

thumbprintAlgorithm
path True

string

Algoritmen som används för att härleda tumavtrycksparametern. Det här måste vara sha1.

api-version
query True

string

Klient-API-version.

$select
query

string

En OData-$select-sats.

timeout
query

integer (int32)

Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

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 explicit om du anropar REST-API:et direkt.

Svar

Name Typ Description
200 OK

Certificate

Ett svar som innehåller certifikatet.

Sidhuvuden

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

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Certificate get

Exempelbegäran

GET account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)?api-version=2024-07-01.20.0


Exempelsvar

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

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.

Certificate

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

CertificateState

Certifikatets tillstånd.

DeleteCertificateError

Ett fel påträffades av Batch-tjänsten när du tar bort ett certifikat.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

NameValuePair

Representerar ett namn/värde-par.

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.

Certificate

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

Name Typ Description
deleteCertificateError

DeleteCertificateError

Felet som inträffade vid det senaste försöket att ta bort det här certifikatet.
Den här egenskapen anges endast om certifikatet är i tillståndet DeleteFailed.

previousState

CertificateState

Certifikatets tidigare tillstånd.
Den här egenskapen anges inte om certifikatet är i sitt ursprungliga aktiva tillstånd.

previousStateTransitionTime

string (date-time)

Den tidpunkt då certifikatet övergick till sitt tidigare tillstånd.
Den här egenskapen anges inte om certifikatet är i sitt ursprungliga aktiva tillstånd.

publicData

string

Den offentliga delen av certifikatet som en base-64-kodad .cer fil.

state

CertificateState

Certifikatets aktuella tillstånd.

stateTransitionTime

string (date-time)

Den tid då certifikatet övergick till sitt aktuella tillstånd.

thumbprint

string

X.509-tumavtrycket för certifikatet. Det här är en sekvens med upp till 40 hexsiffror.

thumbprintAlgorithm

string

Algoritmen som används för att härleda tumavtrycket.

url

string

Certifikatets URL.

CertificateState

Certifikatets tillstånd.

Värde Description
active

Certifikatet är tillgängligt för användning i pooler.

deletefailed

Användaren begärde att certifikatet skulle tas bort, men det finns pooler som fortfarande har referenser till certifikatet, eller så är det fortfarande installerat på en eller flera noder. (Det senare kan inträffa om certifikatet har tagits bort från poolen, men beräkningsnoden ännu inte har startats om. Beräkningsnoder uppdaterar endast sina certifikat när de startas om.) Du kan använda åtgärden Avbryt borttagning av certifikat för att avbryta borttagningen eller ta bort certifikatåtgärden för att försöka ta bort igen.

deleting

Användaren har begärt att certifikatet ska tas bort, men borttagningsåtgärden har ännu inte slutförts. Du kanske inte refererar till certifikatet när du skapar eller uppdaterar pooler.

DeleteCertificateError

Ett fel påträffades av Batch-tjänsten när du tar bort ett certifikat.

Name Typ Description
code

string

En identifierare för fel vid borttagning av certifikat. Koder är invarianta och är avsedda att användas programmatiskt.

message

string

Ett meddelande som beskriver certifikatborttagningsfelet, som är avsett att vara lämpligt för visning i ett användargränssnitt.

values

NameValuePair[]

En lista med ytterligare felinformation som rör borttagningsfelet för certifikatet.
Den här listan innehåller information som aktiva pooler och beräkningsnoder som refererar till det här certifikatet. Men om ett stort antal resurser refererar till certifikatet innehåller listan bara cirka de första hundra.

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.

NameValuePair

Representerar ett namn/värde-par.

Name Typ Description
name

string

Namnet i namn/värde-paret.

value

string

Värdet i namn/värde-paret.