@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
*
* Uses Azure REST API version 2024-12-01-preview.
*
* Other available API versions: 2023-11-15-preview, 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cosmosdb [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getThroughputPoolAccount(args: GetThroughputPoolAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetThroughputPoolAccountResult>;
export interface GetThroughputPoolAccountArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* Cosmos DB global database account in a Throughput Pool
*/
throughputPoolAccountName: string;
/**
* Cosmos DB Throughput Pool name.
*/
throughputPoolName: string;
}
/**
* An Azure Cosmos DB Throughputpool Account
*/
export interface GetThroughputPoolAccountResult {
/**
* The instance id of global database account in the throughputPool.
*/
readonly accountInstanceId: string;
/**
* The location of global database account in the throughputPool.
*/
readonly accountLocation?: string;
/**
* The resource identifier of global database account in the throughputPool.
*/
readonly accountResourceIdentifier?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* A provisioning state of the ThroughputPool Account.
*/
readonly provisioningState: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.cosmosdb.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
*
* Uses Azure REST API version 2024-12-01-preview.
*
* Other available API versions: 2023-11-15-preview, 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cosmosdb [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getThroughputPoolAccountOutput(args: GetThroughputPoolAccountOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetThroughputPoolAccountResult>;
export interface GetThroughputPoolAccountOutputArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Cosmos DB global database account in a Throughput Pool
*/
throughputPoolAccountName: pulumi.Input<string>;
/**
* Cosmos DB Throughput Pool name.
*/
throughputPoolName: pulumi.Input<string>;
}