diff --git a/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm.py b/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm.py index 8c2e37ce3134..8d0e94cfb35d 100644 --- a/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm.py +++ b/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm.py @@ -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 ` :ivar latest_model_applied: Specifies whether the latest model has been applied to the virtual machine. @@ -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 ` :ivar resources: the virtual machine child extension resources. diff --git a/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_ids.py b/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_ids.py index 60461a502296..f7bd0a8b7bb2 100644 --- a/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_ids.py +++ b/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_ids.py @@ -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 diff --git a/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_required_ids.py b/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_required_ids.py index f430b52c0798..dd9566959538 100644 --- a/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_required_ids.py +++ b/azure-mgmt-compute/azure/mgmt/compute/models/virtual_machine_scale_set_vm_instance_required_ids.py @@ -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 diff --git a/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_set_vms_operations.py b/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_set_vms_operations.py index eb0c0c4d04e0..696f1bc595f6 100644 --- a/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_set_vms_operations.py +++ b/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_set_vms_operations.py @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_sets_operations.py b/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_sets_operations.py index 95718bf8ebbf..28a51547d3f6 100644 --- a/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_sets_operations.py +++ b/azure-mgmt-compute/azure/mgmt/compute/operations/virtual_machine_scale_sets_operations.py @@ -38,16 +38,13 @@ def __init__(self, client, config, serializer, deserializer): def create_or_update( self, resource_group_name, name, parameters, custom_headers=None, raw=False, **operation_config): - """Allows you to create or update a virtual machine scale set by - providing parameters or a path to pre-configured parameter file. + """Create or update a VM scale set. :param resource_group_name: The name of the resource group. :type resource_group_name: str - :param name: Parameters supplied to the Create Virtual Machine Scale - Set operation. + :param name: The name of the VM scale set to create or update. :type name: str - :param parameters: Parameters supplied to the Create Virtual Machine - Scale Set operation. + :param parameters: The scale set object. :type parameters: :class:`VirtualMachineScaleSet ` :param dict custom_headers: headers that will be added to the request @@ -135,14 +132,14 @@ def get_long_running_output(response): def deallocate( self, resource_group_name, vm_scale_set_name, instance_ids=None, custom_headers=None, raw=False, **operation_config): - """Allows you to deallocate virtual machines in a virtual machine 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 uses. + """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. :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_ids: the virtual machine scale set instance ids. :type instance_ids: list of str @@ -228,11 +225,11 @@ def get_long_running_output(response): def delete( self, resource_group_name, vm_scale_set_name, custom_headers=None, raw=False, **operation_config): - """Allows you to delete a virtual machine scale set. + """Deletes 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 dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -309,7 +306,7 @@ def get( :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 dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -367,11 +364,11 @@ def get( def delete_instances( self, resource_group_name, vm_scale_set_name, instance_ids, custom_headers=None, raw=False, **operation_config): - """Allows you to delete virtual machines in a virtual machine scale set. + """Deletes virtual machines 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_ids: the virtual machine scale set instance ids. :type instance_ids: list of str @@ -452,11 +449,11 @@ def get_long_running_output(response): def get_instance_view( self, resource_group_name, vm_scale_set_name, custom_headers=None, raw=False, **operation_config): - """Displays status of a virtual machine scale set instance. + """Gets the status of a VM scale set instance. :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 dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -514,7 +511,7 @@ def get_instance_view( def list( self, resource_group_name, custom_headers=None, raw=False, **operation_config): - """Lists all virtual machine scale sets under a resource group. + """Gets a list of all VM scale sets under a resource group. :param resource_group_name: The name of the resource group. :type resource_group_name: str @@ -580,10 +577,10 @@ def internal_paging(next_link=None, raw=False): def list_all( self, custom_headers=None, raw=False, **operation_config): - """Lists all Virtual Machine Scale Sets in the subscription. Use nextLink - property in the response to get the next page of Virtual Machine - Scale Sets. Do this till nextLink is not null to fetch all the - Virtual Machine Scale Sets. + """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 not + null to fetch all the VM Scale Sets. :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -646,12 +643,12 @@ def internal_paging(next_link=None, raw=False): def list_skus( self, resource_group_name, vm_scale_set_name, custom_headers=None, raw=False, **operation_config): - """Displays available skus for your virtual machine scale set including - the minimum and maximum vm instances allowed for a particular sku. + """Gets a list of SKUs available for your VM scale set, including the + minimum and maximum VM instances allowed for each SKU. :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 dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -716,13 +713,14 @@ def internal_paging(next_link=None, raw=False): def power_off( self, resource_group_name, vm_scale_set_name, instance_ids=None, custom_headers=None, raw=False, **operation_config): - """Allows you to power off (stop) virtual machines in a virtual machine - scale set. Note that resources are still attached and you are getting - charged for the resources. Use deallocate to release resources. + """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. :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_ids: the virtual machine scale set instance ids. :type instance_ids: list of str @@ -808,11 +806,11 @@ def get_long_running_output(response): def restart( self, resource_group_name, vm_scale_set_name, instance_ids=None, custom_headers=None, raw=False, **operation_config): - """Allows you to restart virtual machines in a virtual machine scale set. + """Restarts one or more virtual machines 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_ids: the virtual machine scale set instance ids. :type instance_ids: list of str @@ -898,11 +896,11 @@ def get_long_running_output(response): def start( self, resource_group_name, vm_scale_set_name, instance_ids=None, custom_headers=None, raw=False, **operation_config): - """Allows you to start virtual machines in a virtual machine scale set. + """Starts one or more virtual machines 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_ids: the virtual machine scale set instance ids. :type instance_ids: list of str @@ -988,12 +986,12 @@ def get_long_running_output(response): def update_instances( self, resource_group_name, vm_scale_set_name, instance_ids, custom_headers=None, raw=False, **operation_config): - """Allows you to manually upgrade virtual machines in a virtual machine - scale set. + """Upgrades one or more virtual machines to the latest SKU set in the VM + scale set model. :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_ids: the virtual machine scale set instance ids. :type instance_ids: list of str @@ -1074,12 +1072,12 @@ def get_long_running_output(response): def reimage( self, resource_group_name, vm_scale_set_name, custom_headers=None, raw=False, **operation_config): - """Allows you to re-image(update the version of the installed operating - system) virtual machines in a virtual machine scale set. + """Reimages (upgrade the operating system) one or more virtual machines + 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 dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the