ThroughputPoolAccountOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a ThroughputPoolAccount operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
create	Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
delete
get	Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputPoolAccountResource>, ThroughputPoolAccountResource>>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputPoolAccountResource>, ThroughputPoolAccountResource>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams) => Promise<ThroughputPoolAccountResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams) => Promise<ThroughputPoolAccountResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams) => Promise<void>

create

Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.

create: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams) => PollerLike<OperationState<ThroughputPoolAccountResource>, ThroughputPoolAccountResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams) => PollerLike<OperationState<ThroughputPoolAccountResource>, ThroughputPoolAccountResource>

delete

delete: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

get: (resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountGetOptionalParams) => Promise<ThroughputPoolAccountResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountGetOptionalParams) => Promise<ThroughputPoolAccountResource>