Application - List
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 Azure-portalen eller Azure Resource Manager-API:et.
GET {batchUrl}/applications?api-version=2024-07-01.20.0
GET {batchUrl}/applications?maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
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) minimum: 1maximum: 1000 |
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. Om värdet är större än 30 används standardvärdet i stället. |
Begärandehuvud
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | 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 klient-request-id i svaret. |
|
ocp-date |
string (date-time-rfc1123) |
Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Ett svar som innehåller listan över program. Sidhuvuden
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Autentiseringskodflöde för Microsoft Entra OAuth 2.0
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Typ:
apiKey
I:
header
Exempel
List applications
Exempelbegäran
GET account.region.batch.azure.com/applications?api-version=2024-07-01.20.0
Exempelsvar
{
"value": [
{
"id": "my_application_id",
"versions": [
"v1.0"
],
"displayName": "my_display_name"
}
]
}
Definitioner
Name | Description |
---|---|
Application |
Resultatet av att lista de program som är tillgängliga i ett konto. |
Application |
Innehåller information om ett program i ett Azure Batch-konto. |
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar. |
Error |
Ett felmeddelande som togs emot i ett Azure Batch-felsvar. |
ApplicationListResult
Resultatet av att lista de program som är tillgängliga i ett konto.
Name | Typ | Description |
---|---|---|
odata.nextLink |
string |
URL:en för att hämta nästa uppsättning resultat. |
value |
Listan över program som är tillgängliga i kontot. |
ApplicationSummary
Innehåller information om ett program i ett Azure Batch-konto.
Name | Typ | Description |
---|---|---|
displayName |
string |
Programmets visningsnamn. |
id |
string |
En sträng som unikt identifierar programmet i kontot. |
versions |
string[] |
Listan över tillgängliga versioner av programmet. |
BatchError
Ett felsvar som tagits emot från Azure Batch-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
message |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
En samling nyckel/värde-par som innehåller ytterligare information om felet. |
BatchErrorDetail
Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
Name | Typ | Description |
---|---|---|
key |
string |
En identifierare som anger innebörden av egenskapen Value. |
value |
string |
Den ytterligare information som ingår i felsvaret. |
ErrorMessage
Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
Name | Typ | Description |
---|---|---|
lang |
string |
Språkkoden för felmeddelandet |
value |
string |
Texten i meddelandet. |