Compute Node Extension - List

Referência

Serviço:: Batch Service

Versão da API:: 2024-07-01.20.0

Lista as extensões de nós de computação no pool especificado.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2024-07-01.20.0

Com parâmetros opcionais:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/extensions?$select={$select}&maxresults={maxresults}&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.
nodeId	path	True	string	A ID do Nó de Computação que você deseja listar extensões.
poolId	path	True	string	A ID do pool que contém o Nó de Computação.
api-version	query	True	string	Versão da API do cliente.
$select	query		string	Uma cláusula $select OData.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	O número máximo de itens a serem retornados na resposta. Um máximo de 1000 Nós de Computação pode ser retornado.
timeout	query		integer (int32)	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. A predefiniçã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	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.

Respostas

Nome	Tipo	Description
200 OK	NodeVMExtensionList	Uma resposta que contém a lista de Nós de Computação. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Nome

Tipo

Description

200 OK

NodeVMExtensionList

Uma resposta que contém a lista de Nós de Computação.

Cabeçalhos

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

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

List compute node extensions

Solicitação de exemplo

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z/extensions?api-version=2024-07-01.20.0

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "instanceView": {
        "name": "batchNodeExtension",
        "statuses": [
          {
            "code": "ProvisioningState/succeeded",
            "level": "Info",
            "displayStatus": "Provisioning succeeded",
            "message": "Enable succeeded: Enabling and starting agent and controller"
          }
        ]
      },
      "vmExtension": {
        "name": "batchNodeExtension",
        "publisher": "Microsoft.Azure.Extensions",
        "type": "CustomScript",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true
      }
    },
    {
      "instanceView": {
        "name": "customExtension",
        "statuses": [
          {
            "code": "ProvisioningState/succeeded",
            "level": "Info",
            "displayStatus": "Provisioning succeeded",
            "message": "ExtensionOperation:enable. Status:Success"
          }
        ]
      },
      "vmExtension": {
        "name": "customExtension",
        "publisher": "Microsoft.Azure.Geneva",
        "type": "GenevaMonitoring",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true
      }
    }
  ]
}

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.
InstanceViewStatus	O status de exibição da instância.
NodeVMExtension	A configuração da exibição da instância de extensão da máquina virtual.
NodeVMExtensionList	O resultado da listagem das extensões do Nó de Computação em um Nó.
StatusLevelTypes	Código de nível.
VMExtension	A configuração para extensões de máquina virtual.
VMExtensionInstanceView	O modo de exibição da instância de extensão da VM.

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.

InstanceViewStatus

Objeto

O status de exibição da instância.

Nome	Tipo	Description
code	string	O código de status.
displayStatus	string	O rótulo localizado para o status.
level	StatusLevelTypes	Código de nível.
message	string	A mensagem de status detalhada.
time	string	A hora do status.

NodeVMExtension

Objeto

A configuração da exibição da instância de extensão da máquina virtual.

Nome	Tipo	Description
instanceView	VMExtensionInstanceView	O modo de exibição da instância de extensão da VM.
provisioningState	string	O estado de provisionamento da extensão da máquina virtual.
vmExtension	VMExtension	A extensão da máquina virtual

NodeVMExtensionList

Objeto

O resultado da listagem das extensões do Nó de Computação em um Nó.

Nome	Tipo	Description
odata.nextLink	string	A URL para obter o próximo conjunto de resultados.
value	NodeVMExtension[]	A lista de extensões do Nó de Computação.

StatusLevelTypes

Enumeração

Código de nível.

Valor	Description
Error
Info
Warning

VMExtension

Objeto

A configuração para extensões de máquina virtual.

Nome	Tipo	Description
autoUpgradeMinorVersion	boolean	Indica se a extensão deve usar uma versão secundária mais recente se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.
enableAutomaticUpgrade	boolean	Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.
name	string	O nome da extensão da máquina virtual.
protectedSettings	object	A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.
provisionAfterExtensions	string[]	A coleção de nomes de extensão. Coleção de nomes de extensão após o qual essa extensão precisa ser provisionada.
publisher	string	O nome do editor do manipulador de extensão.
settings	object	Configurações públicas formatadas em JSON para a extensão.
type	string	O tipo da extensão.
typeHandlerVersion	string	A versão do manipulador de script.

VMExtensionInstanceView

Objeto

O modo de exibição da instância de extensão da VM.

Nome	Tipo	Description
name	string	O nome da exibição da instância de extensão da VM.
statuses	InstanceViewStatus[]	As informações de status do recurso.
subStatuses	InstanceViewStatus[]	As informações de status do recurso.

Compartilhar via

Compute Node Extension - List

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Authorization

Exemplos

List compute node extensions

Solicitação de exemplo

Resposta de exemplo

Definições

BatchError

BatchErrorDetail

ErrorMessage

InstanceViewStatus

NodeVMExtension

NodeVMExtensionList

StatusLevelTypes

VMExtension

VMExtensionInstanceView