Pool - Exists

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

Obtém as propriedades básicas de um Pool.

HEAD {batchUrl}/pools/{poolId}?api-version=2024-07-01.20.0

Com parâmetros opcionais:

HEAD {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
poolId	path	True	string	A ID do Pool a ser obtido.
api-version	query	True	string	Versão da API do cliente.
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 maior que 30, o padrão será usado.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string (uuid)	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar a ID de solicitação do cliente na resposta.
ocp-date		string (date-time-rfc1123)	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.
If-Match		string	Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.
If-None-Match		string	Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.
If-Modified-Since		string (date-time-rfc1123)	Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde o horário especificado.
If-Unmodified-Since		string (date-time-rfc1123)	Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o horário especificado.

Respostas

Nome	Tipo	Description
200 OK		Uma resposta que contém cabeçalhos relacionados ao Pool, se existir. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string
404 Not Found		O Pool não existe.
Other Status Codes	BatchError	O erro do serviço do Lote.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Check Pool Exists

Solicitação de exemplo

HTTP

HEAD account.region.batch.azure.com/pools/poolId?api-version=2024-07-01.20.0

Resposta de exemplo

Código de status:

200

Código de status:

404

Definições

Nome	Description
BatchError	Uma resposta de erro recebida do serviço do Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

BatchError

Objeto

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve 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

Objeto

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

Nome	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas na resposta de erro.

ErrorMessage

Objeto

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

Nome	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.