Certificate - Add
Agrega un certificado a la cuenta especificada.
Advertencia: esta operación está en desuso y se quitará después de febrero de 2024. Use el de extensión de Azure KeyVault de
POST {batchUrl}/certificates?api-version=2024-07-01.20.0
POST {batchUrl}/certificates?timeout={timeout}&api-version=2024-07-01.20.0
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Dirección URL base de todas las solicitudes de servicio de Azure Batch. |
api-version
|
query | True |
string |
Versión de la API de cliente. |
timeout
|
query |
integer int32 |
Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar. |
Encabezado de la solicitud
Media Types: "application/json; odata=minimalmetadata"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Si el servidor debe devolver el client-request-id en la respuesta. |
|
ocp-date |
string date-time-rfc1123 |
Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST. |
Cuerpo de la solicitud
Media Types: "application/json; odata=minimalmetadata"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
data | True |
string |
Contenido codificado en base64 del certificado. El tamaño máximo es de 10 KB. |
thumbprint | True |
string |
Huella digital X.509 del certificado. Se trata de una secuencia de hasta 40 dígitos hexadecimales (puede incluir espacios, pero se quitan). |
thumbprintAlgorithm | True |
string |
Algoritmo que se usa para derivar la huella digital. Debe ser sha1. |
certificateFormat |
Formato de los datos del certificado. |
||
password |
string |
Contraseña para acceder a la clave privada del certificado. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
201 Created |
La solicitud al servicio Batch se realizó correctamente. Encabezados
|
|
Other Status Codes |
Error del servicio Batch. |
Seguridad
azure_auth
Flujo de código de autenticación de Microsoft Entra OAuth 2.0
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | Suplantar la cuenta de usuario |
Authorization
Tipo:
apiKey
En:
header
Ejemplos
Certificate add
Solicitud de ejemplo
POST account.region.batch.azure.com/certificates?api-version=2024-07-01.20.0
{
"thumbprintAlgorithm": "sha1",
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"data": "#####...",
"certificateFormat": "pfx",
"password": "<ExamplePassword>"
}
Respuesta de muestra
Definiciones
Nombre | Description |
---|---|
Batch |
Respuesta de error recibida del servicio Azure Batch. |
Batch |
Un elemento de información adicional incluida en una respuesta de error de Azure Batch. |
Certificate |
Certificado que se puede instalar en nodos de proceso y se puede usar para autenticar operaciones en la máquina. |
Certificate |
Formato de los datos del certificado. |
Error |
Mensaje de error recibido en una respuesta de error de Azure Batch. |
BatchError
Respuesta de error recibida del servicio Azure Batch.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación. |
message |
Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario. |
|
values |
Colección de pares clave-valor que contienen detalles adicionales sobre el error. |
BatchErrorDetail
Un elemento de información adicional incluida en una respuesta de error de Azure Batch.
Nombre | Tipo | Description |
---|---|---|
key |
string |
Identificador que especifica el significado de la propiedad Value. |
value |
string |
La información adicional incluida con la respuesta de error. |
CertificateAddParameter
Certificado que se puede instalar en nodos de proceso y se puede usar para autenticar operaciones en la máquina.
Nombre | Tipo | Description |
---|---|---|
certificateFormat |
Formato de los datos del certificado. |
|
data |
string |
Contenido codificado en base64 del certificado. El tamaño máximo es de 10 KB. |
password |
string |
Contraseña para acceder a la clave privada del certificado. |
thumbprint |
string |
Huella digital X.509 del certificado. Se trata de una secuencia de hasta 40 dígitos hexadecimales (puede incluir espacios, pero se quitan). |
thumbprintAlgorithm |
string |
Algoritmo que se usa para derivar la huella digital. Debe ser sha1. |
CertificateFormat
Formato de los datos del certificado.
Nombre | Tipo | Description |
---|---|---|
cer |
string |
El certificado es un certificado X.509 codificado en base64. |
pfx |
string |
El certificado es un certificado con formato PFX (PKCS#12) o una cadena de certificados. |
ErrorMessage
Mensaje de error recibido en una respuesta de error de Azure Batch.
Nombre | Tipo | Description |
---|---|---|
lang |
string |
El código de idioma del mensaje de error |
value |
string |
Texto del mensaje. |