Application - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Ruft Informationen zur angegebenen Anwendung ab.
Dieser Vorgang gibt nur Anwendungen und Versionen zurück, die für die Verwendung auf Computeknoten verfügbar sind. das heißt, das in einem Paketverweis verwendet werden kann. Für Administratorinformationen zu Anwendungen und Versionen, die für Computeknoten noch nicht verfügbar sind, verwenden Sie die Azure-Portal oder die Azure Resource Manager-API.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
applicationId	path	True	string	Die ID der Anwendung.
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
api-version	query	True	string	Client-API-Version.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
client-request-id		string uuid	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date		string date-time-rfc1123	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. explizit festlegen, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	ApplicationSummary	Eine Antwort, die die Anwendung enthält. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
ApplicationSummary	Enthält Informationen zu einer Anwendung in einem Azure Batch-Konto.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

ApplicationSummary

Enthält Informationen zu einer Anwendung in einem Azure Batch-Konto.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename für die Anwendung.
id	string	Eine Zeichenfolge, die die Anwendung innerhalb des Kontos eindeutig identifiziert.
versions	string[]	Die Liste der verfügbaren Versionen der Anwendung.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.