Throughput Pool
An Azure Cosmos DB Throughputpool. 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. 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/#accessing-any-api-version-via-local-packages for details.
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.CosmosDB.ThroughputPool("throughputPool", new()
{
Location = "westus2",
MaxThroughput = 10000,
ResourceGroupName = "rg1",
Tags = null,
ThroughputPoolName = "tp1",
});
});
Content copied to clipboard
package main
import (
cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cosmosdb.NewThroughputPool(ctx, "throughputPool", &cosmosdb.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
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.ThroughputPool;
import com.pulumi.azurenative.cosmosdb.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());
}
}
Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cosmosdb:ThroughputPool tp1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}
Content copied to clipboard
Properties
Link copied to clipboard
The Azure API version of the resource.
Link copied to clipboard
Value for throughput to be shared among CosmosDB resources in the pool.
Link copied to clipboard
A provisioning state of the ThroughputPool.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Azure Resource Manager metadata containing createdBy and modifiedBy information.