Share via

Service interface

  • Reference
Package:
@azure/arm-cosmosdb

Interface representing a Service.

Methods

beginCreate(string, string, string, ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)

Creates a service.
beginCreateAndWait(string, string, string, ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)

Creates a service.
beginDelete(string, string, string, ServiceDeleteOptionalParams)

Deletes service with the given serviceName.
beginDeleteAndWait(string, string, string, ServiceDeleteOptionalParams)

Deletes service with the given serviceName.
get(string, string, string, ServiceGetOptionalParams)

Gets the status of service.
list(string, string, ServiceListOptionalParams)

Gets the status of service.

Method Details

beginCreate(string, string, string, ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)

Creates a service.

function beginCreate(resourceGroupName: string, accountName: string, serviceName: string, createUpdateParameters: ServiceResourceCreateUpdateParameters, options?: ServiceCreateOptionalParams): Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

serviceName

string

Cosmos DB service name.

createUpdateParameters
ServiceResourceCreateUpdateParameters

The Service resource parameters.

options
ServiceCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)

Creates a service.

function beginCreateAndWait(resourceGroupName: string, accountName: string, serviceName: string, createUpdateParameters: ServiceResourceCreateUpdateParameters, options?: ServiceCreateOptionalParams): Promise<ServiceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

serviceName

string

Cosmos DB service name.

createUpdateParameters
ServiceResourceCreateUpdateParameters

The Service resource parameters.

options
ServiceCreateOptionalParams

The options parameters.

Returns

Promise<ServiceResource>

beginDelete(string, string, string, ServiceDeleteOptionalParams)

Deletes service with the given serviceName.

function beginDelete(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

serviceName

string

Cosmos DB service name.

options
ServiceDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ServiceDeleteOptionalParams)

Deletes service with the given serviceName.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

serviceName

string

Cosmos DB service name.

options
ServiceDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ServiceGetOptionalParams)

Gets the status of service.

function get(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceGetOptionalParams): Promise<ServiceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

serviceName

string

Cosmos DB service name.

options
ServiceGetOptionalParams

The options parameters.

Returns

Promise<ServiceResource>

list(string, string, ServiceListOptionalParams)

Gets the status of service.

function list(resourceGroupName: string, accountName: string, options?: ServiceListOptionalParams): PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

options
ServiceListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>