Certificate - List

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Lista todos os Certificados que foram adicionados à Conta especificada.
Aviso: esta operação foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault .

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
api-version	query	True	string	Versão da API de Cliente.
$filter	query		string	Uma cláusula OData $filter. Para obter mais informações sobre a construção deste filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Uma cláusula OData $select.
maxresults	query		integer int32	O número máximo de itens a devolver na resposta. Pode ser devolvido um máximo de 1000 Certificados.
timeout	query		integer int32	O tempo máximo que o servidor pode passar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, na forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-o explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name

Tipo

Description

200 OK

CertificateListResult

Uma resposta que contém a lista de Certificados.

Headers

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

Other Status Codes

O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
Certificate	Um Certificado que pode ser instalado em Nós de Computação e que pode ser utilizado para autenticar operações no computador.
CertificateListResult	O resultado da listagem dos Certificados na Conta.
CertificateState	O estado do Certificado.
DeleteCertificateError	Um erro encontrado pelo serviço Batch ao eliminar um Certificado.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
NameValuePair	Representa um par name-value.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Valor.
value	string	As informações adicionais incluídas na resposta de erro.

Certificate

Um Certificado que pode ser instalado em Nós de Computação e que pode ser utilizado para autenticar operações no computador.

Name	Tipo	Description
deleteCertificateError	DeleteCertificateError	O erro que ocorreu na última tentativa de eliminar este Certificado. Esta propriedade só é definida se o Certificado estiver no estado DeleteFailed.
previousState	CertificateState	O estado anterior do Certificado. Esta propriedade não está definida se o Certificado estiver no estado ativo inicial.
previousStateTransitionTime	string	O momento em que o Certificado entrou no estado anterior. Esta propriedade não está definida se o Certificado estiver no estado Ativo inicial.
publicData	string	A parte pública do Certificado como um ficheiro de .cer codificado de base 64.
state	CertificateState	O estado atual do Certificado.
stateTransitionTime	string	O momento em que o Certificado entrou no estado atual.
thumbprint	string	O thumbprint X.509 do Certificado. Esta é uma sequência de até 40 dígitos hexadecimais.
thumbprintAlgorithm	string	O algoritmo utilizado para derivar o thumbprint.
url	string	O URL do Certificado.

CertificateListResult

O resultado da listagem dos Certificados na Conta.

Name	Tipo	Description
odata.nextLink	string	O URL para obter o próximo conjunto de resultados.
value	Certificate[]	A lista de Certificados.

CertificateState

O estado do Certificado.

Name	Tipo	Description
active	string	O Certificado está disponível para utilização em Conjuntos.
deletefailed	string	O utilizador pediu que o Certificado fosse eliminado, mas existem Conjuntos que ainda têm referências ao Certificado ou ainda estão instalados num ou mais Nós. (Este último pode ocorrer se o Certificado tiver sido removido do Conjunto, mas o Nó de Computação ainda não tiver sido reiniciado. Os Nós de Computação só atualizam os Certificados quando reiniciam.) Pode utilizar a operação cancelar Eliminação de certificados para cancelar a eliminação ou a operação eliminar Certificado para repetir a eliminação.
deleting	string	O utilizador pediu que o Certificado fosse eliminado, mas a operação de eliminação ainda não foi concluída. Pode não referenciar o Certificado ao criar ou atualizar Conjuntos.

DeleteCertificateError

Um erro encontrado pelo serviço Batch ao eliminar um Certificado.

Name	Tipo	Description
code	string	Um identificador para o erro de eliminação do Certificado. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro de eliminação de certificados, que se destina a ser adequado para apresentação numa interface de utilizador.
values	NameValuePair[]	Uma lista de detalhes de erro adicionais relacionados com o erro de eliminação de certificados. Esta lista inclui detalhes como conjuntos ativos e Nós de Computação que fazem referência a este Certificado. No entanto, se um grande número de recursos referenciar o Certificado, a lista contém apenas cerca de cem.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

NameValuePair

Representa um par name-value.

Name	Tipo	Description
name	string	O nome no par name-value.
value	string	O valor no par name-value.