1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. getAccount

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.cosmosdb.getAccount

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

    Use this data source to access information about an existing CosmosDB (formally DocumentDB) Account.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.CosmosDB.GetAccount.Invoke(new()
        {
            Name = "tfex-cosmosdb-account",
            ResourceGroupName = "tfex-cosmosdb-account-rg",
        });
    
        return new Dictionary<string, object?>
        {
            ["cosmosdbAccountEndpoint"] = example.Apply(getAccountResult => getAccountResult.Endpoint),
        };
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
    			Name:              "tfex-cosmosdb-account",
    			ResourceGroupName: "tfex-cosmosdb-account-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("cosmosdbAccountEndpoint", example.Endpoint)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.cosmosdb.CosmosdbFunctions;
    import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
    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) {
            final var example = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
                .name("tfex-cosmosdb-account")
                .resourceGroupName("tfex-cosmosdb-account-rg")
                .build());
    
            ctx.export("cosmosdbAccountEndpoint", example.applyValue(getAccountResult -> getAccountResult.endpoint()));
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
        resource_group_name="tfex-cosmosdb-account-rg")
    pulumi.export("cosmosdbAccountEndpoint", example.endpoint)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.cosmosdb.getAccount({
        name: "tfex-cosmosdb-account",
        resourceGroupName: "tfex-cosmosdb-account-rg",
    });
    export const cosmosdbAccountEndpoint = example.then(example => example.endpoint);
    
    variables:
      example:
        fn::invoke:
          Function: azure:cosmosdb:getAccount
          Arguments:
            name: tfex-cosmosdb-account
            resourceGroupName: tfex-cosmosdb-account-rg
    outputs:
      cosmosdbAccountEndpoint: ${example.endpoint}
    

    Using getAccount

    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 getAccount(args: GetAccountArgs, opts?: InvokeOptions): Promise<GetAccountResult>
    function getAccountOutput(args: GetAccountOutputArgs, opts?: InvokeOptions): Output<GetAccountResult>
    def get_account(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAccountResult
    def get_account_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAccountResult]
    func LookupAccount(ctx *Context, args *LookupAccountArgs, opts ...InvokeOption) (*LookupAccountResult, error)
    func LookupAccountOutput(ctx *Context, args *LookupAccountOutputArgs, opts ...InvokeOption) LookupAccountResultOutput

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

    public static class GetAccount 
    {
        public static Task<GetAccountResult> InvokeAsync(GetAccountArgs args, InvokeOptions? opts = null)
        public static Output<GetAccountResult> Invoke(GetAccountInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:cosmosdb/getAccount:getAccount
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string

    Specifies the name of the CosmosDB Account.

    ResourceGroupName string

    Specifies the name of the resource group in which the CosmosDB Account resides.

    Name string

    Specifies the name of the CosmosDB Account.

    ResourceGroupName string

    Specifies the name of the resource group in which the CosmosDB Account resides.

    name String

    Specifies the name of the CosmosDB Account.

    resourceGroupName String

    Specifies the name of the resource group in which the CosmosDB Account resides.

    name string

    Specifies the name of the CosmosDB Account.

    resourceGroupName string

    Specifies the name of the resource group in which the CosmosDB Account resides.

    name str

    Specifies the name of the CosmosDB Account.

    resource_group_name str

    Specifies the name of the resource group in which the CosmosDB Account resides.

    name String

    Specifies the name of the CosmosDB Account.

    resourceGroupName String

    Specifies the name of the resource group in which the CosmosDB Account resides.

    getAccount Result

    The following output properties are available:

    Capabilities List<GetAccountCapability>

    Capabilities enabled on this Cosmos DB account.

    ConsistencyPolicies List<GetAccountConsistencyPolicy>
    EnableAutomaticFailover bool

    If automatic failover is enabled for this CosmosDB Account.

    EnableFreeTier bool

    If Free Tier pricing option is enabled for this CosmosDB Account. You can have up to one free tier Azure Cosmos DB account per Azure subscription.

    EnableMultipleWriteLocations bool

    If multiple write locations are enabled for this Cosmos DB account.

    Endpoint string

    The endpoint used to connect to the CosmosDB account.

    GeoLocations List<GetAccountGeoLocation>
    Id string

    The provider-assigned unique ID for this managed resource.

    IpRangeFilter string

    The current IP Filter for this CosmosDB account

    IsVirtualNetworkFilterEnabled bool

    If virtual network filtering is enabled for this Cosmos DB account.

    KeyVaultKeyId string

    The Key Vault key URI for CMK encryption.

    Kind string

    The Kind of the CosmosDB account.

    Location string

    The name of the Azure region hosting replicated data.

    Name string
    OfferType string

    The Offer Type to used by this CosmosDB Account.

    PrimaryKey string

    The primary key for the CosmosDB account.

    PrimaryReadonlyKey string

    The primary read-only Key for the CosmosDB account.

    ReadEndpoints List<string>

    A list of read endpoints available for this CosmosDB account.

    ResourceGroupName string
    SecondaryKey string

    The secondary key for the CosmosDB account.

    SecondaryReadonlyKey string

    The secondary read-only key for the CosmosDB account.

    Tags Dictionary<string, string>

    A mapping of tags assigned to the resource.

    VirtualNetworkRules List<GetAccountVirtualNetworkRule>

    Subnets that are allowed to access this CosmosDB account.

    WriteEndpoints List<string>

    A list of write endpoints available for this CosmosDB account.

    Capabilities []GetAccountCapability

    Capabilities enabled on this Cosmos DB account.

    ConsistencyPolicies []GetAccountConsistencyPolicy
    EnableAutomaticFailover bool

    If automatic failover is enabled for this CosmosDB Account.

    EnableFreeTier bool

    If Free Tier pricing option is enabled for this CosmosDB Account. You can have up to one free tier Azure Cosmos DB account per Azure subscription.

    EnableMultipleWriteLocations bool

    If multiple write locations are enabled for this Cosmos DB account.

    Endpoint string

    The endpoint used to connect to the CosmosDB account.

    GeoLocations []GetAccountGeoLocation
    Id string

    The provider-assigned unique ID for this managed resource.

    IpRangeFilter string

    The current IP Filter for this CosmosDB account

    IsVirtualNetworkFilterEnabled bool

    If virtual network filtering is enabled for this Cosmos DB account.

    KeyVaultKeyId string

    The Key Vault key URI for CMK encryption.

    Kind string

    The Kind of the CosmosDB account.

    Location string

    The name of the Azure region hosting replicated data.

    Name string
    OfferType string

    The Offer Type to used by this CosmosDB Account.

    PrimaryKey string

    The primary key for the CosmosDB account.

    PrimaryReadonlyKey string

    The primary read-only Key for the CosmosDB account.

    ReadEndpoints []string

    A list of read endpoints available for this CosmosDB account.

    ResourceGroupName string
    SecondaryKey string

    The secondary key for the CosmosDB account.

    SecondaryReadonlyKey string

    The secondary read-only key for the CosmosDB account.

    Tags map[string]string

    A mapping of tags assigned to the resource.

    VirtualNetworkRules []GetAccountVirtualNetworkRule

    Subnets that are allowed to access this CosmosDB account.

    WriteEndpoints []string

    A list of write endpoints available for this CosmosDB account.

    capabilities List<GetAccountCapability>

    Capabilities enabled on this Cosmos DB account.

    consistencyPolicies List<GetAccountConsistencyPolicy>
    enableAutomaticFailover Boolean

    If automatic failover is enabled for this CosmosDB Account.

    enableFreeTier Boolean

    If Free Tier pricing option is enabled for this CosmosDB Account. You can have up to one free tier Azure Cosmos DB account per Azure subscription.

    enableMultipleWriteLocations Boolean

    If multiple write locations are enabled for this Cosmos DB account.

    endpoint String

    The endpoint used to connect to the CosmosDB account.

    geoLocations List<GetAccountGeoLocation>
    id String

    The provider-assigned unique ID for this managed resource.

    ipRangeFilter String

    The current IP Filter for this CosmosDB account

    isVirtualNetworkFilterEnabled Boolean

    If virtual network filtering is enabled for this Cosmos DB account.

    keyVaultKeyId String

    The Key Vault key URI for CMK encryption.

    kind String

    The Kind of the CosmosDB account.

    location String

    The name of the Azure region hosting replicated data.

    name String
    offerType String

    The Offer Type to used by this CosmosDB Account.

    primaryKey String

    The primary key for the CosmosDB account.

    primaryReadonlyKey String

    The primary read-only Key for the CosmosDB account.

    readEndpoints List<String>

    A list of read endpoints available for this CosmosDB account.

    resourceGroupName String
    secondaryKey String

    The secondary key for the CosmosDB account.

    secondaryReadonlyKey String

    The secondary read-only key for the CosmosDB account.

    tags Map<String,String>

    A mapping of tags assigned to the resource.

    virtualNetworkRules List<GetAccountVirtualNetworkRule>

    Subnets that are allowed to access this CosmosDB account.

    writeEndpoints List<String>

    A list of write endpoints available for this CosmosDB account.

    capabilities GetAccountCapability[]

    Capabilities enabled on this Cosmos DB account.

    consistencyPolicies GetAccountConsistencyPolicy[]
    enableAutomaticFailover boolean

    If automatic failover is enabled for this CosmosDB Account.

    enableFreeTier boolean

    If Free Tier pricing option is enabled for this CosmosDB Account. You can have up to one free tier Azure Cosmos DB account per Azure subscription.

    enableMultipleWriteLocations boolean

    If multiple write locations are enabled for this Cosmos DB account.

    endpoint string

    The endpoint used to connect to the CosmosDB account.

    geoLocations GetAccountGeoLocation[]
    id string

    The provider-assigned unique ID for this managed resource.

    ipRangeFilter string

    The current IP Filter for this CosmosDB account

    isVirtualNetworkFilterEnabled boolean

    If virtual network filtering is enabled for this Cosmos DB account.

    keyVaultKeyId string

    The Key Vault key URI for CMK encryption.

    kind string

    The Kind of the CosmosDB account.

    location string

    The name of the Azure region hosting replicated data.

    name string
    offerType string

    The Offer Type to used by this CosmosDB Account.

    primaryKey string

    The primary key for the CosmosDB account.

    primaryReadonlyKey string

    The primary read-only Key for the CosmosDB account.

    readEndpoints string[]

    A list of read endpoints available for this CosmosDB account.

    resourceGroupName string
    secondaryKey string

    The secondary key for the CosmosDB account.

    secondaryReadonlyKey string

    The secondary read-only key for the CosmosDB account.

    tags {[key: string]: string}

    A mapping of tags assigned to the resource.

    virtualNetworkRules GetAccountVirtualNetworkRule[]

    Subnets that are allowed to access this CosmosDB account.

    writeEndpoints string[]

    A list of write endpoints available for this CosmosDB account.

    capabilities Sequence[GetAccountCapability]

    Capabilities enabled on this Cosmos DB account.

    consistency_policies Sequence[GetAccountConsistencyPolicy]
    enable_automatic_failover bool

    If automatic failover is enabled for this CosmosDB Account.

    enable_free_tier bool

    If Free Tier pricing option is enabled for this CosmosDB Account. You can have up to one free tier Azure Cosmos DB account per Azure subscription.

    enable_multiple_write_locations bool

    If multiple write locations are enabled for this Cosmos DB account.

    endpoint str

    The endpoint used to connect to the CosmosDB account.

    geo_locations Sequence[GetAccountGeoLocation]
    id str

    The provider-assigned unique ID for this managed resource.

    ip_range_filter str

    The current IP Filter for this CosmosDB account

    is_virtual_network_filter_enabled bool

    If virtual network filtering is enabled for this Cosmos DB account.

    key_vault_key_id str

    The Key Vault key URI for CMK encryption.

    kind str

    The Kind of the CosmosDB account.

    location str

    The name of the Azure region hosting replicated data.

    name str
    offer_type str

    The Offer Type to used by this CosmosDB Account.

    primary_key str

    The primary key for the CosmosDB account.

    primary_readonly_key str

    The primary read-only Key for the CosmosDB account.

    read_endpoints Sequence[str]

    A list of read endpoints available for this CosmosDB account.

    resource_group_name str
    secondary_key str

    The secondary key for the CosmosDB account.

    secondary_readonly_key str

    The secondary read-only key for the CosmosDB account.

    tags Mapping[str, str]

    A mapping of tags assigned to the resource.

    virtual_network_rules Sequence[GetAccountVirtualNetworkRule]

    Subnets that are allowed to access this CosmosDB account.

    write_endpoints Sequence[str]

    A list of write endpoints available for this CosmosDB account.

    capabilities List<Property Map>

    Capabilities enabled on this Cosmos DB account.

    consistencyPolicies List<Property Map>
    enableAutomaticFailover Boolean

    If automatic failover is enabled for this CosmosDB Account.

    enableFreeTier Boolean

    If Free Tier pricing option is enabled for this CosmosDB Account. You can have up to one free tier Azure Cosmos DB account per Azure subscription.

    enableMultipleWriteLocations Boolean

    If multiple write locations are enabled for this Cosmos DB account.

    endpoint String

    The endpoint used to connect to the CosmosDB account.

    geoLocations List<Property Map>
    id String

    The provider-assigned unique ID for this managed resource.

    ipRangeFilter String

    The current IP Filter for this CosmosDB account

    isVirtualNetworkFilterEnabled Boolean

    If virtual network filtering is enabled for this Cosmos DB account.

    keyVaultKeyId String

    The Key Vault key URI for CMK encryption.

    kind String

    The Kind of the CosmosDB account.

    location String

    The name of the Azure region hosting replicated data.

    name String
    offerType String

    The Offer Type to used by this CosmosDB Account.

    primaryKey String

    The primary key for the CosmosDB account.

    primaryReadonlyKey String

    The primary read-only Key for the CosmosDB account.

    readEndpoints List<String>

    A list of read endpoints available for this CosmosDB account.

    resourceGroupName String
    secondaryKey String

    The secondary key for the CosmosDB account.

    secondaryReadonlyKey String

    The secondary read-only key for the CosmosDB account.

    tags Map<String>

    A mapping of tags assigned to the resource.

    virtualNetworkRules List<Property Map>

    Subnets that are allowed to access this CosmosDB account.

    writeEndpoints List<String>

    A list of write endpoints available for this CosmosDB account.

    Supporting Types

    GetAccountCapability

    Name string

    Specifies the name of the CosmosDB Account.

    Name string

    Specifies the name of the CosmosDB Account.

    name String

    Specifies the name of the CosmosDB Account.

    name string

    Specifies the name of the CosmosDB Account.

    name str

    Specifies the name of the CosmosDB Account.

    name String

    Specifies the name of the CosmosDB Account.

    GetAccountConsistencyPolicy

    ConsistencyLevel string

    The Consistency Level used by this CosmosDB Account.

    MaxIntervalInSeconds int

    The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

    MaxStalenessPrefix int

    The number of stale requests tolerated when the consistency level is Bounded Staleness.

    ConsistencyLevel string

    The Consistency Level used by this CosmosDB Account.

    MaxIntervalInSeconds int

    The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

    MaxStalenessPrefix int

    The number of stale requests tolerated when the consistency level is Bounded Staleness.

    consistencyLevel String

    The Consistency Level used by this CosmosDB Account.

    maxIntervalInSeconds Integer

    The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

    maxStalenessPrefix Integer

    The number of stale requests tolerated when the consistency level is Bounded Staleness.

    consistencyLevel string

    The Consistency Level used by this CosmosDB Account.

    maxIntervalInSeconds number

    The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

    maxStalenessPrefix number

    The number of stale requests tolerated when the consistency level is Bounded Staleness.

    consistency_level str

    The Consistency Level used by this CosmosDB Account.

    max_interval_in_seconds int

    The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

    max_staleness_prefix int

    The number of stale requests tolerated when the consistency level is Bounded Staleness.

    consistencyLevel String

    The Consistency Level used by this CosmosDB Account.

    maxIntervalInSeconds Number

    The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

    maxStalenessPrefix Number

    The number of stale requests tolerated when the consistency level is Bounded Staleness.

    GetAccountGeoLocation

    FailoverPriority int
    Id string

    The ID of the virtual network subnet.

    Location string

    The name of the Azure region hosting replicated data.

    FailoverPriority int
    Id string

    The ID of the virtual network subnet.

    Location string

    The name of the Azure region hosting replicated data.

    failoverPriority Integer
    id String

    The ID of the virtual network subnet.

    location String

    The name of the Azure region hosting replicated data.

    failoverPriority number
    id string

    The ID of the virtual network subnet.

    location string

    The name of the Azure region hosting replicated data.

    failover_priority int
    id str

    The ID of the virtual network subnet.

    location str

    The name of the Azure region hosting replicated data.

    failoverPriority Number
    id String

    The ID of the virtual network subnet.

    location String

    The name of the Azure region hosting replicated data.

    GetAccountVirtualNetworkRule

    Id string

    The ID of the virtual network subnet.

    Id string

    The ID of the virtual network subnet.

    id String

    The ID of the virtual network subnet.

    id string

    The ID of the virtual network subnet.

    id str

    The ID of the virtual network subnet.

    id String

    The ID of the virtual network subnet.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi