CloudServiceRoleInstances | @azure/arm-compute

Interface representing a CloudServiceRoleInstances.

Hierarchy

CloudServiceRoleInstances

Implemented by

CloudServiceRoleInstancesImpl

Index

Methods

beginDelete

beginDelete(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:49
Deletes a role instance from a cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:62
Deletes a role instance from a cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRebuild

beginRebuild(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRebuildOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:159
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.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesRebuildOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRebuildAndWait

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:174
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.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesRebuildOptionalParams
  
  The options parameters.
Returns Promise<void>

beginReimage

beginReimage(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:130
The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesReimageOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReimageAndWait

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:144
The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesReimageOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestart

beginRestart(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:102
The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:116
The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:75
Gets a role instance from a cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesGetOptionalParams
  
  The options parameters.
Returns Promise<CloudServiceRoleInstancesGetResponse>

getInstanceView

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:88
Retrieves information about the run-time state of a role instance in a cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesGetInstanceViewOptionalParams
  
  The options parameters.
Returns Promise<CloudServiceRoleInstancesGetInstanceViewResponse>

getRemoteDesktopFile

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

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:187
Gets a remote desktop file for a role instance in a cloud service.

Parameters
- roleInstanceName: string
  
  Name of the role instance.
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams
  
  The options parameters.
Returns Promise<CloudServiceRoleInstancesGetRemoteDesktopFileResponse>

list

list(resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesListOptionalParams): PagedAsyncIterableIterator<RoleInstance>

- Defined in operationsInterfaces/cloudServiceRoleInstances.ts:37
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.

Parameters
- resourceGroupName: string
- cloudServiceName: string
- Optional options: CloudServiceRoleInstancesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<RoleInstance>

Hierarchy

Implemented by

Index

Methods

Methods

beginDelete

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesDeleteOptionalParams

Returns Promise<void>

beginRebuild

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesRebuildOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRebuildAndWait

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesRebuildOptionalParams

Returns Promise<void>

beginReimage

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesReimageOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReimageAndWait

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesReimageOptionalParams

Returns Promise<void>

beginRestart

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesRestartOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesRestartOptionalParams

Returns Promise<void>

get

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesGetOptionalParams

Returns Promise<CloudServiceRoleInstancesGetResponse>

getInstanceView

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServiceRoleInstancesGetInstanceViewOptionalParams

Returns Promise<CloudServiceRoleInstancesGetInstanceViewResponse>

getRemoteDesktopFile

Parameters

roleInstanceName: string

resourceGroupName: string

cloudServiceName: string