Certificate - List

Referência

Serviço:: Batch Service

Versão da API:: 2024-07-01.20.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 vez disso, use o de Extensão do Azure KeyVault .

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
api-version	query	True	string	Versão da API do cliente.
$filter	query		string	Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Uma cláusula $select OData.
maxresults	query		integer int32	O número máximo de itens a serem retornados na resposta. Um máximo de 1000 certificados pode ser retornado.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar a ID de solicitação do cliente na resposta.
ocp-date		string date-time-rfc1123	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Nome

Tipo

Description

200 OK

CertificateListResult

Uma resposta que contém a lista de Certificados.

Cabeçalhos

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

Other Status Codes

O erro do serviço do Lote.

Segurança

azure_auth

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

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Certificate list

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
BatchError	Uma resposta de erro recebida do serviço do Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
Certificate	Um Certificado que pode ser instalado em Nós de Computação e pode ser usado 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 do Lote ao excluir um Certificado.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
NameValuePair	Representa um par nome-valor.

BatchError

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Nome	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
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 pode ser usado para autenticar operações no computador.

Nome	Tipo	Description
deleteCertificateError	DeleteCertificateError	O erro que ocorreu na última tentativa de excluir esse Certificado. Essa propriedade será definida somente se o Certificado estiver no estado DeleteFailed.
previousState	CertificateState	O estado anterior do Certificado. Essa propriedade não será definida se o Certificado estiver em seu estado ativo inicial.
previousStateTransitionTime	string	A hora em que o Certificado inseriu seu estado anterior. Essa propriedade não será definida se o Certificado estiver em seu estado ativo inicial.
publicData	string	A parte pública do Certificado como um arquivo de .cer codificado em base 64.
state	CertificateState	O estado atual do Certificado.
stateTransitionTime	string	A hora em que o Certificado inseriu seu estado atual.
thumbprint	string	A impressão digital X.509 do Certificado. Esta é uma sequência de até 40 dígitos hexadecimais.
thumbprintAlgorithm	string	O algoritmo usado para derivar a impressão digital.
url	string	A URL do Certificado.

CertificateListResult

O resultado da listagem dos Certificados na Conta.

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

CertificateState

O estado do Certificado.

Nome	Tipo	Description
active	string	O Certificado está disponível para uso em Pools.
deletefailed	string	O usuário solicitou que o Certificado fosse excluído, mas há pools que ainda têm referências ao Certificado ou ainda está instalado em um ou mais nós. (Este último poderá ocorrer se o Certificado tiver sido removido do pool, mas o Nó de Computação ainda não foi reiniciado. Nós de computação atualizam seus certificados somente quando reiniciam.) Você pode usar a operação cancelar exclusão de certificado para cancelar a exclusão ou a operação excluir Certificado para tentar novamente a exclusão.
deleting	string	O usuário solicitou que o Certificado fosse excluído, mas a operação de exclusão ainda não foi concluída. Talvez você não faça referência ao Certificado ao criar ou atualizar pools.

DeleteCertificateError

Um erro encontrado pelo serviço do Lote ao excluir um Certificado.

Nome	Tipo	Description
code	string	Um identificador para o erro de exclusão de certificado. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro de exclusão de certificado, destinada a ser adequada para exibição em uma interface do usuário.
values	NameValuePair[]	Uma lista de detalhes de erro adicionais relacionados ao erro de exclusão de certificado. Essa lista inclui detalhes como pools ativos e nós de computação que fazem referência a esse Certificado. No entanto, se um grande número de recursos fizer referência ao Certificado, a lista conterá apenas cerca de cem primeiros.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

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

NameValuePair

Representa um par nome-valor.

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