Application - List

Referens

Service:: Batch Service

API Version:: 2023-11-01.18.0

Visar en lista över alla program som är tillgängliga i det angivna kontot.
Den här åtgärden returnerar endast program och versioner som är tillgängliga för användning på beräkningsnoder. som kan användas i en paketreferens. Om du vill ha administratörsinformation om program och versioner som ännu inte är tillgängliga för beräkningsnoder använder du api:et Azure Portal eller Azure Resource Manager.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
api-version	query	True	string	Klient-API-version.
maxresults	query		integer int32	Det maximala antalet objekt som ska returneras i svaret. Högst 1 000 program kan returneras.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Typ	Description
client-request-id	string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Om servern ska returnera client-request-id i svaret.
ocp-date	string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	ApplicationListResult	Ett svar som innehåller listan över program. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Name

Typ

Description

200 OK

ApplicationListResult

Ett svar som innehåller listan över program.

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra OAuth 2.0-autentiseringskodflöde

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

List applications

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definitioner

Name	Description
ApplicationListResult	Resultatet av att lista de program som är tillgängliga i ett konto.
ApplicationSummary	Innehåller information om ett program i ett Azure Batch-konto.
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
ErrorMessage	Ett felmeddelande som tas emot i ett Azure Batch felsvar.