Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. getThroughputPoolAccount
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.getThroughputPoolAccount

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

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool 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.

Using getThroughputPoolAccount

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 getThroughputPoolAccount(args: GetThroughputPoolAccountArgs, opts?: InvokeOptions): Promise<GetThroughputPoolAccountResult>
function getThroughputPoolAccountOutput(args: GetThroughputPoolAccountOutputArgs, opts?: InvokeOptions): Output<GetThroughputPoolAccountResult>
Copy
def get_throughput_pool_account(resource_group_name: Optional[str] = None,
                                throughput_pool_account_name: Optional[str] = None,
                                throughput_pool_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetThroughputPoolAccountResult
def get_throughput_pool_account_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                throughput_pool_account_name: Optional[pulumi.Input[str]] = None,
                                throughput_pool_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetThroughputPoolAccountResult]
Copy
func LookupThroughputPoolAccount(ctx *Context, args *LookupThroughputPoolAccountArgs, opts ...InvokeOption) (*LookupThroughputPoolAccountResult, error)
func LookupThroughputPoolAccountOutput(ctx *Context, args *LookupThroughputPoolAccountOutputArgs, opts ...InvokeOption) LookupThroughputPoolAccountResultOutput
Copy

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

public static class GetThroughputPoolAccount 
{
    public static Task<GetThroughputPoolAccountResult> InvokeAsync(GetThroughputPoolAccountArgs args, InvokeOptions? opts = null)
    public static Output<GetThroughputPoolAccountResult> Invoke(GetThroughputPoolAccountInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetThroughputPoolAccountResult> getThroughputPoolAccount(GetThroughputPoolAccountArgs args, InvokeOptions options)
public static Output<GetThroughputPoolAccountResult> getThroughputPoolAccount(GetThroughputPoolAccountArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:getThroughputPoolAccount
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ThroughputPoolAccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB global database account in a Throughput Pool
ThroughputPoolName
This property is required.
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.
ThroughputPoolAccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB global database account in a Throughput Pool
ThroughputPoolName
This property is required.
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.
throughputPoolAccountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB global database account in a Throughput Pool
throughputPoolName
This property is required.
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.
throughputPoolAccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB global database account in a Throughput Pool
throughputPoolName
This property is required.
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.
throughput_pool_account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB global database account in a Throughput Pool
throughput_pool_name
This property is required.
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.
throughputPoolAccountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB global database account in a Throughput Pool
throughputPoolName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB Throughput Pool name.

getThroughputPoolAccount Result

The following output properties are available:

AccountInstanceId string
The instance id of global database account in the throughputPool.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
AccountLocation string
The location of global database account in the throughputPool.
AccountResourceIdentifier string
The resource identifier of global database account in the throughputPool.
AccountInstanceId string
The instance id of global database account in the throughputPool.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
AccountLocation string
The location of global database account in the throughputPool.
AccountResourceIdentifier string
The resource identifier of global database account in the throughputPool.
accountInstanceId String
The instance id of global database account in the throughputPool.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
accountLocation String
The location of global database account in the throughputPool.
accountResourceIdentifier String
The resource identifier of global database account in the throughputPool.
accountInstanceId string
The instance id of global database account in the throughputPool.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
accountLocation string
The location of global database account in the throughputPool.
accountResourceIdentifier string
The resource identifier of global database account in the throughputPool.
account_instance_id str
The instance id of global database account in the throughputPool.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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.
accountInstanceId String
The instance id of global database account in the throughputPool.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
accountLocation String
The location of global database account in the throughputPool.
accountResourceIdentifier String
The resource identifier of global database account in the throughputPool.

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-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