Certificate - Add

  • Referência
Service:
Batch Service
API Version:
2023-11-01.18.0

Adiciona um Certificado à Conta especificada.
Aviso: esta operação foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault .

POST {batchUrl}/certificates?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/certificates?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.
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.

Corpo do Pedido

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

Name Necessário Tipo Description
data True

string

Os conteúdos codificados com base64 do Certificado. O tamanho máximo é de 10 KB.
thumbprint True

string

O thumbprint 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 utilizado para derivar o thumbprint. Tem de ser sha1.
certificateFormat

CertificateFormat

O formato dos dados do Certificado.
password

string

A palavra-passe para aceder à chave privada do Certificado.
Isto tem de ser omitido se o formato certificado for cer.

Respostas

Name Tipo Description
201 Created

O pedido ao serviço Batch foi efetuado com êxito.

Headers

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

BatchError

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 add

Sample Request

POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0



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

Sample Response

Status code:
201

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

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

O formato dos dados do Certificado.
ErrorMessage

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

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.

CertificateAddParameter

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
certificateFormat

CertificateFormat

O formato dos dados do Certificado.
data

string

Os conteúdos codificados com base64 do Certificado. O tamanho máximo é de 10 KB.
password

string

A palavra-passe para aceder à chave privada do Certificado.
Isto tem de ser omitido se o formato certificado for cer.
thumbprint

string

O thumbprint 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 utilizado para derivar o thumbprint. Tem de ser sha1.

CertificateFormat

O formato dos dados do Certificado.

Name Tipo Description
cer

string

O Certificado é um Certificado X.509 codificado com base64.
pfx

string

O Certificado é uma cadeia de Certificados ou Certificados formatada PFX (PKCS#12).

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.