Certificate - Get

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtém informações sobre o Certificado especificado.
Aviso: esta operação foi preterida e será removida após fevereiro de 2024. Em vez disso, use a Extensão do Azure KeyVault .

GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.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 Lote do Azure.
thumbprint	path	True	string	A impressão digital do Certificado a ser obtido.
thumbprintAlgorithm	path	True	string	O algoritmo usado para derivar o parâmetro de impressão digital. Isso deve ser sha1.
api-version	query	True	string	Versão da API do cliente.
$select	query		string	Uma cláusula OData $select.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	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 o client-request-id 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	Certificate	Uma resposta que contém o Certificado. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Nome

Tipo

Description

200 OK

Certificate

Uma resposta que contém o Certificado.

Headers

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

Other Status Codes

BatchError

O erro do serviço do Lote.

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

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Certificate get

Sample Request

HTTP

GET account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "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 Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro 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.
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 Lote do Azure.
NameValuePair	Representa um par nome-valor.

BatchError

Uma resposta de erro recebida do serviço 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 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 este 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.

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 tiver sido reiniciado. Os 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. Você não pode referenciar o 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. Esta lista inclui detalhes como pools ativos e nós de computação referenciando esse Certificado. No entanto, se um grande número de recursos referenciar o Certificado, a lista conterá apenas cerca de cem primeiros.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro 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.

Compartilhar via

Certificate - Get

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Scopes

Authorization

Exemplos

Certificate get

Sample Request

Sample Response

Definições

BatchError

BatchErrorDetail

Certificate

CertificateState

DeleteCertificateError

ErrorMessage

NameValuePair

Recursos adicionais