Application - Get

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Pobiera informacje o określonej aplikacji.
Ta operacja zwraca tylko aplikacje i wersje, które są dostępne do użycia w węzłach obliczeniowych; oznacza to, że można go użyć w odwołaniu do pakietu. Aby uzyskać informacje o aplikacjach i wersjach, które nie są jeszcze dostępne dla węzłów obliczeniowych, użyj witryny Azure Portal lub interfejsu API usługi Azure Resource Manager.

GET {batchUrl}/applications/{applicationId}?api-version=2024-07-01.20.0

Z parametrami opcjonalnymi:

GET {batchUrl}/applications/{applicationId}?timeout={timeout}&api-version=2024-07-01.20.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
applicationId	path	True	string	Identyfikator aplikacji.
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer int32	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApplicationSummary	Odpowiedź zawierająca aplikację. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Get applications

Przykładowe żądanie

HTTP

GET account.region.batch.azure.com/applications/my_application_id?api-version=2024-07-01.20.0

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
ApplicationSummary	Zawiera informacje o aplikacji na koncie usługi Azure Batch.
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

ApplicationSummary

Zawiera informacje o aplikacji na koncie usługi Azure Batch.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana aplikacji.
id	string	Ciąg, który jednoznacznie identyfikuje aplikację w ramach konta.
versions	string[]	Lista dostępnych wersji aplikacji.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.