ThroughputPool interface

Package:

@azure/arm-cosmosdb

Interface representing a ThroughputPool.

Methods

beginCreateOrUpdate(string, string, ThroughputPoolResource, ThroughputPoolCreateOrUpdateOptionalParams)	Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
beginCreateOrUpdateAndWait(string, string, ThroughputPoolResource, ThroughputPoolCreateOrUpdateOptionalParams)	Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
beginDelete(string, string, ThroughputPoolDeleteOptionalParams)	Deletes an existing Azure Cosmos DB Throughput Pool.
beginDeleteAndWait(string, string, ThroughputPoolDeleteOptionalParams)	Deletes an existing Azure Cosmos DB Throughput Pool.
beginUpdate(string, string, ThroughputPoolUpdateOptionalParams)	Updates the properties of an existing Azure Cosmos DB Throughput Pool.
beginUpdateAndWait(string, string, ThroughputPoolUpdateOptionalParams)	Updates the properties of an existing Azure Cosmos DB Throughput Pool.
get(string, string, ThroughputPoolGetOptionalParams)	Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

Method Details

beginCreateOrUpdate(string, string, ThroughputPoolResource, ThroughputPoolCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

body

ThroughputPoolResource

The parameters to provide for the current ThroughputPool.

options

ThroughputPoolCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>>

beginCreateOrUpdateAndWait(string, string, ThroughputPoolResource, ThroughputPoolCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

body

ThroughputPoolResource

The parameters to provide for the current ThroughputPool.

options

ThroughputPoolCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ThroughputPoolResource>

beginDelete(string, string, ThroughputPoolDeleteOptionalParams)

Deletes an existing Azure Cosmos DB Throughput Pool.

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

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

options

ThroughputPoolDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputPoolDeleteHeaders>, ThroughputPoolDeleteHeaders>>

beginDeleteAndWait(string, string, ThroughputPoolDeleteOptionalParams)

Deletes an existing Azure Cosmos DB Throughput Pool.

function beginDeleteAndWait(resourceGroupName: string, throughputPoolName: string, options?: ThroughputPoolDeleteOptionalParams): Promise<ThroughputPoolDeleteHeaders>

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

options

ThroughputPoolDeleteOptionalParams

The options parameters.

Returns

Promise<ThroughputPoolDeleteHeaders>

beginUpdate(string, string, ThroughputPoolUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

options

ThroughputPoolUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ThroughputPoolResource>, ThroughputPoolResource>>

beginUpdateAndWait(string, string, ThroughputPoolUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

options

ThroughputPoolUpdateOptionalParams

The options parameters.

Returns

Promise<ThroughputPoolResource>

get(string, string, ThroughputPoolGetOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

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

Parameters

resourceGroupName

string

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

throughputPoolName

string

Cosmos DB Throughput Pool name.

options

ThroughputPoolGetOptionalParams

The options parameters.

Returns

Promise<ThroughputPoolResource>