Package version:

Interface CloudServiceRoleInstances

Interface representing a CloudServiceRoleInstances.

interface CloudServiceRoleInstances {
    beginDelete(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesDeleteOptionalParams): Promise<void>;
    beginRebuild(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRebuildOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRebuildAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRebuildOptionalParams): Promise<void>;
    beginReimage(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReimageAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesReimageOptionalParams): Promise<void>;
    beginRestart(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRestartAndWait(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesRestartOptionalParams): Promise<void>;
    get(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesGetOptionalParams): Promise<RoleInstance>;
    getInstanceView(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesGetInstanceViewOptionalParams): Promise<RoleInstanceView>;
    getRemoteDesktopFile(roleInstanceName: string, resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams): Promise<CloudServiceRoleInstancesGetRemoteDesktopFileResponse>;
    list(resourceGroupName: string, cloudServiceName: string, options?: CloudServiceRoleInstancesListOptionalParams): PagedAsyncIterableIterator<RoleInstance>;
}

Methods

beginDelete beginDeleteAndWait beginRebuild beginRebuildAndWait beginReimage beginReimageAndWait beginRestart beginRestartAndWait get getInstanceView getRemoteDesktopFile list

Methods

beginDelete

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

  • Deletes a role instance from a cloud service.

    Parameters

    • roleInstanceName: string

      Name of the role instance.

    • resourceGroupName: string

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

beginRebuild

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

  • 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

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesRebuildOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRebuildAndWait

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

  • 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

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesRebuildOptionalParams

      The options parameters.

    Returns Promise<void>

beginReimage

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

  • 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

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesReimageOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginReimageAndWait

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

  • 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

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesReimageOptionalParams

      The options parameters.

    Returns Promise<void>

beginRestart

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

  • 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

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesRestartOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait

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

  • 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

      Name of the resource group.

    • cloudServiceName: string

      Name of the cloud service.

    • Optionaloptions: CloudServiceRoleInstancesRestartOptionalParams

      The options parameters.

    Returns Promise<void>

get

getInstanceView

getRemoteDesktopFile

list

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

  • 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

    Returns PagedAsyncIterableIterator<RoleInstance>

Settings

Member Visibility