Application - List
Lista todas as aplicações disponíveis na Conta especificada.
Esta operação devolve apenas Aplicações e versões que estão disponíveis para utilização em Nós de Computação; ou seja, que pode ser utilizado numa referência de Pacote. Para obter informações de administrador sobre aplicações e versões que ainda não estão disponíveis para Nós de Computação, utilize o portal do Azure ou a API de Resource Manager do Azure.
GET {batchUrl}/applications?api-version=2023-11-01.18.0
GET {batchUrl}/applications?maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
O URL base para todos os pedidos de serviço Azure Batch. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
maxresults
|
query |
integer int32 |
O número máximo de itens a devolver na resposta. Pode ser devolvido um máximo de 1000 aplicações. |
|
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode passar a processar o pedido, em segundos. A predefinição é 30 segundos. |
Cabeçalho do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade do pedido gerado pelo autor da chamada, na forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve devolver o client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-o explicitamente se estiver a chamar a API REST diretamente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma resposta que contém a lista de aplicações. Headers
|
|
Other Status Codes |
O erro do serviço Batch. |
Segurança
azure_auth
Microsoft Entra fluxo de código de autenticação OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Representar a sua conta de utilizador |
Authorization
Type:
apiKey
In:
header
Exemplos
List applications
Sample Request
GET account.region.batch.azure.com/applications?api-version=2023-11-01.18.0
Sample Response
{
"value": [
{
"id": "my_application_id",
"versions": [
"v1.0"
],
"displayName": "my_display_name"
}
]
}
Definições
Name | Description |
---|---|
Application |
O resultado da listagem das aplicações disponíveis numa Conta. |
Application |
Contém informações sobre uma aplicação numa Conta Azure Batch. |
Batch |
Uma resposta de erro recebida do serviço Azure Batch. |
Batch |
Um item de informações adicionais incluídas numa resposta de erro Azure Batch. |
Error |
Uma mensagem de erro recebida numa resposta de erro Azure Batch. |
ApplicationListResult
O resultado da listagem das aplicações disponíveis numa Conta.
Name | Tipo | Description |
---|---|---|
odata.nextLink |
string |
O URL para obter o próximo conjunto de resultados. |
value |
A lista de aplicações disponíveis na Conta. |
ApplicationSummary
Contém informações sobre uma aplicação numa Conta Azure Batch.
Name | Tipo | Description |
---|---|---|
displayName |
string |
O nome a apresentar da aplicação. |
id |
string |
Uma cadeia que identifica exclusivamente a aplicação na Conta. |
versions |
string[] |
A lista de versões disponíveis da aplicação. |
BatchError
Uma resposta de erro recebida do serviço Azure Batch.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
message |
Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador. |
|
values |
Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Valor. |
value |
string |
As informações adicionais incluídas na resposta de erro. |
ErrorMessage
Uma mensagem de erro recebida numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |