azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations
name: VirtualMachineScaleSetVMsOperations
fullName: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations
module: azure.mgmt.compute.v2023_07_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2023_07_01.ComputeManagementClient>'s\n\
  >\n> <xref:virtual_machine_scale_set_vms> attribute.\n>"
constructor:
  syntax: VirtualMachineScaleSetVMsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_deallocate
  name: begin_deallocate
  summary: 'Deallocates a specific virtual machine in a VM scale set. Shuts down the
    virtual machine and

    releases the compute resources it uses. You are not billed for the compute resources
    of this

    virtual machine once it is deallocated.'
  signature: 'begin_deallocate(resource_group_name: str, vm_scale_set_name: str, instance_id:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_delete
  name: begin_delete
  summary: Deletes a virtual machine from a VM scale set.
  signature: 'begin_delete(resource_group_name: str, vm_scale_set_name: str, instance_id:
    str, *, force_deletion: bool | None = None, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: force_deletion
    description: 'Optional parameter to force delete a virtual machine from a VM scale

      set. (Feature in Preview). Default value is None.'
    types:
    - <xref:bool>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_perform_maintenance
  name: begin_perform_maintenance
  summary: Performs maintenance on a virtual machine in a VM scale set.
  signature: 'begin_perform_maintenance(resource_group_name: str, vm_scale_set_name:
    str, instance_id: str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_power_off
  name: begin_power_off
  summary: 'Power off (stop) a virtual machine in a VM scale set. Note that resources
    are still attached

    and you are getting charged for the resources. Instead, use deallocate to release
    resources and

    avoid charges.'
  signature: 'begin_power_off(resource_group_name: str, vm_scale_set_name: str, instance_id:
    str, *, skip_shutdown: bool = False, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: skip_shutdown
    description: 'The parameter to request non-graceful VM shutdown. True value for
      this

      flag indicates non-graceful shutdown whereas false indicates otherwise. Default
      value for this

      flag is false if not specified. Default value is False.'
    types:
    - <xref:bool>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_redeploy
  name: begin_redeploy
  summary: 'Shuts down the virtual machine in the virtual machine scale set, moves
    it to a new node, and

    powers it back on.'
  signature: 'begin_redeploy(resource_group_name: str, vm_scale_set_name: str, instance_id:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_reimage
  name: begin_reimage
  summary: Reimages (upgrade the operating system) a specific virtual machine in a
    VM scale set.
  signature: '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]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_vm_reimage_input
    description: 'Parameters for the Reimaging Virtual machine in ScaleSet.

      Is either a VirtualMachineScaleSetVMReimageParameters type or a IO[bytes] type.
      Default value

      is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineScaleSetVMReimageParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_reimage_all
  name: begin_reimage_all
  summary: 'Allows you to re-image all the disks ( including data disks ) in the a
    VM scale set instance.

    This operation is only supported for managed disks.'
  signature: 'begin_reimage_all(resource_group_name: str, vm_scale_set_name: str,
    instance_id: str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_restart
  name: begin_restart
  summary: Restarts a virtual machine in a VM scale set.
  signature: 'begin_restart(resource_group_name: str, vm_scale_set_name: str, instance_id:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_run_command
  name: begin_run_command
  summary: Run command on a virtual machine in a VM scale set.
  signature: '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]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Run command operation. Is either a

      RunCommandInput type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.RunCommandInput>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either RunCommandResult or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_07_01.models.RunCommandResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_start
  name: begin_start
  summary: Starts a virtual machine in a VM scale set.
  signature: 'begin_start(resource_group_name: str, vm_scale_set_name: str, instance_id:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.begin_update
  name: begin_update
  summary: Updates a virtual machine of a VM scale set.
  signature: '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]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: 'The name of the VM scale set where the extension should be create
      or

      updated. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Update Virtual Machine Scale Sets VM
      operation.

      Is either a VirtualMachineScaleSetVM type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineScaleSetVM>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either VirtualMachineScaleSetVM
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineScaleSetVM>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.get
  name: get
  summary: Gets a virtual machine from a VM scale set.
  signature: 'get(resource_group_name: str, vm_scale_set_name: str, instance_id: str,
    *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> VirtualMachineScaleSetVM'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: expand
    description: 'The expand expression to apply on the operation. ''InstanceView''
      will retrieve

      the instance view of the virtual machine. ''UserData'' will retrieve the UserData
      of the virtual

      machine. Known values are: "instanceView" and "userData". Default value is None.'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_07_01.models.InstanceViewTypes>
  return:
    description: VirtualMachineScaleSetVM or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineScaleSetVM>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.get_instance_view
  name: get_instance_view
  summary: Gets the status of a virtual machine from a VM scale set.
  signature: 'get_instance_view(resource_group_name: str, vm_scale_set_name: str,
    instance_id: str, **kwargs: Any) -> VirtualMachineScaleSetVMInstanceView'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: VirtualMachineScaleSetVMInstanceView or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineScaleSetVMInstanceView>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.list
  name: list
  summary: Gets a list of all virtual machines in a VM scale sets.
  signature: '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]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: virtual_machine_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: filter
    description: 'The filter to apply to the operation. Allowed values are

      ''startswith(instanceView/statuses/code, ''PowerState'') eq true'', ''properties/latestModelApplied

      eq true'', ''properties/latestModelApplied eq false''. Default value is None.'
    types:
    - <xref:str>
  - name: select
    description: 'The list parameters. Allowed values are ''instanceView'',

      ''instanceView/statuses''. Default value is None.'
    types:
    - <xref:str>
  - name: expand
    description: 'The expand expression to apply to the operation. Allowed values
      are

      ''instanceView''. Default value is None.'
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either VirtualMachineScaleSetVM or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2023_07_01.models.VirtualMachineScaleSetVM>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.retrieve_boot_diagnostics_data
  name: retrieve_boot_diagnostics_data
  summary: 'The operation to retrieve SAS URIs of boot diagnostic logs for a virtual
    machine in a VM scale

    set.'
  signature: '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'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: sas_uri_expiration_time_in_minutes
    description: 'Expiration duration in minutes for the SAS URIs

      with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs
      will be generated

      with a default expiration duration of 120 minutes. Default value is None.'
    types:
    - <xref:int>
  return:
    description: RetrieveBootDiagnosticsDataResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_07_01.models.RetrieveBootDiagnosticsDataResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.simulate_eviction
  name: simulate_eviction
  summary: The operation to simulate the eviction of spot virtual machine in a VM
    scale set.
  signature: 'simulate_eviction(resource_group_name: str, vm_scale_set_name: str,
    instance_id: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_scale_set_name
    description: The name of the VM scale set. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: instance_id
    description: The instance ID of the virtual machine. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2023_07_01.operations.VirtualMachineScaleSetVMsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2023_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2023_07_01\\models\\__init__.py'>