ThroughputPoolOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a ThroughputPool operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	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
update	Updates the properties of an existing Azure Cosmos DB Throughput Pool.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, throughputPoolName: string, body: ThroughputPoolResource, options?: ThroughputPoolCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>>

Property Value

(resourceGroupName: string, throughputPoolName: string, body: ThroughputPoolResource, options?: ThroughputPoolCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, throughputPoolName: string, body: ThroughputPoolResource, options?: ThroughputPoolCreateOrUpdateOptionalParams) => Promise<ThroughputPoolResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, body: ThroughputPoolResource, options?: ThroughputPoolCreateOrUpdateOptionalParams) => Promise<ThroughputPoolResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>>

Property Value

(resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolUpdateOptionalParams) => Promise<ThroughputPoolResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolUpdateOptionalParams) => Promise<ThroughputPoolResource>

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, throughputPoolName: string, body: ThroughputPoolResource, options?: ThroughputPoolCreateOrUpdateOptionalParams) => PollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, body: ThroughputPoolResource, options?: ThroughputPoolCreateOrUpdateOptionalParams) => PollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>

delete

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

Property Value

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

get

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

get: (resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolGetOptionalParams) => Promise<ThroughputPoolResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolGetOptionalParams) => Promise<ThroughputPoolResource>

update

Updates the properties of an existing Azure Cosmos DB Throughput Pool.

update: (resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolUpdateOptionalParams) => PollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>

Property Value

(resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolUpdateOptionalParams) => PollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>