Application - List

Odwołanie

Usługa:: Batch Service

Wersja interfejsu API:: 2023-11-01.18.0

Wyświetla listę wszystkich aplikacji dostępnych w określonym koncie.
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 Azure Portal lub interfejsu API usługi Azure Resource Manager.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL wszystkich żądań obsługi Azure Batch.
api-version	query	True	string	Wersja interfejsu API klienta.
maxresults	query		integer int32	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Można zwrócić maksymalnie 1000 aplikacji.
timeout	query		integer int32	Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Nazwa	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ć wartość client-request-id 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	ApplicationListResult	Odpowiedź zawierająca listę aplikacji. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch.

Nazwa

Typ

Opis

200 OK

ApplicationListResult

Odpowiedź zawierająca listę aplikacji.

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 przepływ kodu uwierzytelniania OAuth 2.0

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

List applications

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ApplicationListResult	Wynik wyświetlania listy aplikacji dostępnych w ramach konta.
ApplicationSummary	Zawiera informacje o aplikacji na koncie Azure Batch.
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.