CloudServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:cloud_services> attribute.

Constructor

CloudServicesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a cloud service. Please note some properties can be set only during cloud service creation.
begin_delete	Deletes a cloud service.
begin_delete_instances	Deletes role instances in a cloud service.
begin_power_off	Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.
begin_rebuild	Rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instances.
begin_reimage	Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
begin_restart	Restarts one or more role instances in a cloud service.
begin_start	Starts the cloud service.
begin_update	Update a cloud service.
get	Display information about a cloud service.
get_instance_view	Gets the status of a cloud service.
list	Gets a list of all cloud services under a resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.
list_all	Gets a list of all cloud services in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.

begin_create_or_update

Create or update a cloud service. Please note some properties can be set only during cloud service creation.

begin_create_or_update(resource_group_name: str, cloud_service_name: str, parameters: _models.CloudService | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CloudService]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.
parameters	CloudService or IO[bytes] The cloud service object. Is either a CloudService type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[CloudService]	An instance of LROPoller that returns either CloudService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a cloud service.

begin_delete(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_instances

Deletes role instances in a cloud service.

begin_delete_instances(resource_group_name: str, cloud_service_name: str, parameters: _models.RoleInstances | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.
parameters	RoleInstances or IO[bytes] List of cloud service role instance names. Is either a RoleInstances type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_power_off

Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.

begin_power_off(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_rebuild

Rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instances.

begin_rebuild(resource_group_name: str, cloud_service_name: str, parameters: _models.RoleInstances | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.
parameters	RoleInstances or IO[bytes] List of cloud service role instance names. Is either a RoleInstances type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_reimage

Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

begin_reimage(resource_group_name: str, cloud_service_name: str, parameters: _models.RoleInstances | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.
parameters	RoleInstances or IO[bytes] List of cloud service role instance names. Is either a RoleInstances type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_restart

Restarts one or more role instances in a cloud service.

begin_restart(resource_group_name: str, cloud_service_name: str, parameters: _models.RoleInstances | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.
parameters	RoleInstances or IO[bytes] List of cloud service role instance names. Is either a RoleInstances type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start

Starts the cloud service.

begin_start(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Update a cloud service.

begin_update(resource_group_name: str, cloud_service_name: str, parameters: _models.CloudServiceUpdate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CloudService]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.
parameters	CloudServiceUpdate or IO[bytes] The cloud service object. Is either a CloudServiceUpdate type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
LROPoller[CloudService]	An instance of LROPoller that returns either CloudService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Display information about a cloud service.

get(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> CloudService

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.

Returns

Type	Description
CloudService	CloudService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_instance_view

Gets the status of a cloud service.

get_instance_view(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> CloudServiceInstanceView

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.
cloud_service_name Required	str Name of the cloud service. Required.

Returns

Type	Description
CloudServiceInstanceView	CloudServiceInstanceView or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets a list of all cloud services under a resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.

list(resource_group_name: str, **kwargs: Any) -> ItemPaged[CloudService]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group. Required.

Returns

Type	Description
ItemPaged[CloudService]	An iterator like instance of either CloudService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_all

Gets a list of all cloud services in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.

list_all(**kwargs: Any) -> ItemPaged[CloudService]

Returns

Type	Description
ItemPaged[CloudService]	An iterator like instance of either CloudService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.compute.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv89\\Lib\\site-packages\\azure\\mgmt\\compute\\models\\__init__.py'>

Feedback

Was this page helpful?

Share via

CloudServicesOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

begin_delete_instances

Parameters

Returns

Exceptions

begin_power_off

Parameters

Returns

Exceptions

begin_rebuild

Parameters

Returns

Exceptions

begin_reimage

Parameters

Returns

Exceptions

begin_restart

Parameters

Returns

Exceptions

begin_start

Parameters

Returns

Exceptions

begin_update

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_instance_view

Parameters

Returns

Exceptions

list

Parameters

Returns

Exceptions

list_all

Returns

Exceptions

Attributes

models

Feedback