Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. ThroughputPool
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.ThroughputPool

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure Cosmos DB Throughputpool. Azure REST API version: 2023-11-15-preview.

Other available API versions: 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2024-12-01-preview.

Example Usage

CosmosDB ThroughputPool Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var throughputPool = new AzureNative.DocumentDB.ThroughputPool("throughputPool", new()
    {
        Location = "westus2",
        MaxThroughput = 10000,
        ResourceGroupName = "rg1",
        Tags = null,
        ThroughputPoolName = "tp1",
    });

});
Copy
package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewThroughputPool(ctx, "throughputPool", &documentdb.ThroughputPoolArgs{
			Location:           pulumi.String("westus2"),
			MaxThroughput:      pulumi.Int(10000),
			ResourceGroupName:  pulumi.String("rg1"),
			Tags:               pulumi.StringMap{},
			ThroughputPoolName: pulumi.String("tp1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.ThroughputPool;
import com.pulumi.azurenative.documentdb.ThroughputPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var throughputPool = new ThroughputPool("throughputPool", ThroughputPoolArgs.builder()
            .location("westus2")
            .maxThroughput(10000)
            .resourceGroupName("rg1")
            .tags()
            .throughputPoolName("tp1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const throughputPool = new azure_native.documentdb.ThroughputPool("throughputPool", {
    location: "westus2",
    maxThroughput: 10000,
    resourceGroupName: "rg1",
    tags: {},
    throughputPoolName: "tp1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

throughput_pool = azure_native.documentdb.ThroughputPool("throughputPool",
    location="westus2",
    max_throughput=10000,
    resource_group_name="rg1",
    tags={},
    throughput_pool_name="tp1")
Copy
resources:
  throughputPool:
    type: azure-native:documentdb:ThroughputPool
    properties:
      location: westus2
      maxThroughput: 10000
      resourceGroupName: rg1
      tags: {}
      throughputPoolName: tp1
Copy

Create ThroughputPool Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ThroughputPool(name: string, args: ThroughputPoolArgs, opts?: CustomResourceOptions);
@overload
def ThroughputPool(resource_name: str,
                   args: ThroughputPoolArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ThroughputPool(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   location: Optional[str] = None,
                   max_throughput: Optional[int] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   throughput_pool_name: Optional[str] = None)
func NewThroughputPool(ctx *Context, name string, args ThroughputPoolArgs, opts ...ResourceOption) (*ThroughputPool, error)
public ThroughputPool(string name, ThroughputPoolArgs args, CustomResourceOptions? opts = null)
public ThroughputPool(String name, ThroughputPoolArgs args)
public ThroughputPool(String name, ThroughputPoolArgs args, CustomResourceOptions options)

type: azure-native:documentdb:ThroughputPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ThroughputPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ThroughputPoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ThroughputPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ThroughputPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ThroughputPoolArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var throughputPoolResource = new AzureNative.Documentdb.ThroughputPool("throughputPoolResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    MaxThroughput = 0,
    Tags = 
    {
        { "string", "string" },
    },
    ThroughputPoolName = "string",
});
Copy
example, err := documentdb.NewThroughputPool(ctx, "throughputPoolResource", &documentdb.ThroughputPoolArgs{
	ResourceGroupName: "string",
	Location:          "string",
	MaxThroughput:     0,
	Tags: map[string]interface{}{
		"string": "string",
	},
	ThroughputPoolName: "string",
})
Copy
var throughputPoolResource = new ThroughputPool("throughputPoolResource", ThroughputPoolArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .maxThroughput(0)
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .throughputPoolName("string")
    .build());
Copy
throughput_pool_resource = azure_native.documentdb.ThroughputPool("throughputPoolResource",
    resource_group_name=string,
    location=string,
    max_throughput=0,
    tags={
        string: string,
    },
    throughput_pool_name=string)
Copy
const throughputPoolResource = new azure_native.documentdb.ThroughputPool("throughputPoolResource", {
    resourceGroupName: "string",
    location: "string",
    maxThroughput: 0,
    tags: {
        string: "string",
    },
    throughputPoolName: "string",
});
Copy
type: azure-native:documentdb:ThroughputPool
properties:
    location: string
    maxThroughput: 0
    resourceGroupName: string
    tags:
        string: string
    throughputPoolName: string
Copy

ThroughputPool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ThroughputPool resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
MaxThroughput int
Value for throughput to be shared among CosmosDB resources in the pool.
Tags Dictionary<string, string>
Resource tags.
ThroughputPoolName Changes to this property will trigger replacement. string
Cosmos DB Throughput Pool name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
MaxThroughput int
Value for throughput to be shared among CosmosDB resources in the pool.
Tags map[string]string
Resource tags.
ThroughputPoolName Changes to this property will trigger replacement. string
Cosmos DB Throughput Pool name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
maxThroughput Integer
Value for throughput to be shared among CosmosDB resources in the pool.
tags Map<String,String>
Resource tags.
throughputPoolName Changes to this property will trigger replacement. String
Cosmos DB Throughput Pool name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
maxThroughput number
Value for throughput to be shared among CosmosDB resources in the pool.
tags {[key: string]: string}
Resource tags.
throughputPoolName Changes to this property will trigger replacement. string
Cosmos DB Throughput Pool name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
max_throughput int
Value for throughput to be shared among CosmosDB resources in the pool.
tags Mapping[str, str]
Resource tags.
throughput_pool_name Changes to this property will trigger replacement. str
Cosmos DB Throughput Pool name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
maxThroughput Number
Value for throughput to be shared among CosmosDB resources in the pool.
tags Map<String>
Resource tags.
throughputPoolName Changes to this property will trigger replacement. String
Cosmos DB Throughput Pool name.

Outputs

All input properties are implicitly available as output properties. Additionally, the ThroughputPool resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
A provisioning state of the ThroughputPool.
SystemData Pulumi.AzureNative.DocumentDB.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"
Id string
The provider-assigned unique ID for this managed resource.
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"
id String
The provider-assigned unique ID for this managed resource.
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"
id string
The provider-assigned unique ID for this managed resource.
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"
id str
The provider-assigned unique ID for this managed resource.
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"
id String
The provider-assigned unique ID for this managed resource.
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"

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:documentdb:ThroughputPool tp1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native