DomainServices interface

Package:

@azure/arm-domainservices

Interface representing a DomainServices.

Methods

beginCreateOrUpdate(string, string, DomainService, DomainServicesCreateOrUpdateOptionalParams)	The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.
beginCreateOrUpdateAndWait(string, string, DomainService, DomainServicesCreateOrUpdateOptionalParams)	The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.
beginDelete(string, string, DomainServicesDeleteOptionalParams)	The Delete Domain Service operation deletes an existing Domain Service.
beginDeleteAndWait(string, string, DomainServicesDeleteOptionalParams)	The Delete Domain Service operation deletes an existing Domain Service.
beginUpdate(string, string, DomainService, DomainServicesUpdateOptionalParams)	The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.
beginUpdateAndWait(string, string, DomainService, DomainServicesUpdateOptionalParams)	The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.
get(string, string, DomainServicesGetOptionalParams)	The Get Domain Service operation retrieves a json representation of the Domain Service.
list(DomainServicesListOptionalParams)	The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).
listByResourceGroup(string, DomainServicesListByResourceGroupOptionalParams)	The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.

Method Details

beginCreateOrUpdate(string, string, DomainService, DomainServicesCreateOrUpdateOptionalParams)

The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.

function beginCreateOrUpdate(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainService>, DomainService>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

domainService

DomainService

Properties supplied to the Create or Update a Domain Service operation.

options

DomainServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<DomainService>, DomainService>>

beginCreateOrUpdateAndWait(string, string, DomainService, DomainServicesCreateOrUpdateOptionalParams)

The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.

function beginCreateOrUpdateAndWait(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesCreateOrUpdateOptionalParams): Promise<DomainService>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

domainService

DomainService

Properties supplied to the Create or Update a Domain Service operation.

options

DomainServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DomainService>

beginDelete(string, string, DomainServicesDeleteOptionalParams)

The Delete Domain Service operation deletes an existing Domain Service.

function beginDelete(resourceGroupName: string, domainServiceName: string, options?: DomainServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

options

DomainServicesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, DomainServicesDeleteOptionalParams)

The Delete Domain Service operation deletes an existing Domain Service.

function beginDeleteAndWait(resourceGroupName: string, domainServiceName: string, options?: DomainServicesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

options

DomainServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, DomainService, DomainServicesUpdateOptionalParams)

The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.

function beginUpdate(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainService>, DomainService>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

domainService

DomainService

Properties supplied to the Update a Domain Service operation.

options

DomainServicesUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<DomainService>, DomainService>>

beginUpdateAndWait(string, string, DomainService, DomainServicesUpdateOptionalParams)

The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.

function beginUpdateAndWait(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesUpdateOptionalParams): Promise<DomainService>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

domainService

DomainService

Properties supplied to the Update a Domain Service operation.

options

DomainServicesUpdateOptionalParams

The options parameters.

Returns

Promise<DomainService>

get(string, string, DomainServicesGetOptionalParams)

The Get Domain Service operation retrieves a json representation of the Domain Service.

function get(resourceGroupName: string, domainServiceName: string, options?: DomainServicesGetOptionalParams): Promise<DomainService>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

domainServiceName

string

The name of the domain service.

options

DomainServicesGetOptionalParams

The options parameters.

Returns

Promise<DomainService>

list(DomainServicesListOptionalParams)

The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).

function list(options?: DomainServicesListOptionalParams): PagedAsyncIterableIterator<DomainService, DomainService[], PageSettings>

Parameters

options

DomainServicesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DomainService, DomainService[], PageSettings>

listByResourceGroup(string, DomainServicesListByResourceGroupOptionalParams)

The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.

function listByResourceGroup(resourceGroupName: string, options?: DomainServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DomainService, DomainService[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

options

DomainServicesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DomainService, DomainService[], PageSettings>