CloudServices | @azure/arm-compute

Interface representing a CloudServices.

Hierarchy

CloudServices

Implemented by

CloudServicesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CloudServicesCreateOrUpdateResponse>, CloudServicesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/cloudServices.ts:62
Create or update a cloud service. Please note some properties can be set only during cloud service creation.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CloudServicesCreateOrUpdateResponse>, CloudServicesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:79
Create or update a cloud service. Please note some properties can be set only during cloud service creation.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CloudServicesCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/cloudServices.ts:117
Deletes a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:128
Deletes a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteInstances

beginDeleteInstances(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesDeleteInstancesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServices.ts:279
Deletes role instances in a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesDeleteInstancesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteInstancesAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:290
Deletes role instances in a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesDeleteInstancesOptionalParams
  
  The options parameters.
Returns Promise<void>

beginPowerOff

beginPowerOff(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServices.ts:184
Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesPowerOffOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPowerOffAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:196
Power off the cloud service. Note that resources are still attached and you are getting charged for the resources.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesPowerOffOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRebuild

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

- Defined in operationsInterfaces/cloudServices.ts:255
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.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesRebuildOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRebuildAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:268
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.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesRebuildOptionalParams
  
  The options parameters.
Returns Promise<void>

beginReimage

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

- Defined in operationsInterfaces/cloudServices.ts:230
Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesReimageOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReimageAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:242
Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesReimageOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestart

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

- Defined in operationsInterfaces/cloudServices.ts:207
Restarts one or more role instances in a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:218
Restarts one or more role instances in a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cloudServices.ts:161
Starts the cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:172
Starts the cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<CloudServicesUpdateResponse>, CloudServicesUpdateResponse>>

- Defined in operationsInterfaces/cloudServices.ts:90
Update a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CloudServicesUpdateResponse>, CloudServicesUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/cloudServices.ts:106
Update a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<CloudServicesUpdateResponse>

get

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

- Defined in operationsInterfaces/cloudServices.ts:139
Display information about a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesGetOptionalParams
  
  The options parameters.
Returns Promise<CloudServicesGetResponse>

getInstanceView

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

- Defined in operationsInterfaces/cloudServices.ts:150
Gets the status of a cloud service.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- cloudServiceName: string
  
  Name of the cloud service.
- Optional options: CloudServicesGetInstanceViewOptionalParams
  
  The options parameters.
Returns Promise<CloudServicesGetInstanceViewResponse>

list

list(resourceGroupName: string, options?: CloudServicesListOptionalParams): PagedAsyncIterableIterator<CloudService>

- Defined in operationsInterfaces/cloudServices.ts:51
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.

Parameters
- resourceGroupName: string
  
  Name of the resource group.
- Optional options: CloudServicesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CloudService>

listAll

listAll(options?: CloudServicesListAllOptionalParams): PagedAsyncIterableIterator<CloudService>

- Defined in operationsInterfaces/cloudServices.ts:42
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.

Parameters
- Optional options: CloudServicesListAllOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CloudService>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CloudServicesCreateOrUpdateResponse>, CloudServicesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesCreateOrUpdateOptionalParams

Returns Promise<CloudServicesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesDeleteOptionalParams

Returns Promise<void>

beginDeleteInstances

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesDeleteInstancesOptionalParams

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

beginDeleteInstancesAndWait

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesDeleteInstancesOptionalParams

Returns Promise<void>

beginPowerOff

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesPowerOffOptionalParams

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

beginPowerOffAndWait

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesPowerOffOptionalParams

Returns Promise<void>

beginRebuild

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesRebuildOptionalParams

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

beginRebuildAndWait

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesRebuildOptionalParams

Returns Promise<void>

beginReimage

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesReimageOptionalParams

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

beginReimageAndWait

Parameters

resourceGroupName: string

cloudServiceName: string

Optional options: CloudServicesReimageOptionalParams

Returns Promise<void>

beginRestart

Parameters

resourceGroupName: string