Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ class VirtualMachineScaleSetVM(Resource):
:type location: str
:param tags: Resource tags.
:type tags: dict
:ivar instance_id: the virtual machine instance id.
:ivar instance_id: The virtual machine instance ID.
:vartype instance_id: str
:ivar sku: the virtual machine sku.
:ivar sku: The virtual machine SKU.
:vartype sku: :class:`Sku <azure.mgmt.compute.models.Sku>`
:ivar latest_model_applied: Specifies whether the latest model has been
applied to the virtual machine.
Expand Down Expand Up @@ -62,7 +62,7 @@ class VirtualMachineScaleSetVM(Resource):
:param license_type: the license type, which is for bring your own
license scenario.
:type license_type: str
:param plan: the purchase plan when deploying virtual machine from VM
:param plan: The purchase plan when deploying virtual machine from VM
Marketplace images.
:type plan: :class:`Plan <azure.mgmt.compute.models.Plan>`
:ivar resources: the virtual machine child extension resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


class VirtualMachineScaleSetVMInstanceIDs(Model):
"""Specifies the list of virtual machine scale set instance IDs.
"""Specifies A list of virtual machine instance IDs from the VM scale set.

:param instance_ids: the virtual machine scale set instance ids.
:type instance_ids: list of str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


class VirtualMachineScaleSetVMInstanceRequiredIDs(Model):
"""Specifies the list of virtual machine scale set instance IDs.
"""Specifies A list of virtual machine instance IDs from the VM scale set.

:param instance_ids: the virtual machine scale set instance ids.
:type instance_ids: list of str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ def __init__(self, client, config, serializer, deserializer):

def reimage(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Allows you to re-image(update the version of the installed operating
system) a virtual machine scale set instance.
"""Reimages (upgrade the operating system) a specific virtual machine in
a VM scale set.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -119,16 +119,16 @@ def get_long_running_output(response):

def deallocate(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Allows you to deallocate a virtual machine scale set virtual machine.
Shuts down the virtual machine and releases the compute resources.
You are not billed for the compute resources that this virtual
machine uses.
"""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.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -202,13 +202,13 @@ def get_long_running_output(response):

def delete(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Allows you to delete a virtual machine scale set.
"""Deletes a virtual machine from a VM scale set.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -282,13 +282,13 @@ def get_long_running_output(response):

def get(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Displays information about a virtual machine scale set virtual machine.
"""Gets a virtual machine from a VM scale set.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -347,13 +347,13 @@ def get(

def get_instance_view(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Displays the status of a virtual machine scale set virtual machine.
"""Gets the status of a virtual machine from a VM scale set.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -412,18 +412,17 @@ def get_instance_view(

def list(
self, resource_group_name, virtual_machine_scale_set_name, filter=None, select=None, expand=None, custom_headers=None, raw=False, **operation_config):
"""Lists all virtual machines in a VM scale sets.
"""Gets a list of all virtual machines in a VM scale sets.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param virtual_machine_scale_set_name: The name of the virtual
machine scale set.
:param virtual_machine_scale_set_name: The name of the VM scale set.
:type virtual_machine_scale_set_name: str
:param filter: The filter to apply on the operation.
:param filter: The filter to apply to the operation.
:type filter: str
:param select: The list parameters.
:type select: str
:param expand: The expand expression to apply on the operation.
:param expand: The expand expression to apply to the operation.
:type expand: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -494,13 +493,16 @@ def internal_paging(next_link=None, raw=False):

def power_off(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Allows you to power off (stop) a virtual machine in a VM scale set.
"""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.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -574,13 +576,13 @@ def get_long_running_output(response):

def restart(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Allows you to restart a virtual machine in a VM scale set.
"""Restarts a virtual machine in a VM scale set.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down Expand Up @@ -654,13 +656,13 @@ def get_long_running_output(response):

def start(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, **operation_config):
"""Allows you to start a virtual machine in a VM scale set.
"""Starts a virtual machine in a VM scale set.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
:param vm_scale_set_name: The name of the virtual machine scale set.
:param vm_scale_set_name: The name of the VM scale set.
:type vm_scale_set_name: str
:param instance_id: The instance id of the virtual machine.
:param instance_id: The instance ID of the virtual machine.
:type instance_id: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
Expand Down
Loading