CloudServiceRoleInstances interface

Package:

@azure/arm-compute

Interface representing a CloudServiceRoleInstances.

Methods

beginDelete(string, string, string, CloudServiceRoleInstancesDeleteOptionalParams)	Deletes a role instance from a cloud service.
beginDeleteAndWait(string, string, string, CloudServiceRoleInstancesDeleteOptionalParams)	Deletes a role instance from a cloud service.
beginRebuild(string, string, string, CloudServiceRoleInstancesRebuildOptionalParams)	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.
beginRebuildAndWait(string, string, string, CloudServiceRoleInstancesRebuildOptionalParams)	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.
beginReimage(string, string, string, CloudServiceRoleInstancesReimageOptionalParams)	The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
beginReimageAndWait(string, string, string, CloudServiceRoleInstancesReimageOptionalParams)	The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
beginRestart(string, string, string, CloudServiceRoleInstancesRestartOptionalParams)	The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.
beginRestartAndWait(string, string, string, CloudServiceRoleInstancesRestartOptionalParams)	The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.
get(string, string, string, CloudServiceRoleInstancesGetOptionalParams)	Gets a role instance from a cloud service.
getInstanceView(string, string, string, CloudServiceRoleInstancesGetInstanceViewOptionalParams)	Retrieves information about the run-time state of a role instance in a cloud service.
getRemoteDesktopFile(string, string, string, CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams)	Gets a remote desktop file for a role instance in a cloud service.
list(string, string, CloudServiceRoleInstancesListOptionalParams)	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.

Method Details

beginDelete(string, string, string, CloudServiceRoleInstancesDeleteOptionalParams)

Deletes a role instance from a cloud service.

function beginDelete(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, CloudServiceRoleInstancesDeleteOptionalParams)

Deletes a role instance from a cloud service.

function beginDeleteAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesDeleteOptionalParams): Promise<void>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRebuild(string, string, string, CloudServiceRoleInstancesRebuildOptionalParams)

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.

function beginRebuild(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRebuildOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesRebuildOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRebuildAndWait(string, string, string, CloudServiceRoleInstancesRebuildOptionalParams)

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.

function beginRebuildAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRebuildOptionalParams): Promise<void>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesRebuildOptionalParams

The options parameters.

Returns

Promise<void>

beginReimage(string, string, string, CloudServiceRoleInstancesReimageOptionalParams)

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

function beginReimage(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesReimageOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginReimageAndWait(string, string, string, CloudServiceRoleInstancesReimageOptionalParams)

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

function beginReimageAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesReimageOptionalParams): Promise<void>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesReimageOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, string, CloudServiceRoleInstancesRestartOptionalParams)

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

function beginRestart(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, string, CloudServiceRoleInstancesRestartOptionalParams)

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

function beginRestartAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRestartOptionalParams): Promise<void>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesRestartOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, CloudServiceRoleInstancesGetOptionalParams)

Gets a role instance from a cloud service.

function get(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesGetOptionalParams): Promise<RoleInstance>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesGetOptionalParams

The options parameters.

Returns

Promise<RoleInstance>

getInstanceView(string, string, string, CloudServiceRoleInstancesGetInstanceViewOptionalParams)

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

function getInstanceView(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesGetInstanceViewOptionalParams): Promise<RoleInstanceView>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesGetInstanceViewOptionalParams

The options parameters.

Returns

Promise<RoleInstanceView>

getRemoteDesktopFile(string, string, string, CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams)

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

function getRemoteDesktopFile(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams): Promise<CloudServiceRoleInstancesGetRemoteDesktopFileResponse>

Parameters

roleInstanceName

string

Name of the role instance.

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams

The options parameters.

Returns

Promise<CloudServiceRoleInstancesGetRemoteDesktopFileResponse>

list(string, string, CloudServiceRoleInstancesListOptionalParams)

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.

function list(resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesListOptionalParams): PagedAsyncIterableIterator<RoleInstance, RoleInstance[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServiceRoleInstancesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RoleInstance, RoleInstance[], PageSettings>