Package version:

Interface CloudServicesUpdateDomain

Interface representing a CloudServicesUpdateDomain.

interface CloudServicesUpdateDomain {
    beginWalkUpdateDomain(resourceGroupName: string, cloudServiceName: string, updateDomain: number, options?: CloudServicesUpdateDomainWalkUpdateDomainOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginWalkUpdateDomainAndWait(resourceGroupName: string, cloudServiceName: string, updateDomain: number, options?: CloudServicesUpdateDomainWalkUpdateDomainOptionalParams): Promise<void>;
    getUpdateDomain(resourceGroupName: string, cloudServiceName: string, updateDomain: number, options?: CloudServicesUpdateDomainGetUpdateDomainOptionalParams): Promise<UpdateDomain>;
    listUpdateDomains(resourceGroupName: string, cloudServiceName: string, options?: CloudServicesUpdateDomainListUpdateDomainsOptionalParams): PagedAsyncIterableIterator<UpdateDomain>;
}

Methods

beginWalkUpdateDomain(resourceGroupName, cloudServiceName, updateDomain, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Updates the role instances in the specified update domain.
Parameters
- resourceGroupName: string
  Name of the resource group.
- cloudServiceName: string
  Name of the cloud service.
- updateDomain: number
  Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on.
- Optionaloptions: CloudServicesUpdateDomainWalkUpdateDomainOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/cloudServicesUpdateDomain.ts:42

beginWalkUpdateDomainAndWait(resourceGroupName, cloudServiceName, updateDomain, options?): Promise<void>
Updates the role instances in the specified update domain.
Parameters
- resourceGroupName: string
  Name of the resource group.
- cloudServiceName: string
  Name of the cloud service.
- updateDomain: number
  Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on.
- Optionaloptions: CloudServicesUpdateDomainWalkUpdateDomainOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/cloudServicesUpdateDomain.ts:57

getUpdateDomain(resourceGroupName, cloudServiceName, updateDomain, options?): Promise<UpdateDomain>
Gets the specified update domain of a cloud service. Use nextLink property in the response to get the next page of update domains. Do this till nextLink is null to fetch all the update domains.
Parameters
- resourceGroupName: string
  Name of the resource group.
- cloudServiceName: string
  Name of the cloud service.
- updateDomain: number
  Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on.
- Optionaloptions: CloudServicesUpdateDomainGetUpdateDomainOptionalParams
  The options parameters.
Returns Promise<UpdateDomain>
- Defined in operationsInterfaces/cloudServicesUpdateDomain.ts:73

listUpdateDomains(resourceGroupName, cloudServiceName, options?): PagedAsyncIterableIterator<UpdateDomain>
Gets a list of all update domains in a cloud service.
Parameters
- resourceGroupName: string
  Name of the resource group.
- cloudServiceName: string
  Name of the cloud service.
- Optionaloptions: CloudServicesUpdateDomainListUpdateDomainsOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<UpdateDomain>
- Defined in operationsInterfaces/cloudServicesUpdateDomain.ts:28