Compute Node - Get Remote Login Settings

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtém as definições necessárias para o início de sessão remoto num Nó de Computação.
Antes de poder iniciar sessão remotamente num Nó de Computação com as definições de início de sessão remoto, tem de criar uma Conta de utilizador no Nó de Computação. Esta API só pode ser invocada em Conjuntos criados com a propriedade de configuração da máquina virtual. Para Conjuntos criados com uma configuração de serviço cloud, veja a API GetRemoteDesktop.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
nodeId	path	True	string	O ID do Nó de Computação para o qual obter as definições de início de sessão remoto.
poolId	path	True	string	O ID do Conjunto que contém o Nó de Computação.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Tipo	Description
client-request-id	string uuid	A identidade do pedido gerado pelo autor da chamada, sob a 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-a explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	ComputeNodeGetRemoteLoginSettingsResult	Uma resposta que contém as definições de início de sessão. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço Batch.

Name

Tipo

Description

200 OK

ComputeNodeGetRemoteLoginSettingsResult

Uma resposta que contém as definições de início de sessão.

Headers

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

Other Status Codes

BatchError

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

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "remoteLoginIPAddress": "1.1.1.1",
  "remoteLoginPort": 50000
}

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ComputeNodeGetRemoteLoginSettingsResult	As definições de início de sessão remoto para um Nó de Computação.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.

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	ErrorMessage	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	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 do erro.