Share via

CloudServiceRoleInstancesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:cloud_service_role_instances> attribute.

Inheritance
builtins.object
CloudServiceRoleInstancesOperations

Constructor

CloudServiceRoleInstancesOperations(*args, **kwargs)

Methods

begin_delete

Deletes a role instance from a cloud service.
begin_rebuild

The Rebuild Role Instance asynchronous operation 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 Instance.
begin_reimage

The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
begin_restart

The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.
get

Gets a role instance from a cloud service.
get_instance_view

Retrieves information about the run-time state of a role instance in a cloud service.
get_remote_desktop_file

Gets a remote desktop file for a role instance in a cloud service.
list

Gets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is null to fetch all the role instances.

begin_delete

Deletes a role instance from a cloud service.

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

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
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

The Rebuild Role Instance asynchronous operation 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 Instance.

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

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
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_reimage

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

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

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
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_restart

The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.

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

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
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

get

Gets a role instance from a cloud service.

get(role_instance_name: str, resource_group_name: str, cloud_service_name: str, *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> RoleInstance

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
resource_group_name
Required
str

Name of the resource group. Required.
cloud_service_name
Required
str

Name of the cloud service. Required.

Keyword-Only Parameters

Name Description
expand
str or InstanceViewTypes

The expand expression to apply to the operation. 'UserData' is not supported for cloud services. Known values are: "instanceView" and "userData". Default value is None.

Returns

Type Description
RoleInstance

RoleInstance or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_instance_view

Retrieves information about the run-time state of a role instance in a cloud service.

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

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
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
RoleInstanceView

RoleInstanceView or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_remote_desktop_file

Gets a remote desktop file for a role instance in a cloud service.

get_remote_desktop_file(role_instance_name: str, resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> Iterator[bytes]

Parameters

Name Description
role_instance_name
Required
str

Name of the role instance. Required.
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
Iterator[bytes]

Iterator[bytes] or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is null to fetch all the role instances.

list(resource_group_name: str, cloud_service_name: str, *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> Iterable[RoleInstance]

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.

Keyword-Only Parameters

Name Description
expand
str or InstanceViewTypes

The expand expression to apply to the operation. 'UserData' is not supported for cloud services. Known values are: "instanceView" and "userData". Default value is None.

Returns

Type Description
ItemPaged[RoleInstance]

An iterator like instance of either RoleInstance or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2022_04_04.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2022_04_04\\models\\__init__.py'>