azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations
name: VirtualMachineScaleSetsOperations
fullName: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations
module: azure.mgmt.compute.v2016_04_30_preview.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.v2016_04_30_preview.ComputeManagementClient>'s\n\
  >\n> <xref:virtual_machine_scale_sets> attribute.\n>"
constructor:
  syntax: VirtualMachineScaleSetsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Create or update a VM scale set.
  signature: 'begin_create_or_update(resource_group_name: str, name: str, parameters:
    _models.VirtualMachineScaleSet, *, content_type: str = ''application/json'', **kwargs:
    Any) -> LROPoller[_models.VirtualMachineScaleSet]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the VM scale set to create or update. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The scale set object. Is either a VirtualMachineScaleSet type or
      a IO[bytes]

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

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSet>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_deallocate
  name: begin_deallocate
  summary: 'Deallocates specific virtual machines in a VM scale set. Shuts down the
    virtual machines and

    releases the compute resources. You are not billed for the compute resources that
    this virtual

    machine scale set deallocates.'
  signature: 'begin_deallocate(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds:
    _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str
    = ''application/json'', **kwargs: Any) -> LROPoller[_models.OperationStatusResponse]'
  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: vm_instance_i_ds
    description: 'A list of virtual machine instance IDs from the VM scale set. Is

      either a VirtualMachineScaleSetVMInstanceIDs type or a IO[bytes] type. Default
      value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMInstanceIDs>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_delete
  name: begin_delete
  summary: Deletes a VM scale set.
  signature: 'begin_delete(resource_group_name: str, vm_scale_set_name: str, **kwargs:
    Any) -> LROPoller[OperationStatusResponse]'
  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>
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_delete_instances
  name: begin_delete_instances
  summary: Deletes virtual machines in a VM scale set.
  signature: 'begin_delete_instances(resource_group_name: str, vm_scale_set_name:
    str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceRequiredIDs, *,
    content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.OperationStatusResponse]'
  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: vm_instance_i_ds
    description: 'A list of virtual machine instance IDs from the VM scale set. Is

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

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_power_off
  name: begin_power_off
  summary: 'Power off (stop) one or more virtual machines 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, vm_instance_i_ds:
    _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str
    = ''application/json'', **kwargs: Any) -> LROPoller[_models.OperationStatusResponse]'
  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: vm_instance_i_ds
    description: 'A list of virtual machine instance IDs from the VM scale set. Is

      either a VirtualMachineScaleSetVMInstanceIDs type or a IO[bytes] type. Default
      value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMInstanceIDs>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_reimage
  name: begin_reimage
  summary: Reimages (upgrade the operating system) one or more virtual machines in
    a VM scale set.
  signature: 'begin_reimage(resource_group_name: str, vm_scale_set_name: str, **kwargs:
    Any) -> LROPoller[OperationStatusResponse]'
  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>
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_reimage_all
  name: begin_reimage_all
  summary: 'Reimages all the disks ( including data disks ) in the virtual machines
    in a VM scale set. This

    operation is only supported for managed disks.'
  signature: 'begin_reimage_all(resource_group_name: str, vm_scale_set_name: str,
    **kwargs: Any) -> LROPoller[OperationStatusResponse]'
  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>
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_restart
  name: begin_restart
  summary: Restarts one or more virtual machines in a VM scale set.
  signature: 'begin_restart(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds:
    _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str
    = ''application/json'', **kwargs: Any) -> LROPoller[_models.OperationStatusResponse]'
  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: vm_instance_i_ds
    description: 'A list of virtual machine instance IDs from the VM scale set. Is

      either a VirtualMachineScaleSetVMInstanceIDs type or a IO[bytes] type. Default
      value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMInstanceIDs>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_start
  name: begin_start
  summary: Starts one or more virtual machines in a VM scale set.
  signature: 'begin_start(resource_group_name: str, vm_scale_set_name: str, vm_instance_i_ds:
    _models.VirtualMachineScaleSetVMInstanceIDs | None = None, *, content_type: str
    = ''application/json'', **kwargs: Any) -> LROPoller[_models.OperationStatusResponse]'
  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: vm_instance_i_ds
    description: 'A list of virtual machine instance IDs from the VM scale set. Is

      either a VirtualMachineScaleSetVMInstanceIDs type or a IO[bytes] type. Default
      value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetVMInstanceIDs>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either OperationStatusResponse
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.begin_update_instances
  name: begin_update_instances
  summary: Upgrades one or more virtual machines to the latest SKU set in the VM scale
    set model.
  signature: 'begin_update_instances(resource_group_name: str, vm_scale_set_name:
    str, vm_instance_i_ds: _models.VirtualMachineScaleSetVMInstanceRequiredIDs, *,
    content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.OperationStatusResponse]'
  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: vm_instance_i_ds
    description: 'A list of virtual machine instance IDs from the VM scale set. Is

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

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.OperationStatusResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.get
  name: get
  summary: Display information about a virtual machine scale set.
  signature: 'get(resource_group_name: str, vm_scale_set_name: str, **kwargs: Any)
    -> VirtualMachineScaleSet'
  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>
  return:
    description: VirtualMachineScaleSet or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSet>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.get_instance_view
  name: get_instance_view
  summary: Gets the status of a VM scale set instance.
  signature: 'get_instance_view(resource_group_name: str, vm_scale_set_name: str,
    **kwargs: Any) -> VirtualMachineScaleSetInstanceView'
  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>
  return:
    description: VirtualMachineScaleSetInstanceView or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetInstanceView>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.list
  name: list
  summary: Gets a list of all VM scale sets under a resource group.
  signature: 'list(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualMachineScaleSet]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either VirtualMachineScaleSet or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSet>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.list_all
  name: list_all
  summary: 'Gets a list of all VM Scale Sets in the subscription, regardless of the
    associated resource

    group. Use nextLink property in the response to get the next page of VM Scale
    Sets. Do this

    till nextLink is null to fetch all the VM Scale Sets.'
  signature: 'list_all(**kwargs: Any) -> Iterable[VirtualMachineScaleSet]'
  return:
    description: 'An iterator like instance of either VirtualMachineScaleSet or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSet>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.list_skus
  name: list_skus
  summary: 'Gets a list of SKUs available for your VM scale set, including the minimum
    and maximum VM

    instances allowed for each SKU.'
  signature: 'list_skus(resource_group_name: str, vm_scale_set_name: str, **kwargs:
    Any) -> Iterable[VirtualMachineScaleSetSku]'
  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>
  return:
    description: 'An iterator like instance of either VirtualMachineScaleSetSku or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2016_04_30_preview.models.VirtualMachineScaleSetSku>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2016_04_30_preview.operations.VirtualMachineScaleSetsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2016_04_30_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2016_04_30_preview\\models\\__init__.py'>