Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. ThroughputPoolAccount
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.ThroughputPoolAccount

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    An Azure Cosmos DB Throughputpool Account 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 Account Create

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

return await Deployment.RunAsync(() => 
{
    var throughputPoolAccount = new AzureNative.DocumentDB.ThroughputPoolAccount("throughputPoolAccount", new()
    {
        AccountLocation = "West US",
        AccountResourceIdentifier = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/",
        ResourceGroupName = "rg1",
        ThroughputPoolAccountName = "db1",
        ThroughputPoolName = "tp1",
    });

});

    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.NewThroughputPoolAccount(ctx, "throughputPoolAccount", &documentdb.ThroughputPoolAccountArgs{
			AccountLocation:           pulumi.String("West US"),
			AccountResourceIdentifier: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/"),
			ResourceGroupName:         pulumi.String("rg1"),
			ThroughputPoolAccountName: pulumi.String("db1"),
			ThroughputPoolName:        pulumi.String("tp1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.ThroughputPoolAccount;
import com.pulumi.azurenative.documentdb.ThroughputPoolAccountArgs;
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 throughputPoolAccount = new ThroughputPoolAccount("throughputPoolAccount", ThroughputPoolAccountArgs.builder()
            .accountLocation("West US")
            .accountResourceIdentifier("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/")
            .resourceGroupName("rg1")
            .throughputPoolAccountName("db1")
            .throughputPoolName("tp1")
            .build());

    }
}

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

const throughputPoolAccount = new azure_native.documentdb.ThroughputPoolAccount("throughputPoolAccount", {
    accountLocation: "West US",
    accountResourceIdentifier: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/",
    resourceGroupName: "rg1",
    throughputPoolAccountName: "db1",
    throughputPoolName: "tp1",
});

    import pulumi
import pulumi_azure_native as azure_native

throughput_pool_account = azure_native.documentdb.ThroughputPoolAccount("throughputPoolAccount",
    account_location="West US",
    account_resource_identifier="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/",
    resource_group_name="rg1",
    throughput_pool_account_name="db1",
    throughput_pool_name="tp1")

    resources:
  throughputPoolAccount:
    type: azure-native:documentdb:ThroughputPoolAccount
    properties:
      accountLocation: West US
      accountResourceIdentifier: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/
      resourceGroupName: rg1
      throughputPoolAccountName: db1
      throughputPoolName: tp1

    Create ThroughputPoolAccount Resource

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

    Constructor syntax

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

@overload
def ThroughputPoolAccount(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource_group_name: Optional[str] = None,
                          throughput_pool_name: Optional[str] = None,
                          account_location: Optional[str] = None,
                          account_resource_identifier: Optional[str] = None,
                          throughput_pool_account_name: Optional[str] = None)
    func NewThroughputPoolAccount(ctx *Context, name string, args ThroughputPoolAccountArgs, opts ...ResourceOption) (*ThroughputPoolAccount, error)
    public ThroughputPoolAccount(string name, ThroughputPoolAccountArgs args, CustomResourceOptions? opts = null)
    public ThroughputPoolAccount(String name, ThroughputPoolAccountArgs args)
public ThroughputPoolAccount(String name, ThroughputPoolAccountArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ThroughputPoolAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ThroughputPoolAccountArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ThroughputPoolAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThroughputPoolAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThroughputPoolAccountArgs
    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 throughputPoolAccountResource = new AzureNative.DocumentDB.ThroughputPoolAccount("throughputPoolAccountResource", new()
{
    ResourceGroupName = "string",
    ThroughputPoolName = "string",
    AccountLocation = "string",
    AccountResourceIdentifier = "string",
    ThroughputPoolAccountName = "string",
});

    example, err := documentdb.NewThroughputPoolAccount(ctx, "throughputPoolAccountResource", &documentdb.ThroughputPoolAccountArgs{
	ResourceGroupName:         pulumi.String("string"),
	ThroughputPoolName:        pulumi.String("string"),
	AccountLocation:           pulumi.String("string"),
	AccountResourceIdentifier: pulumi.String("string"),
	ThroughputPoolAccountName: pulumi.String("string"),
})

    var throughputPoolAccountResource = new ThroughputPoolAccount("throughputPoolAccountResource", ThroughputPoolAccountArgs.builder()
    .resourceGroupName("string")
    .throughputPoolName("string")
    .accountLocation("string")
    .accountResourceIdentifier("string")
    .throughputPoolAccountName("string")
    .build());

    throughput_pool_account_resource = azure_native.documentdb.ThroughputPoolAccount("throughputPoolAccountResource",
    resource_group_name="string",
    throughput_pool_name="string",
    account_location="string",
    account_resource_identifier="string",
    throughput_pool_account_name="string")

    const throughputPoolAccountResource = new azure_native.documentdb.ThroughputPoolAccount("throughputPoolAccountResource", {
    resourceGroupName: "string",
    throughputPoolName: "string",
    accountLocation: "string",
    accountResourceIdentifier: "string",
    throughputPoolAccountName: "string",
});

    type: azure-native:documentdb:ThroughputPoolAccount
properties:
    accountLocation: string
    accountResourceIdentifier: string
    resourceGroupName: string
    throughputPoolAccountName: string
    throughputPoolName: string

    ThroughputPoolAccount 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 ThroughputPoolAccount resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ThroughputPoolName string
    Cosmos DB Throughput Pool name.
    AccountLocation string
    The location of global database account in the throughputPool.
    AccountResourceIdentifier string
    The resource identifier of global database account in the throughputPool.
    ThroughputPoolAccountName string
    Cosmos DB global database account in a Throughput Pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ThroughputPoolName string
    Cosmos DB Throughput Pool name.
    AccountLocation string
    The location of global database account in the throughputPool.
    AccountResourceIdentifier string
    The resource identifier of global database account in the throughputPool.
    ThroughputPoolAccountName string
    Cosmos DB global database account in a Throughput Pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    throughputPoolName String
    Cosmos DB Throughput Pool name.
    accountLocation String
    The location of global database account in the throughputPool.
    accountResourceIdentifier String
    The resource identifier of global database account in the throughputPool.
    throughputPoolAccountName String
    Cosmos DB global database account in a Throughput Pool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    throughputPoolName string
    Cosmos DB Throughput Pool name.
    accountLocation string
    The location of global database account in the throughputPool.
    accountResourceIdentifier string
    The resource identifier of global database account in the throughputPool.
    throughputPoolAccountName string
    Cosmos DB global database account in a Throughput Pool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    throughput_pool_name str
    Cosmos DB Throughput Pool name.
    account_location str
    The location of global database account in the throughputPool.
    account_resource_identifier str
    The resource identifier of global database account in the throughputPool.
    throughput_pool_account_name str
    Cosmos DB global database account in a Throughput Pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    throughputPoolName String
    Cosmos DB Throughput Pool name.
    accountLocation String
    The location of global database account in the throughputPool.
    accountResourceIdentifier String
    The resource identifier of global database account in the throughputPool.
    throughputPoolAccountName String
    Cosmos DB global database account in a Throughput Pool

    Outputs

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

    AccountInstanceId string
    The instance id of global database account in the throughputPool.
    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 Account.
    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"
    AccountInstanceId string
    The instance id of global database account in the throughputPool.
    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 Account.
    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"
    accountInstanceId String
    The instance id of global database account in the throughputPool.
    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 Account.
    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"
    accountInstanceId string
    The instance id of global database account in the throughputPool.
    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 Account.
    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"
    account_instance_id str
    The instance id of global database account in the throughputPool.
    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 Account.
    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"
    accountInstanceId String
    The instance id of global database account in the throughputPool.
    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 Account.
    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:ThroughputPoolAccount myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}

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

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native