Application - Get

Služba:

Batch Service

Verze rozhraní API:

2023-11-01.18.0

Získá informace o zadané aplikaci.
Tato operace vrátí pouze aplikace a verze, které jsou k dispozici pro použití na výpočetních uzlech; to znamená, že se dá použít v odkazu na balíček. Informace správce o aplikacích a verzích, které ještě nejsou k dispozici pro výpočetní uzly, najdete v Azure Portal nebo v rozhraní API azure Resource Manager.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
applicationId	path	True	string	ID aplikace.
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky služby Azure Batch.
api-version	query	True	string	Verze klientského rozhraní API.
timeout	query		integer int32	Maximální čas, který může server strávit zpracováním požadavku, v sekundách. Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.

Odpovědi

Name	Typ	Description
200 OK	ApplicationSummary	Odpověď obsahující aplikaci. Hlavičky client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok kódu ověřování OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

Get applications

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
ApplicationSummary	Obsahuje informace o aplikaci v účtu Azure Batch.
BatchError	Ze služby Azure Batch byla přijata chybová odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.

ApplicationSummary

Obsahuje informace o aplikaci v účtu Azure Batch.

Name	Typ	Description
displayName	string	Zobrazovaný název aplikace.
id	string	Řetězec, který jednoznačně identifikuje aplikaci v rámci účtu.
versions	string[]	Seznam dostupných verzí aplikace.

BatchError

Ze služby Azure Batch byla přijata chybová odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v chybové odpovědi.

ErrorMessage

Chybová zpráva přijatá v Azure Batch odpověď na chybu.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy.