Nodes - Get Node Extension

Служба:: Batch Service

Версия API:: 2025-06-01

Получает информацию о указанном расширении Compute Node.

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}?api-version=2025-06-01

С использованием необязательных параметров:

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}?api-version=2025-06-01&timeOut={timeOut}&$select={$select}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
extensionName	path	True	string	Название расширения Compute Node, о котором вы хотите получить информацию.
nodeId	path	True	string	ID вычислительного узла, содержащего расширения.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$select	query		string[]	Предложение OData $select.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

Имя	Тип	Описание
client-request-id	string	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string (date-time-rfc7231)	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

Имя	Тип	Описание
200 OK	BatchNodeVMExtension	Запрос выполнен успешно. Заголовки ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

BatchNodeVMExtension

Запрос выполнен успешно.

Заголовки

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

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Get batch node extension

Образец запроса

HTTP

GET {endpoint}/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z/extensions/batchNodeExtension?api-version=2025-06-01

Пример ответа

Код состояния:: 200

{
  "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
  }
}

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchNodeVMExtension	Конфигурация представления экземпляра расширения виртуальной машины.
InstanceViewStatus	Состояние представления экземпляра.
StatusLevelTypes	Уровень кода.
VMExtension	Конфигурация расширений виртуальных машин.
VMExtensionInstanceView	Представление экземпляра расширения виртуальной машины.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchNodeVMExtension

Объект

Конфигурация представления экземпляра расширения виртуальной машины.

Имя	Тип	Описание
instanceView	VMExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
provisioningState	string	Состояние предоставления расширения виртуальной машины.
vmExtension	VMExtension	Расширение виртуальной машины.

InstanceViewStatus

Объект

Состояние представления экземпляра.

Имя	Тип	Описание
code	string	Код состояния.
displayStatus	string	Локализованная метка статуса.
level	StatusLevelTypes	Уровень кода.
message	string	Подробное сообщение о статусе.
time	string (date-time)	Время состояния.

StatusLevelTypes

Перечисление

Уровень кода.

Значение	Описание
Error	Ошибка
Info	Info
Warning	Предупреждение

VMExtension

Объект

Конфигурация расширений виртуальных машин.

Имя	Тип	Описание
autoUpgradeMinorVersion	boolean	Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.
enableAutomaticUpgrade	boolean	Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.
name	string	Имя расширения виртуальной машины.
protectedSettings	object	Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров.
provisionAfterExtensions	string[]	Коллекция имен расширений. Коллекция имен расширений, после которой необходимо подготовить это расширение.
publisher	string	Имя издателя обработчика расширений.
settings	object	Форматированные общедоступные параметры JSON для расширения.
type	string	Тип расширения.
typeHandlerVersion	string	Версия обработчика скрипта.

VMExtensionInstanceView

Объект

Представление экземпляра расширения виртуальной машины.

Имя	Тип	Описание
name	string	Название представления экземпляра расширения виртуальной машины.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
subStatuses	InstanceViewStatus[]	Сведения о состоянии ресурса.