Certificate - Get

Referencia

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtiene información sobre el certificado especificado.
Advertencia: esta operación está en desuso y se quitará después de febrero de 2024. Use la extensión Azure KeyVault en su lugar.

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 identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
thumbprint	path	True	string	Huella digital del certificado que se va a obtener.
thumbprintAlgorithm	path	True	string	Algoritmo utilizado para derivar el parámetro de huella digital. Debe ser sha1.
api-version	query	True	string	Versión de la API de cliente.
$select	query		string	Una cláusula $select de OData.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

Nombre	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 a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	Certificate	Respuesta que contiene el certificado. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Error del servicio Batch.

Nombre

Tipo

Description

200 OK

Certificate

Respuesta que contiene el certificado.

Headers

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

Other Status Codes

BatchError

Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

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"
      }
    ]
  }
}

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
Certificate	Un certificado que se puede instalar en nodos de proceso y se puede usar para autenticar operaciones en la máquina.
CertificateState	Estado del certificado.
DeleteCertificateError	Error detectado por el servicio Batch al eliminar un certificado.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
NameValuePair	Representa un par nombre-valor.

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	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error 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.

Certificate

Un certificado que se puede instalar en nodos de proceso y se puede usar para autenticar operaciones en la máquina.

Nombre	Tipo	Description
deleteCertificateError	DeleteCertificateError	Error que se produjo en el último intento de eliminar este certificado. Esta propiedad solo se establece si el certificado está en estado DeleteFailed.
previousState	CertificateState	Estado anterior del certificado. Esta propiedad no se establece si el certificado está en su estado activo inicial.
previousStateTransitionTime	string	Hora en la que el certificado entró en su estado anterior. Esta propiedad no se establece si el certificado está en su estado activo inicial.
publicData	string	La parte pública del certificado como un archivo de .cer codificado en base 64.
state	CertificateState	Estado actual del certificado.
stateTransitionTime	string	Hora a la que el certificado entró en su estado actual.
thumbprint	string	Huella digital X.509 del certificado. Se trata de una secuencia de hasta 40 dígitos hexadecimales.
thumbprintAlgorithm	string	Algoritmo utilizado para derivar la huella digital.
url	string	Dirección URL del certificado.

CertificateState

Estado del certificado.

Nombre	Tipo	Description
active	string	El certificado está disponible para su uso en grupos.
deletefailed	string	El usuario solicitó que se elimine el certificado, pero hay grupos que todavía tienen referencias al certificado o que todavía están instalados en uno o varios nodos. (Esto último puede ocurrir si el certificado se ha quitado del grupo, pero el nodo de proceso aún no se ha reiniciado. Los nodos de proceso actualizan sus certificados solo cuando se reinician). Puede usar la operación cancelar eliminación de certificado para cancelar la eliminación o la operación eliminar certificado para reintentar la eliminación.
deleting	string	El usuario ha solicitado que se elimine el certificado, pero la operación de eliminación aún no se ha completado. Es posible que no haga referencia al certificado al crear o actualizar grupos.

DeleteCertificateError

Error detectado por el servicio Batch al eliminar un certificado.

Nombre	Tipo	Description
code	string	Identificador del error de eliminación de certificados. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error de eliminación del certificado, diseñado para que se muestre en una interfaz de usuario.
values	NameValuePair[]	Lista de detalles de error adicionales relacionados con el error de eliminación de certificados. Esta lista incluye detalles como los grupos activos y los nodos de proceso que hacen referencia a este certificado. Sin embargo, si un gran número de recursos hacen referencia al certificado, la lista solo contiene aproximadamente los primeros cien.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

NameValuePair

Representa un par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre del par nombre-valor.
value	string	Valor del par nombre-valor.

Certificate - Get

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Authorization

Ejemplos

Certificate get

Sample Request

Sample Response

Definiciones

BatchError

BatchErrorDetail

Certificate

CertificateState

DeleteCertificateError

ErrorMessage

NameValuePair

Recursos adicionales