CloudServices interface

Package:

@azure/arm-compute

Interface representing a CloudServices.

Methods

beginCreateOrUpdate(string, string, CloudServicesCreateOrUpdateOptionalParams)	Create or update a cloud service. Please note some properties can be set only during cloud service creation.
beginCreateOrUpdateAndWait(string, string, CloudServicesCreateOrUpdateOptionalParams)	Create or update a cloud service. Please note some properties can be set only during cloud service creation.
beginDelete(string, string, CloudServicesDeleteOptionalParams)	Deletes a cloud service.
beginDeleteAndWait(string, string, CloudServicesDeleteOptionalParams)	Deletes a cloud service.
beginDeleteInstances(string, string, CloudServicesDeleteInstancesOptionalParams)	Deletes role instances in a cloud service.
beginDeleteInstancesAndWait(string, string, CloudServicesDeleteInstancesOptionalParams)	Deletes role instances in a cloud service.
beginPowerOff(string, string, CloudServicesPowerOffOptionalParams)	Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.
beginPowerOffAndWait(string, string, CloudServicesPowerOffOptionalParams)	Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.
beginRebuild(string, string, CloudServicesRebuildOptionalParams)	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.
beginRebuildAndWait(string, string, CloudServicesRebuildOptionalParams)	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.
beginReimage(string, string, CloudServicesReimageOptionalParams)	Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
beginReimageAndWait(string, string, CloudServicesReimageOptionalParams)	Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
beginRestart(string, string, CloudServicesRestartOptionalParams)	Restarts one or more role instances in a cloud service.
beginRestartAndWait(string, string, CloudServicesRestartOptionalParams)	Restarts one or more role instances in a cloud service.
beginStart(string, string, CloudServicesStartOptionalParams)	Starts the cloud service.
beginStartAndWait(string, string, CloudServicesStartOptionalParams)	Starts the cloud service.
beginUpdate(string, string, CloudServicesUpdateOptionalParams)	Update a cloud service.
beginUpdateAndWait(string, string, CloudServicesUpdateOptionalParams)	Update a cloud service.
get(string, string, CloudServicesGetOptionalParams)	Display information about a cloud service.
getInstanceView(string, string, CloudServicesGetInstanceViewOptionalParams)	Gets the status of a cloud service.
list(string, CloudServicesListOptionalParams)	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.
listAll(CloudServicesListAllOptionalParams)	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.

Method Details

beginCreateOrUpdate(string, string, CloudServicesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CloudService>, CloudService>>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, CloudServicesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesCreateOrUpdateOptionalParams): Promise<CloudService>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CloudService>

beginDelete(string, string, CloudServicesDeleteOptionalParams)

Deletes a cloud service.

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, CloudServicesDeleteOptionalParams)

Deletes a cloud service.

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteInstances(string, string, CloudServicesDeleteInstancesOptionalParams)

Deletes role instances in a cloud service.

function beginDeleteInstances(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesDeleteInstancesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesDeleteInstancesOptionalParams

The options parameters.

Returns

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

beginDeleteInstancesAndWait(string, string, CloudServicesDeleteInstancesOptionalParams)

Deletes role instances in a cloud service.

function beginDeleteInstancesAndWait(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesDeleteInstancesOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesDeleteInstancesOptionalParams

The options parameters.

Returns

Promise<void>

beginPowerOff(string, string, CloudServicesPowerOffOptionalParams)

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

function beginPowerOff(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesPowerOffOptionalParams

The options parameters.

Returns

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

beginPowerOffAndWait(string, string, CloudServicesPowerOffOptionalParams)

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

function beginPowerOffAndWait(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesPowerOffOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesPowerOffOptionalParams

The options parameters.

Returns

Promise<void>

beginRebuild(string, string, CloudServicesRebuildOptionalParams)

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.

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesRebuildOptionalParams

The options parameters.

Returns

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

beginRebuildAndWait(string, string, CloudServicesRebuildOptionalParams)

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.

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesRebuildOptionalParams

The options parameters.

Returns

Promise<void>

beginReimage(string, string, CloudServicesReimageOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesReimageOptionalParams

The options parameters.

Returns

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

beginReimageAndWait(string, string, CloudServicesReimageOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesReimageOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, CloudServicesRestartOptionalParams)

Restarts one or more role instances in a cloud service.

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesRestartOptionalParams

The options parameters.

Returns

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

beginRestartAndWait(string, string, CloudServicesRestartOptionalParams)

Restarts one or more role instances in a cloud service.

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

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, CloudServicesStartOptionalParams)

Starts the cloud service.

function beginStart(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, CloudServicesStartOptionalParams)

Starts the cloud service.

function beginStartAndWait(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesStartOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, CloudServicesUpdateOptionalParams)

Update a cloud service.

function beginUpdate(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CloudService>, CloudService>>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, CloudServicesUpdateOptionalParams)

Update a cloud service.

function beginUpdateAndWait(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesUpdateOptionalParams): Promise<CloudService>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesUpdateOptionalParams

The options parameters.

Returns

Promise<CloudService>

get(string, string, CloudServicesGetOptionalParams)

Display information about a cloud service.

function get(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesGetOptionalParams): Promise<CloudService>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesGetOptionalParams

The options parameters.

Returns

Promise<CloudService>

getInstanceView(string, string, CloudServicesGetInstanceViewOptionalParams)

Gets the status of a cloud service.

function getInstanceView(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesGetInstanceViewOptionalParams): Promise<CloudServiceInstanceView>

Parameters

resourceGroupName

string

Name of the resource group.

cloudServiceName

string

Name of the cloud service.

options

CloudServicesGetInstanceViewOptionalParams

The options parameters.

Returns

Promise<CloudServiceInstanceView>

list(string, CloudServicesListOptionalParams)

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.

function list(resourceGroupName: string, options?: CloudServicesListOptionalParams): PagedAsyncIterableIterator<CloudService, CloudService[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group.

options

CloudServicesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CloudService, CloudService[], PageSettings>

listAll(CloudServicesListAllOptionalParams)

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.

function listAll(options?: CloudServicesListAllOptionalParams): PagedAsyncIterableIterator<CloudService, CloudService[], PageSettings>

Parameters

options

CloudServicesListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CloudService, CloudService[], PageSettings>