Certificate - Add

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 de Extensão do Azure KeyVault .

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

Corpo da solicitação

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

Nome	Obrigatório	Tipo	Description
data	True	string	O conteúdo codificado em base64 do Certificado. O tamanho máximo é de 10 KB.
thumbprint	True	string	A impressão digital X.509 do Certificado. Essa é uma sequência de até 40 dígitos hexadecimais (pode incluir espaços, mas eles 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 certificado for cer.

Respostas

Nome	Tipo	Description
201 Created		A solicitação para o serviço do 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 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 add

Solicitação de exemplo

HTTP

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



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

Resposta de exemplo

Código de status:

201

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.
CertificateAddParameter	Um Certificado que pode ser instalado em Nós de Computação e pode ser usado para autenticar operações no computador.
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 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.

CertificateAddParameter

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
certificateFormat	CertificateFormat	O formato dos dados do Certificado.
data	string	O conteúdo codificado em base64 do Certificado. O tamanho máximo é de 10 KB.
password	string	A senha para acessar a chave privada do Certificado. Isso deve ser omitido se o formato certificado for cer.
thumbprint	string	A impressão digital X.509 do Certificado. Essa é uma sequência de até 40 dígitos hexadecimais (pode incluir espaços, mas eles 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.

Nome	Tipo	Description
cer	string	O Certificado é um certificado X.509 codificado em base64.
pfx	string	O Certificado é uma cadeia de certificados ou certificados formatada em PFX (PKCS#12).

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.