Application - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtiene información sobre la aplicación especificada.
Esta operación devuelve solo aplicaciones y versiones que están disponibles para su uso en nodos de proceso; es decir, que se puede usar en una referencia de paquete. Para obtener información sobre las aplicaciones y las versiones que aún no están disponibles para los nodos de proceso, use el Azure Portal o la API de Azure Resource Manager.

GET {batchUrl}/applications/{applicationId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/applications/{applicationId}?timeout={timeout}&api-version=2023-11-01.18.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
applicationId	path	True	string	Identificador de la aplicación.
batchUrl	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.

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.

Respuestas

Nombre	Tipo	Description
200 OK	ApplicationSummary	Respuesta que contiene la aplicación. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

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

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

Get applications

Sample Request

HTTP

GET account.region.batch.azure.com/applications/my_application_id?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "my_application_id",
  "versions": [
    "v1.0"
  ],
  "displayName": "my_display_name"
}

Definiciones

Nombre	Description
ApplicationSummary	Contiene información sobre una aplicación en una cuenta de Azure Batch.
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.

ApplicationSummary

Contiene información sobre una aplicación en una cuenta de Azure Batch.

Nombre	Tipo	Description
displayName	string	El nombre para mostrar de la aplicación.
id	string	Cadena que identifica de forma única la aplicación dentro de la cuenta.
versions	string[]	Lista de versiones disponibles de la aplicación.

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 su presentación en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen 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	Información adicional incluida con la respuesta de error.

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.