Certificate - List

Riferimento

Servizio:: Batch Service

Versione API:: 2024-07-01.20.0

Elenca tutti i certificati aggiunti all'account specificato.
Avviso: questa operazione è deprecata e verrà rimossa dopo febbraio 2024. Usare invece 'estensione Azure KeyVault.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del servizio Azure Batch.
api-version	query	True	string	Versione dell'API client.
$filter	query		string	Clausola di $filter OData. Per altre informazioni sulla creazione di questo filtro, vedere https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Clausola di $select OData.
maxresults	query		integer int32	Numero massimo di elementi da restituire nella risposta. È possibile restituire un massimo di 1000 certificati.
timeout	query		integer int32	Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string uuid	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string date-time-rfc1123	Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome

Tipo

Descrizione

200 OK

CertificateListResult

Risposta contenente l'elenco dei certificati.

Intestazioni

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

Other Status Codes

Errore del servizio Batch.

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Certificate list

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
Certificate	Un certificato che può essere installato nei nodi di calcolo e può essere usato per autenticare le operazioni nel computer.
CertificateListResult	Risultato dell'elenco dei certificati nell'account.
CertificateState	Stato del certificato.
DeleteCertificateError	Errore rilevato dal servizio Batch durante l'eliminazione di un certificato.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
NameValuePair	Rappresenta una coppia nome-valore.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

Certificate

Un certificato che può essere installato nei nodi di calcolo e può essere usato per autenticare le operazioni nel computer.

Nome	Tipo	Descrizione
deleteCertificateError	DeleteCertificateError	Errore che si è verificato nell'ultimo tentativo di eliminare il certificato. Questa proprietà viene impostata solo se il certificato è nello stato DeleteFailed.
previousState	CertificateState	Stato precedente del certificato. Questa proprietà non è impostata se il certificato è nello stato attivo iniziale.
previousStateTransitionTime	string	Ora in cui il certificato ha immesso lo stato precedente. Questa proprietà non è impostata se il certificato è nello stato Attivo iniziale.
publicData	string	Parte pubblica del certificato come file con codifica base 64 .cer.
state	CertificateState	Stato corrente del certificato.
stateTransitionTime	string	Ora in cui il certificato ha immesso lo stato corrente.
thumbprint	string	Identificazione personale X.509 del certificato. Si tratta di una sequenza di fino a 40 cifre esadecimale.
thumbprintAlgorithm	string	Algoritmo utilizzato per derivare l'identificazione personale.
url	string	URL del certificato.

CertificateListResult

Risultato dell'elenco dei certificati nell'account.

Nome	Tipo	Descrizione
odata.nextLink	string	URL per ottenere il set di risultati successivo.
value	Certificate[]	Elenco di certificati.

CertificateState

Stato del certificato.

Nome	Tipo	Descrizione
active	string	Il certificato è disponibile per l'uso nei pool.
deletefailed	string	L'utente ha richiesto l'eliminazione del certificato, ma sono presenti pool che dispongono ancora di riferimenti al certificato o che è ancora installato in uno o più nodi. Quest'ultimo può verificarsi se il certificato è stato rimosso dal pool, ma il nodo di calcolo non è ancora stato riavviato. I nodi di calcolo aggiornano i certificati solo al riavvio. È possibile utilizzare l'operazione di annullamento dell'eliminazione del certificato per annullare l'eliminazione o l'operazione di eliminazione del certificato per ritentare l'eliminazione.
deleting	string	L'utente ha richiesto l'eliminazione del certificato, ma l'operazione di eliminazione non è ancora stata completata. Non è possibile fare riferimento al certificato durante la creazione o l'aggiornamento di pool.

DeleteCertificateError

Errore rilevato dal servizio Batch durante l'eliminazione di un certificato.

Nome	Tipo	Descrizione
code	string	Identificatore per l'errore di eliminazione del certificato. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	string	Messaggio che descrive l'errore di eliminazione del certificato, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	NameValuePair[]	Elenco di dettagli aggiuntivi sull'errore di errore correlati all'errore di eliminazione del certificato. Questo elenco include dettagli, ad esempio i pool attivi e i nodi di calcolo che fanno riferimento a questo certificato. Tuttavia, se un numero elevato di risorse fa riferimento al certificato, l'elenco contiene solo circa il primo centinaio.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.

NameValuePair

Rappresenta una coppia nome-valore.

Nome	Tipo	Descrizione
name	string	Nome nella coppia nome-valore.
value	string	Valore nella coppia nome-valore.