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 Azure KeyVault Extension.

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 do URI

Name	Em	Necessá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://docs.microsoft.com/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 serem retornados na resposta. Um máximo de 1000 certificados podem ser devolvidos.
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 do Pedido

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

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

Respostas

Name

Tipo

Description

200 OK

CertificateListResult

Uma resposta contendo 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 de lote.

Segurança

azure_auth

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

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

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Certificate list

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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 Batch 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 na máquina.
CertificateListResult	O resultado da listagem dos Certificados na Conta.
CertificateState	O estado do certificado.
DeleteCertificateError	Um erro encontrado pelo serviço de 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 Batch do Azure.

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 descrevendo 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.

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

Certificate

Um certificado que pode ser instalado em nós de computação e pode ser usado para autenticar operações na máquina.

Name	Tipo	Description
deleteCertificateError	DeleteCertificateError	O erro que ocorreu na última tentativa de excluir este certificado. Esta propriedade é definida somente se o certificado estiver no estado DeleteFailed.
previousState	CertificateState	O estado anterior do certificado. Esta propriedade não é definida se o certificado estiver em seu estado ativo inicial.
previousStateTransitionTime	string	A hora em que o Certificado entrou no seu estado anterior. Esta propriedade não é 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 entrou no 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.

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 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 ele ainda está instalado em um ou mais Nós. (Este último pode ocorrer se o certificado tiver sido removido do pool, mas o nó de computação ainda não tiver sido reiniciado. Os nós de computação atualizam seus certificados somente quando são reiniciados.) 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. Você não pode fazer referência ao Certificado ao criar ou atualizar Pools.

DeleteCertificateError

Um erro encontrado pelo serviço de lote ao excluir um certificado.

Name	Tipo	Description
code	string	Um identificador para o erro de exclusão de certificado. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem descrevendo o erro de exclusão de certificado, destinado a ser adequado 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. Esta lista inclui detalhes como os Pools ativos e os Nós de Computação que fazem referência a este Certificado. No entanto, se um grande número de recursos fizer referência ao Certificado, a lista conterá apenas cerca dos primeiros cem.

ErrorMessage

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

Name	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.

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