Partilhar via

Applications - List Applications

Serviço:
Batch Service
Versão da API:
2025-06-01

Lista todas as candidaturas disponíveis na Conta especificada.
Esta operação devolve apenas Aplicações e versões disponíveis para uso nos Nós de Computação; isto é, que pode ser usado numa referência de Pacote. Para informações de administrador sobre aplicações e versões que ainda não estão disponíveis para a Compute Nodes, utilize o portal Azure ou a API Azure Resource Manager.

GET {endpoint}/applications?api-version=2025-06-01
Com parâmetros opcionais: 
GET {endpoint}/applications?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string (uri)

Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
api-version
 query True

string

minLength: 1

A versão da API a utilizar para esta operação.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

O número máximo de itens a serem retornados na resposta. Podem ser devolvidos um máximo de 1000 candidaturas.
timeOut
 query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

Name Necessário Tipo Description
client-request-id

string

A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve retornar o client-request-id na resposta.
ocp-date

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name Tipo Description
200 OK

BatchApplicationListResult

O pedido foi bem-sucedido.

Cabeçalhos

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name Description
https://batch.core.windows.net//.default

Exemplos

List applications

Pedido de amostra

GET {endpoint}/applications?api-version=2025-06-01

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "my_application_id",
      "versions": [
        "v1.0"
      ],
      "displayName": "my_display_name"
    }
  ]
}

Definições

Name Description
BatchApplication

Contém informações sobre um aplicativo em uma Conta de Lote do Azure.
BatchApplicationListResult

O resultado da listagem dos aplicativos disponíveis em uma Conta.
BatchError

Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

BatchApplication

Object

Contém informações sobre um aplicativo em uma Conta de Lote do Azure.

Name Tipo Description
displayName

string

O nome para exibição do aplicativo.
id

string

Uma cadeia que identifica de forma única a aplicação dentro da Conta.
versions

string[]

A lista de versões disponíveis da aplicação.

BatchApplicationListResult

Object

O resultado da listagem dos aplicativos disponíveis em uma Conta.

Name Tipo Description
odata.nextLink

string (uri)

O URL para obter o próximo conjunto de resultados.
value

BatchApplication[]

A lista de candidaturas disponíveis na Conta.

BatchError

Object

Uma resposta de erro recebida do serviço Batch do Azure.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message

BatchErrorMessage

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Object

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

As informações adicionais incluídas com a resposta de erro.

BatchErrorMessage

Object

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name Tipo Description
lang

string

O código da linguagem da mensagem de erro.
value

string

O texto da mensagem.