Certificate - List

Referentie

Service:: Batch Service

API-versie:: 2024-07-01.20.0

Geeft een lijst weer van alle certificaten die zijn toegevoegd aan het opgegeven account.
Waarschuwing: deze bewerking is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie.

GET {batchUrl}/certificates?api-version=2024-07-01.20.0

Met optionele parameters:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch-serviceaanvragen.
api-version	query	True	string	Client-API-versie.
$filter	query		string	Een OData-$filter-component. Zie https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificatesvoor meer informatie over het maken van dit filter.
$select	query		string	Een OData-$select-component.
maxresults	query		integer int32	Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er kunnen maximaal 1000 certificaten worden geretourneerd.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name

Type

Description

200 OK

CertificateListResult

Een antwoord met de lijst met certificaten.

Kopteksten

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

Other Status Codes

De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Certificate list

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
Certificate	Een certificaat dat kan worden geïnstalleerd op rekenknooppunten en kan worden gebruikt om bewerkingen op de computer te verifiëren.
CertificateListResult	Het resultaat van het weergeven van de certificaten in het account.
CertificateState	De status van het certificaat.
DeleteCertificateError	Er is een fout opgetreden door de Batch-service bij het verwijderen van een certificaat.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
NameValuePair	Vertegenwoordigt een naam-waardepaar.

BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

Certificate

Een certificaat dat kan worden geïnstalleerd op rekenknooppunten en kan worden gebruikt om bewerkingen op de computer te verifiëren.

Name	Type	Description
deleteCertificateError	DeleteCertificateError	De fout die is opgetreden bij de laatste poging om dit certificaat te verwijderen. Deze eigenschap is alleen ingesteld als het certificaat de status DeleteFailed heeft.
previousState	CertificateState	De vorige status van het certificaat. Deze eigenschap is niet ingesteld als het certificaat de initiële actieve status heeft.
previousStateTransitionTime	string	Het tijdstip waarop het certificaat de vorige status heeft ingevoerd. Deze eigenschap is niet ingesteld als het certificaat de oorspronkelijke actieve status heeft.
publicData	string	Het openbare deel van het certificaat als een met base 64 gecodeerd .cer-bestand.
state	CertificateState	De huidige status van het certificaat.
stateTransitionTime	string	Het tijdstip waarop het certificaat de huidige status heeft ingevoerd.
thumbprint	string	De X.509-vingerafdruk van het certificaat. Dit is een reeks van maximaal 40 hexe cijfers.
thumbprintAlgorithm	string	Het algoritme dat wordt gebruikt om de vingerafdruk af te leiden.
url	string	De URL van het certificaat.

CertificateListResult

Het resultaat van het weergeven van de certificaten in het account.

Name	Type	Description
odata.nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	Certificate[]	De lijst met certificaten.

CertificateState

De status van het certificaat.

Name	Type	Description
active	string	Het certificaat is beschikbaar voor gebruik in pools.
deletefailed	string	De gebruiker heeft gevraagd om het certificaat te verwijderen, maar er zijn pools die nog steeds verwijzingen naar het certificaat hebben of die nog steeds op een of meer knooppunten zijn geïnstalleerd. (Dit laatste kan gebeuren als het certificaat uit de pool is verwijderd, maar het rekenknooppunt nog niet opnieuw is opgestart. Rekenknooppunten vernieuwen hun certificaten alleen wanneer ze opnieuw worden opgestart.) U kunt de bewerking Voor het verwijderen van het certificaat annuleren gebruiken om het verwijderen te annuleren of de bewerking Certificaat verwijderen om het verwijderen opnieuw uit te voeren.
deleting	string	De gebruiker heeft gevraagd om het certificaat te verwijderen, maar de verwijderbewerking is nog niet voltooid. U mag niet verwijzen naar het certificaat bij het maken of bijwerken van pools.

DeleteCertificateError

Er is een fout opgetreden door de Batch-service bij het verwijderen van een certificaat.

Name	Type	Description
code	string	Een id voor de certificaatverwijderingsfout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	string	Een bericht met een beschrijving van de fout bij het verwijderen van het certificaat, bedoeld om te worden weergegeven in een gebruikersinterface.
values	NameValuePair[]	Een lijst met aanvullende foutdetails met betrekking tot de certificaatverwijderingsfout. Deze lijst bevat details zoals de actieve pools en rekenknooppunten die naar dit certificaat verwijzen. Als echter een groot aantal resources naar het certificaat verwijst, bevat de lijst slechts ongeveer de eerste honderd.

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

Name	Type	Description
name	string	De naam in het naam-waardepaar.
value	string	De waarde in het naam-waardepaar.