Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getThroughputPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getThroughputPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    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 for details.

    Using getThroughputPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getThroughputPool(args: GetThroughputPoolArgs, opts?: InvokeOptions): Promise<GetThroughputPoolResult>
function getThroughputPoolOutput(args: GetThroughputPoolOutputArgs, opts?: InvokeOptions): Output<GetThroughputPoolResult>
    def get_throughput_pool(resource_group_name: Optional[str] = None,
                        throughput_pool_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetThroughputPoolResult
def get_throughput_pool_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                        throughput_pool_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetThroughputPoolResult]
    func LookupThroughputPool(ctx *Context, args *LookupThroughputPoolArgs, opts ...InvokeOption) (*LookupThroughputPoolResult, error)
func LookupThroughputPoolOutput(ctx *Context, args *LookupThroughputPoolOutputArgs, opts ...InvokeOption) LookupThroughputPoolResultOutput

    > Note: This function is named LookupThroughputPool in the Go SDK.

    public static class GetThroughputPool 
{
    public static Task<GetThroughputPoolResult> InvokeAsync(GetThroughputPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetThroughputPoolResult> Invoke(GetThroughputPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetThroughputPoolResult> getThroughputPool(GetThroughputPoolArgs args, InvokeOptions options)
public static Output<GetThroughputPoolResult> getThroughputPool(GetThroughputPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cosmosdb:getThroughputPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ThroughputPoolName string
    Cosmos DB Throughput Pool name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ThroughputPoolName string
    Cosmos DB Throughput Pool name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    throughputPoolName String
    Cosmos DB Throughput Pool name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    throughputPoolName string
    Cosmos DB Throughput Pool name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    throughput_pool_name str
    Cosmos DB Throughput Pool name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    throughputPoolName String
    Cosmos DB Throughput Pool name.

    getThroughputPool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    A provisioning state of the ThroughputPool.
    SystemData Pulumi.AzureNative.CosmosDB.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    MaxThroughput int
    Value for throughput to be shared among CosmosDB resources in the pool.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    A provisioning state of the ThroughputPool.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    MaxThroughput int
    Value for throughput to be shared among CosmosDB resources in the pool.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    A provisioning state of the ThroughputPool.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    maxThroughput Integer
    Value for throughput to be shared among CosmosDB resources in the pool.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    A provisioning state of the ThroughputPool.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    maxThroughput number
    Value for throughput to be shared among CosmosDB resources in the pool.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    A provisioning state of the ThroughputPool.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    max_throughput int
    Value for throughput to be shared among CosmosDB resources in the pool.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    A provisioning state of the ThroughputPool.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    maxThroughput Number
    Value for throughput to be shared among CosmosDB resources in the pool.
    tags Map<String>
    Resource tags.

    Supporting Types

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native