ServiceImpl | @azure/arm-cosmosdb

Class containing Service operations.

Hierarchy

ServiceImpl

Implements

Service

Index

Constructors

constructor

Methods

Constructors

constructor

new ServiceImpl(client: CosmosDBManagementClient): ServiceImpl

- Defined in operations/service.ts:32
Initialize a new instance of the class Service class.

Parameters
- client: CosmosDBManagementClient
  
  Reference to the service client
Returns ServiceImpl

Methods

beginCreate

beginCreate(resourceGroupName: string, accountName: string, serviceName: string, createUpdateParameters: ServiceResourceCreateUpdateParameters, options?: ServiceCreateOptionalParams): Promise<PollerLike<PollOperationState<ServiceCreateResponse>, ServiceCreateResponse>>

Implementation of Service.beginCreate
- Defined in operations/service.ts:115
Creates a service.

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.
- Optional options: ServiceCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ServiceCreateResponse>, ServiceCreateResponse>>

beginCreateAndWait

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

Implementation of Service.beginCreateAndWait
- Defined in operations/service.ts:190
Creates a service.

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.
- Optional options: ServiceCreateOptionalParams
  
  The options parameters.
Returns Promise<ServiceCreateResponse>

beginDelete

beginDelete(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Service.beginDelete
- Defined in operations/service.ts:233
Deletes service with the given serviceName.

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.
- Optional options: ServiceDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of Service.beginDeleteAndWait
- Defined in operations/service.ts:298
Deletes service with the given serviceName.

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.
- Optional options: ServiceDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of Service.get
- Defined in operations/service.ts:214
Gets the status of service.

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.
- Optional options: ServiceGetOptionalParams
  
  The options parameters.
Returns Promise<ServiceGetResponse>

list

list(resourceGroupName: string, accountName: string, options?: ServiceListOptionalParams): PagedAsyncIterableIterator<ServiceResource>

Implementation of Service.list
- Defined in operations/service.ts:48
Gets the status of service.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: ServiceListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ServiceResource>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CosmosDBManagementClient

Returns ServiceImpl

Methods

beginCreate

Parameters

resourceGroupName: string

accountName: string

serviceName: string

createUpdateParameters: ServiceResourceCreateUpdateParameters

Optional options: ServiceCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<ServiceCreateResponse>, ServiceCreateResponse>>

beginCreateAndWait

Parameters

resourceGroupName: string

accountName: string

serviceName: string

createUpdateParameters: ServiceResourceCreateUpdateParameters

Optional options: ServiceCreateOptionalParams

Returns Promise<ServiceCreateResponse>

beginDelete

Parameters

resourceGroupName: string

accountName: string

serviceName: string

Optional options: ServiceDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

accountName: string

serviceName: string

Optional options: ServiceDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

accountName: string

serviceName: string

Optional options: ServiceGetOptionalParams

Returns Promise<ServiceGetResponse>

list

Parameters

resourceGroupName: string

accountName: string

Optional options: ServiceListOptionalParams

Returns PagedAsyncIterableIterator<ServiceResource>