Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ReleasePR azure-mgmt-compute] Updates Compute.Json to improve Documentation around PerformMaintenan… #14763

Closed
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 @@ -72,6 +72,7 @@ class ComputeManagementClient(MultiApiClientMixin, SDKClient):
'virtual_machine_scale_set_extensions': '2020-06-01',
'virtual_machine_scale_set_rolling_upgrades': '2020-06-01',
'virtual_machine_scale_set_vm_extensions': '2020-06-01',
'virtual_machine_scale_set_vm_run_commands': '2020-06-01',
'virtual_machine_scale_set_vms': '2020-06-01',
'virtual_machine_scale_sets': '2020-06-01',
'virtual_machine_sizes': '2020-06-01',
Expand Down Expand Up @@ -1043,6 +1044,19 @@ def virtual_machine_scale_set_vm_extensions(self):
raise NotImplementedError("APIVersion {} is not available".format(api_version))
return OperationClass(self._client, self.config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)))

@property
def virtual_machine_scale_set_vm_run_commands(self):
"""Instance depends on the API version:

* 2020-06-01: :class:`VirtualMachineScaleSetVMRunCommandsOperations<azure.mgmt.compute.v2020_06_01.operations.VirtualMachineScaleSetVMRunCommandsOperations>`
"""
api_version = self._get_api_version('virtual_machine_scale_set_vm_run_commands')
if api_version == '2020-06-01':
from .v2020_06_01.operations import VirtualMachineScaleSetVMRunCommandsOperations as OperationClass
else:
raise NotImplementedError("APIVersion {} is not available".format(api_version))
return OperationClass(self._client, self.config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)))

@property
def virtual_machine_scale_set_vms(self):
"""Instance depends on the API version:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,9 @@ def _perform_maintenance_initial(

def perform_maintenance(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, polling=True, **operation_config):
"""Performs maintenance on a virtual machine in a VM scale set.
"""Shuts down the virtual machine in a VMScaleSet, moves it to an already
updated node, and powers it back on during the self-service phase of
planned maintenance.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,12 @@ def convert_to_managed_disks(
self, resource_group_name, vm_name, custom_headers=None, raw=False, polling=True, **operation_config):
"""Converts virtual machine disks from blob-based to managed disks.
Virtual machine must be stop-deallocated before invoking this
operation.
operation. <br>For Windows, please refer to [Convert a virtual machine
from unmanaged disks to managed
disks.](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/convert-unmanaged-to-managed-disks).<br>For
Linux, please refer to [Convert a virtual machine from unmanaged disks
to managed
disks.](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/convert-unmanaged-to-managed-disks).

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
Expand Down Expand Up @@ -1614,7 +1619,9 @@ def _perform_maintenance_initial(

def perform_maintenance(
self, resource_group_name, vm_name, custom_headers=None, raw=False, polling=True, **operation_config):
"""The operation to perform maintenance on a virtual machine.
"""Shuts down the virtual machine, moves it to an already updated node,
and powers it back on during the self-service phase of planned
maintenance.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,9 @@ def _perform_maintenance_initial(

def perform_maintenance(
self, resource_group_name, vm_scale_set_name, instance_id, custom_headers=None, raw=False, polling=True, **operation_config):
"""Performs maintenance on a virtual machine in a VM scale set.
"""Shuts down the virtual machine in a VMScaleSet, moves it to an already
updated node, and powers it back on during the self-service phase of
planned maintenance.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,12 @@ def convert_to_managed_disks(
self, resource_group_name, vm_name, custom_headers=None, raw=False, polling=True, **operation_config):
"""Converts virtual machine disks from blob-based to managed disks.
Virtual machine must be stop-deallocated before invoking this
operation.
operation. <br>For Windows, please refer to [Convert a virtual machine
from unmanaged disks to managed
disks.](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/convert-unmanaged-to-managed-disks).<br>For
Linux, please refer to [Convert a virtual machine from unmanaged disks
to managed
disks.](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/convert-unmanaged-to-managed-disks).

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
Expand Down Expand Up @@ -1614,7 +1619,9 @@ def _perform_maintenance_initial(

def perform_maintenance(
self, resource_group_name, vm_name, custom_headers=None, raw=False, polling=True, **operation_config):
"""The operation to perform maintenance on a virtual machine.
"""Shuts down the virtual machine, moves it to an already updated node,
and powers it back on during the self-service phase of planned
maintenance.

:param resource_group_name: The name of the resource group.
:type resource_group_name: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from .operations import VirtualMachineScaleSetVMsOperations
from .operations import LogAnalyticsOperations
from .operations import VirtualMachineRunCommandsOperations
from .operations import VirtualMachineScaleSetVMRunCommandsOperations
from . import models


Expand Down Expand Up @@ -82,6 +83,8 @@ class ComputeManagementClient(SDKClient):
:vartype log_analytics: azure.mgmt.compute.v2020_06_01.operations.LogAnalyticsOperations
:ivar virtual_machine_run_commands: VirtualMachineRunCommands operations
:vartype virtual_machine_run_commands: azure.mgmt.compute.v2020_06_01.operations.VirtualMachineRunCommandsOperations
:ivar virtual_machine_scale_set_vm_run_commands: VirtualMachineScaleSetVMRunCommands operations
:vartype virtual_machine_scale_set_vm_run_commands: azure.mgmt.compute.v2020_06_01.operations.VirtualMachineScaleSetVMRunCommandsOperations

:param credentials: Credentials needed for the client to connect to Azure.
:type credentials: :mod:`A msrestazure Credentials
Expand Down Expand Up @@ -144,3 +147,5 @@ def __init__(
self._client, self.config, self._serialize, self._deserialize)
self.virtual_machine_run_commands = VirtualMachineRunCommandsOperations(
self._client, self.config, self._serialize, self._deserialize)
self.virtual_machine_scale_set_vm_run_commands = VirtualMachineScaleSetVMRunCommandsOperations(
self._client, self.config, self._serialize, self._deserialize)
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@
from ._models_py3 import VirtualMachineInstanceView
from ._models_py3 import VirtualMachinePatchStatus
from ._models_py3 import VirtualMachineReimageParameters
from ._models_py3 import VirtualMachineRunCommand
from ._models_py3 import VirtualMachineRunCommandInstanceView
from ._models_py3 import VirtualMachineRunCommandScriptSource
from ._models_py3 import VirtualMachineRunCommandUpdate
from ._models_py3 import VirtualMachineScaleSet
from ._models_py3 import VirtualMachineScaleSetDataDisk
from ._models_py3 import VirtualMachineScaleSetExtension
Expand Down Expand Up @@ -304,6 +308,10 @@
from ._models import VirtualMachineInstanceView
from ._models import VirtualMachinePatchStatus
from ._models import VirtualMachineReimageParameters
from ._models import VirtualMachineRunCommand
from ._models import VirtualMachineRunCommandInstanceView
from ._models import VirtualMachineRunCommandScriptSource
from ._models import VirtualMachineRunCommandUpdate
from ._models import VirtualMachineScaleSet
from ._models import VirtualMachineScaleSetDataDisk
from ._models import VirtualMachineScaleSetExtension
Expand Down Expand Up @@ -364,6 +372,7 @@
from ._paged_models import UpgradeOperationHistoricalStatusInfoPaged
from ._paged_models import UsagePaged
from ._paged_models import VirtualMachinePaged
from ._paged_models import VirtualMachineRunCommandPaged
from ._paged_models import VirtualMachineScaleSetExtensionPaged
from ._paged_models import VirtualMachineScaleSetPaged
from ._paged_models import VirtualMachineScaleSetSkuPaged
Expand Down Expand Up @@ -410,6 +419,7 @@
RollingUpgradeActionType,
IntervalInMins,
OrchestrationServiceStateAction,
ExecutionState,
InstanceViewTypes,
)

Expand Down Expand Up @@ -536,6 +546,10 @@
'VirtualMachineInstanceView',
'VirtualMachinePatchStatus',
'VirtualMachineReimageParameters',
'VirtualMachineRunCommand',
'VirtualMachineRunCommandInstanceView',
'VirtualMachineRunCommandScriptSource',
'VirtualMachineRunCommandUpdate',
'VirtualMachineScaleSet',
'VirtualMachineScaleSetDataDisk',
'VirtualMachineScaleSetExtension',
Expand Down Expand Up @@ -601,6 +615,7 @@
'VirtualMachineScaleSetExtensionPaged',
'VirtualMachineScaleSetVMPaged',
'RunCommandDocumentBasePaged',
'VirtualMachineRunCommandPaged',
'VmDiskTypes',
'HyperVGenerationTypes',
'StatusLevelTypes',
Expand Down Expand Up @@ -641,5 +656,6 @@
'RollingUpgradeActionType',
'IntervalInMins',
'OrchestrationServiceStateAction',
'ExecutionState',
'InstanceViewTypes',
]
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,17 @@ class OrchestrationServiceStateAction(str, Enum):
suspend = "Suspend"


class ExecutionState(str, Enum):

unknown = "Unknown"
pending = "Pending"
running = "Running"
failed = "Failed"
succeeded = "Succeeded"
timed_out = "TimedOut"
canceled = "Canceled"


class InstanceViewTypes(str, Enum):

instance_view = "instanceView"
Loading