ThroughputPoolAccount interface
Interface representing a ThroughputPoolAccount.
Methods
| begin |
Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account. |
| begin |
Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account. |
| begin |
Removes an existing Azure Cosmos DB database account from a throughput pool. |
| begin |
Removes an existing Azure Cosmos DB database account from a throughput pool. |
| get(string, string, string, Throughput |
Retrieves the properties of an existing Azure Cosmos DB Throughput Pool |
Method Details
beginCreate(string, string, string, ThroughputPoolAccountResource, ThroughputPoolAccountCreateOptionalParams)
Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
function beginCreate(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputPoolAccountResource>, ThroughputPoolAccountResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- throughputPoolName
-
string
Cosmos DB Throughput Pool name.
- throughputPoolAccountName
-
string
Cosmos DB global database account in a Throughput Pool
The parameters to provide for the current ThroughputPoolAccount.
The options parameters.
Returns
beginCreateAndWait(string, string, string, ThroughputPoolAccountResource, ThroughputPoolAccountCreateOptionalParams)
Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
function beginCreateAndWait(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, body: ThroughputPoolAccountResource, options?: ThroughputPoolAccountCreateOptionalParams): Promise<ThroughputPoolAccountResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- throughputPoolName
-
string
Cosmos DB Throughput Pool name.
- throughputPoolAccountName
-
string
Cosmos DB global database account in a Throughput Pool
The parameters to provide for the current ThroughputPoolAccount.
The options parameters.
Returns
Promise<ThroughputPoolAccountResource>
beginDelete(string, string, string, ThroughputPoolAccountDeleteOptionalParams)
Removes an existing Azure Cosmos DB database account from a throughput pool.
function beginDelete(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputPoolAccountDeleteHeaders>, ThroughputPoolAccountDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- throughputPoolName
-
string
Cosmos DB Throughput Pool name.
- throughputPoolAccountName
-
string
Cosmos DB global database account in a Throughput Pool
The options parameters.
Returns
beginDeleteAndWait(string, string, string, ThroughputPoolAccountDeleteOptionalParams)
Removes an existing Azure Cosmos DB database account from a throughput pool.
function beginDeleteAndWait(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountDeleteOptionalParams): Promise<ThroughputPoolAccountDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- throughputPoolName
-
string
Cosmos DB Throughput Pool name.
- throughputPoolAccountName
-
string
Cosmos DB global database account in a Throughput Pool
The options parameters.
Returns
Promise<ThroughputPoolAccountDeleteHeaders>
get(string, string, string, ThroughputPoolAccountGetOptionalParams)
Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
function get(resourceGroupName: string, throughputPoolName: string, throughputPoolAccountName: string, options?: ThroughputPoolAccountGetOptionalParams): Promise<ThroughputPoolAccountResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- throughputPoolName
-
string
Cosmos DB Throughput Pool name.
- throughputPoolAccountName
-
string
Cosmos DB global database account in a Throughput Pool
The options parameters.
Returns
Promise<ThroughputPoolAccountResource>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for