Поделиться через

VirtualMachineScaleSetVMsOperations Класс

  • Ссылка

Предупреждение

НЕ следует создавать экземпляр этого класса напрямую.

Вместо этого вы должны получить доступ к следующим операциям с помощью

ComputeManagementClient's

атрибут<xref:virtual_machine_scale_set_vms> .

Наследование
builtins.object
VirtualMachineScaleSetVMsOperations

Конструктор

VirtualMachineScaleSetVMsOperations(*args, **kwargs)

Методы

begin_deallocate

Освобождает определенную виртуальную машину в масштабируемом наборе виртуальных машин. Завершает работу виртуальной машины и освобождает используемые ею вычислительные ресурсы. Плата за вычислительные ресурсы этой виртуальной машины после освобождения не взимается.
begin_delete

Удаляет виртуальную машину из масштабируемого набора виртуальных машин.
begin_perform_maintenance

Выполняет обслуживание виртуальной машины в масштабируемом наборе виртуальных машин.
begin_power_off

Выключение (остановка) виртуальной машины в масштабируемом наборе виртуальных машин. Обратите внимание, что ресурсы по-прежнему подключены, и плата за них взимается. Вместо этого используйте отмену выделения, чтобы освободить ресурсы и избежать расходов.
begin_redeploy

Завершает работу виртуальной машины в масштабируемом наборе виртуальных машин, перемещает ее на новый узел и снова включается.
begin_reimage

Повторное создание образа (обновление операционной системы) определенной виртуальной машины в масштабируемом наборе виртуальных машин.
begin_reimage_all

Позволяет повторно создать образ всех дисков (включая диски данных) в экземпляре масштабируемого набора виртуальных машин. Эта операция поддерживается только для управляемых дисков.
begin_restart

Перезапуск виртуальной машины в масштабируемом наборе виртуальных машин.
begin_run_command

Выполните команду на виртуальной машине в масштабируемом наборе виртуальных машин.
begin_start

Запускает виртуальную машину в масштабируемом наборе виртуальных машин.
begin_update

Обновления виртуальной машины масштабируемого набора виртуальных машин.
get

Возвращает виртуальную машину из масштабируемого набора виртуальных машин.
get_instance_view

Возвращает состояние виртуальной машины из масштабируемого набора виртуальных машин.
list

Возвращает список всех виртуальных машин в масштабируемых наборах виртуальных машин.
retrieve_boot_diagnostics_data

Операция по получению URI SAS журналов диагностики загрузки для виртуальной машины в масштабируемом наборе виртуальных машин.
simulate_eviction

Операция для имитации вытеснения точечных виртуальных машин в масштабируемом наборе виртуальных машин.

begin_deallocate

Освобождает определенную виртуальную машину в масштабируемом наборе виртуальных машин. Завершает работу виртуальной машины и освобождает используемые ею вычислительные ресурсы. Плата за вычислительные ресурсы этой виртуальной машины после освобождения не взимается.

begin_deallocate(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_delete

Удаляет виртуальную машину из масштабируемого набора виртуальных машин.

begin_delete(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, force_deletion: bool | None = None, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

force_deletion
bool

Необязательный параметр для принудительного удаления виртуальной машины из масштабируемого набора виртуальных машин. (Функция в предварительной версии). Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_perform_maintenance

Выполняет обслуживание виртуальной машины в масштабируемом наборе виртуальных машин.

begin_perform_maintenance(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_power_off

Выключение (остановка) виртуальной машины в масштабируемом наборе виртуальных машин. Обратите внимание, что ресурсы по-прежнему подключены, и плата за них взимается. Вместо этого используйте отмену выделения, чтобы освободить ресурсы и избежать расходов.

begin_power_off(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, skip_shutdown: bool = False, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

skip_shutdown
bool

Параметр для запроса нестандартного завершения работы виртуальной машины. Значение true для этого флага указывает на неправильное завершение работы, а значение false — на обратное. Значение по умолчанию для этого флага — false, если оно не указано. По умолчанию используется значение False.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_redeploy

Завершает работу виртуальной машины в масштабируемом наборе виртуальных машин, перемещает ее на новый узел и снова включается.

begin_redeploy(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_reimage

Повторное создание образа (обновление операционной системы) определенной виртуальной машины в масштабируемом наборе виртуальных машин.

begin_reimage(resource_group_name: str, vm_scale_set_name: str, instance_id: str, vm_scale_set_vm_reimage_input: _models.VirtualMachineScaleSetVMReimageParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

vm_scale_set_vm_reimage_input
VirtualMachineScaleSetVMReimageParameters или IO
Обязательно

Параметры для повторного создания образа виртуальной машины в ScaleSet. Тип VirtualMachineScaleSetVMReimageParameters или тип ввода-вывода. Значение по умолчанию —Нет.

content_type
str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_reimage_all

Позволяет повторно создать образ всех дисков (включая диски данных) в экземпляре масштабируемого набора виртуальных машин. Эта операция поддерживается только для управляемых дисков.

begin_reimage_all(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_restart

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

begin_restart(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_run_command

Выполните команду на виртуальной машине в масштабируемом наборе виртуальных машин.

begin_run_command(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: _models.RunCommandInput, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RunCommandResult]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

parameters
RunCommandInput или IO
Обязательно

Параметры, предоставленные для командной операции Выполнить. Тип RunCommandInput или тип ввода-вывода. Обязательный.

content_type
str

Тип содержимого параметра тела. Известные значения: "application/json", "text/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.

Возвращаемое значение

Экземпляр LROPoller, возвращающий либо RunCommandResult, либо результат cls(response)

Возвращаемый тип

LROPoller[RunCommandResult]

Исключения

HttpResponseError

begin_start

Запускает виртуальную машину в масштабируемом наборе виртуальных машин.

begin_start(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.

Возвращаемое значение

Экземпляр LROPoller, возвращающий значение None или результат cls(response)

Возвращаемый тип

LROPoller[None]

Исключения

HttpResponseError

begin_update

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

begin_update(resource_group_name: str, vm_scale_set_name: str, instance_id: str, parameters: _models.VirtualMachineScaleSetVM, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachineScaleSetVM]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин, в котором должно быть создано или обновлено расширение. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

parameters
VirtualMachineScaleSetVM или IO
Обязательно

Параметры, предоставляемые операции обновления Масштабируемые наборы виртуальных машин виртуальной машины. Тип VirtualMachineScaleSetVM или тип ввода-вывода. Обязательный.

content_type
str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.

Возвращаемое значение

Экземпляр LROPoller, который возвращает либо VirtualMachineScaleSetVM, либо результат cls(response)

Возвращаемый тип

LROPoller[VirtualMachineScaleSetVM]

Исключения

HttpResponseError

get

Возвращает виртуальную машину из масштабируемого набора виртуальных машин.

get(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, expand: Literal['instanceView'] = 'instanceView', **kwargs: Any) -> VirtualMachineScaleSetVM

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

expand
str

Выражение expand, применяемое к операции. Известные значения: instanceView и None. Значение по умолчанию — instanceView.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

VirtualMachineScaleSetVM или результат cls(response)

Возвращаемый тип

VirtualMachineScaleSetVM

Исключения

HttpResponseError

get_instance_view

Возвращает состояние виртуальной машины из масштабируемого набора виртуальных машин.

get_instance_view(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> VirtualMachineScaleSetVMInstanceView

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

VirtualMachineScaleSetVMInstanceView или результат cls(response)

Возвращаемый тип

VirtualMachineScaleSetVMInstanceView

Исключения

HttpResponseError

list

Возвращает список всех виртуальных машин в масштабируемых наборах виртуальных машин.

list(resource_group_name: str, virtual_machine_scale_set_name: str, *, filter: str | None = None, select: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[VirtualMachineScaleSetVM]

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

virtual_machine_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

filter
str

Фильтр, применяемый к операции. Допустимые значения: 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'. Значение по умолчанию —Нет.

select
str

Параметры списка. Допустимые значения: instanceView, instanceView/statuses. Значение по умолчанию —Нет.

expand
str

Выражение expand, применяемое к операции. Допустимые значения: instanceView. Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр VirtualMachineScaleSetVM или результат cls(response)

Возвращаемый тип

ItemPaged[VirtualMachineScaleSetVM]

Исключения

HttpResponseError

retrieve_boot_diagnostics_data

Операция по получению URI SAS журналов диагностики загрузки для виртуальной машины в масштабируемом наборе виртуальных машин.

retrieve_boot_diagnostics_data(resource_group_name: str, vm_scale_set_name: str, instance_id: str, *, sas_uri_expiration_time_in_minutes: int | None = None, **kwargs: Any) -> RetrieveBootDiagnosticsDataResult

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

sas_uri_expiration_time_in_minutes
int

Срок действия в минутах для URI SAS со значением от 1 до 1440 минут. <br>:code:>><<<br>ПРИМЕЧАНИЕ. Если этот параметр не указан, URI SAS будут создаваться со сроком действия по умолчанию 120 минут. Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

RetrieveBootDiagnosticsDataResult или результат cls(response)

Возвращаемый тип

RetrieveBootDiagnosticsDataResult

Исключения

HttpResponseError

simulate_eviction

Операция для имитации вытеснения точечных виртуальных машин в масштабируемом наборе виртуальных машин.

simulate_eviction(resource_group_name: str, vm_scale_set_name: str, instance_id: str, **kwargs: Any) -> None

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов. Обязательный.

vm_scale_set_name
str
Обязательно

Имя масштабируемого набора виртуальных машин. Обязательный.

instance_id
str
Обязательно

Идентификатор экземпляра виртуальной машины. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

None или результат cls(response)

Возвращаемый тип

None

Исключения

HttpResponseError

Атрибуты

models 

models = <module 'azure.mgmt.compute.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2020_12_01\\models\\__init__.py'>