Partilhar via

Certificate - Add

  • Referência
Serviço:
Batch Service
Versão da API:
2024-07-01.20.0

Adiciona um Certificado à Conta especificada.
Aviso: Esta operação foi preterida e será removida após fevereiro de 2024. Em vez disso, use o Azure KeyVault Extension.

POST {batchUrl}/certificates?api-version=2024-07-01.20.0
Com parâmetros opcionais: 
POST {batchUrl}/certificates?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.
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.

Corpo do Pedido

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

Name Necessário Tipo Description
data True

string

O conteúdo codificado em base64 do certificado. O tamanho máximo é de 10KB.
thumbprint True

string

A impressão digital X.509 do Certificado. Esta é uma sequência de até 40 dígitos hexadecimais (pode incluir espaços, mas estes são removidos).
thumbprintAlgorithm True

string

O algoritmo usado para derivar a impressão digital. Isso deve ser sha1.
certificateFormat

CertificateFormat

O formato dos dados do certificado.
password

string

A senha para acessar a chave privada do Certificado.
Isso deve ser omitido se o formato do certificado for cer.

Respostas

Name Tipo Description
201 Created

A solicitação para o serviço de lote foi bem-sucedida.

Cabeçalhos

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

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 add

Pedido de amostra

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



{
  "thumbprintAlgorithm": "sha1",
  "thumbprint": "0123456789abcdef0123456789abcdef01234567",
  "data": "#####...",
  "certificateFormat": "pfx",
  "password": "<ExamplePassword>"
}

Resposta da amostra

Código de estado:
201

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

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

O formato dos dados do certificado.
ErrorMessage

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

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.

CertificateAddParameter

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
certificateFormat

CertificateFormat

O formato dos dados do certificado.
data

string

O conteúdo codificado em base64 do certificado. O tamanho máximo é de 10KB.
password

string

A senha para acessar a chave privada do Certificado.
Isso deve ser omitido se o formato do certificado for cer.
thumbprint

string

A impressão digital X.509 do Certificado. Esta é uma sequência de até 40 dígitos hexadecimais (pode incluir espaços, mas estes são removidos).
thumbprintAlgorithm

string

O algoritmo usado para derivar a impressão digital. Isso deve ser sha1.

CertificateFormat

O formato dos dados do certificado.

Name Tipo Description
cer

string

O certificado é um certificado X.509 codificado em base64.
pfx

string

O Certificado é um Certificado formatado em PFX (PKCS#12) ou cadeia de Certificados.

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.