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

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.cosmosdb.getAccount

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

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

    Example Usage

    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);
    
    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)
    
    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
    	})
    }
    
    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 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()));
        }
    }
    
    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:

    AutomaticFailoverEnabled bool
    If automatic failover is enabled for this CosmosDB Account.
    Capabilities List<GetAccountCapability>
    Capabilities enabled on this Cosmos DB account.
    ConnectionStrings List<string>

    Deprecated: This property has been superseded by the primary and secondary connection strings for sql, mongodb and readonly and will be removed in v4.0 of the AzureRM provider

    ConsistencyPolicies List<GetAccountConsistencyPolicy>
    EnableAutomaticFailover bool

    Deprecated: This property has been renamed to automatic_failover_enabled and will be removed in v4.0 of the AzureRM provider

    EnableFreeTier bool

    Deprecated: This property has been renamed to free_tier_enabled and will be removed in v4.0 of the AzureRM provider

    EnableMultipleWriteLocations bool

    Deprecated: This property has been renamed to multiple_write_locations_enabled and will be removed in v4.0 of the AzureRM provider

    Endpoint string
    The endpoint used to connect to the CosmosDB account.
    FreeTierEnabled 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.
    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.
    MultipleWriteLocationsEnabled bool
    If multiple write locations are enabled for this Cosmos DB account.
    Name string
    OfferType string
    The Offer Type to used by this CosmosDB Account.
    PrimaryKey string
    The primary key for the CosmosDB account.
    PrimaryMongodbConnectionString string
    The primary Mongodb connection string for the CosmosDB account.
    PrimaryReadonlyKey string
    The primary read-only Key for the CosmosDB account.
    PrimaryReadonlyMongodbConnectionString string
    The primary readonly Mongodb connection string for the CosmosDB account.
    PrimaryReadonlySqlConnectionString string
    The primary read-only SQL connection string for the CosmosDB account.
    PrimarySqlConnectionString string
    The primary SQL connection string 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.
    SecondaryMongodbConnectionString string
    The secondary Mongodb connection string for the CosmosDB account.
    SecondaryReadonlyKey string
    The secondary read-only key for the CosmosDB account.
    SecondaryReadonlyMongodbConnectionString string
    The secondary readonly Mongodb connection string for the CosmosDB account.
    SecondaryReadonlySqlConnectionString string
    The secondary read-only SQL connection string for the CosmosDB account.
    SecondarySqlConnectionString string
    The secondary SQL connection string 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.
    AutomaticFailoverEnabled bool
    If automatic failover is enabled for this CosmosDB Account.
    Capabilities []GetAccountCapability
    Capabilities enabled on this Cosmos DB account.
    ConnectionStrings []string

    Deprecated: This property has been superseded by the primary and secondary connection strings for sql, mongodb and readonly and will be removed in v4.0 of the AzureRM provider

    ConsistencyPolicies []GetAccountConsistencyPolicy
    EnableAutomaticFailover bool

    Deprecated: This property has been renamed to automatic_failover_enabled and will be removed in v4.0 of the AzureRM provider

    EnableFreeTier bool

    Deprecated: This property has been renamed to free_tier_enabled and will be removed in v4.0 of the AzureRM provider

    EnableMultipleWriteLocations bool

    Deprecated: This property has been renamed to multiple_write_locations_enabled and will be removed in v4.0 of the AzureRM provider

    Endpoint string
    The endpoint used to connect to the CosmosDB account.
    FreeTierEnabled 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.
    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.
    MultipleWriteLocationsEnabled bool
    If multiple write locations are enabled for this Cosmos DB account.
    Name string
    OfferType string
    The Offer Type to used by this CosmosDB Account.
    PrimaryKey string
    The primary key for the CosmosDB account.
    PrimaryMongodbConnectionString string
    The primary Mongodb connection string for the CosmosDB account.
    PrimaryReadonlyKey string
    The primary read-only Key for the CosmosDB account.
    PrimaryReadonlyMongodbConnectionString string
    The primary readonly Mongodb connection string for the CosmosDB account.
    PrimaryReadonlySqlConnectionString string
    The primary read-only SQL connection string for the CosmosDB account.
    PrimarySqlConnectionString string
    The primary SQL connection string 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.
    SecondaryMongodbConnectionString string
    The secondary Mongodb connection string for the CosmosDB account.
    SecondaryReadonlyKey string
    The secondary read-only key for the CosmosDB account.
    SecondaryReadonlyMongodbConnectionString string
    The secondary readonly Mongodb connection string for the CosmosDB account.
    SecondaryReadonlySqlConnectionString string
    The secondary read-only SQL connection string for the CosmosDB account.
    SecondarySqlConnectionString string
    The secondary SQL connection string 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.
    automaticFailoverEnabled Boolean
    If automatic failover is enabled for this CosmosDB Account.
    capabilities List<GetAccountCapability>
    Capabilities enabled on this Cosmos DB account.
    connectionStrings List<String>

    Deprecated: This property has been superseded by the primary and secondary connection strings for sql, mongodb and readonly and will be removed in v4.0 of the AzureRM provider

    consistencyPolicies List<GetAccountConsistencyPolicy>
    enableAutomaticFailover Boolean

    Deprecated: This property has been renamed to automatic_failover_enabled and will be removed in v4.0 of the AzureRM provider

    enableFreeTier Boolean

    Deprecated: This property has been renamed to free_tier_enabled and will be removed in v4.0 of the AzureRM provider

    enableMultipleWriteLocations Boolean

    Deprecated: This property has been renamed to multiple_write_locations_enabled and will be removed in v4.0 of the AzureRM provider

    endpoint String
    The endpoint used to connect to the CosmosDB account.
    freeTierEnabled 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.
    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.
    multipleWriteLocationsEnabled Boolean
    If multiple write locations are enabled for this Cosmos DB account.
    name String
    offerType String
    The Offer Type to used by this CosmosDB Account.
    primaryKey String
    The primary key for the CosmosDB account.
    primaryMongodbConnectionString String
    The primary Mongodb connection string for the CosmosDB account.
    primaryReadonlyKey String
    The primary read-only Key for the CosmosDB account.
    primaryReadonlyMongodbConnectionString String
    The primary readonly Mongodb connection string for the CosmosDB account.
    primaryReadonlySqlConnectionString String
    The primary read-only SQL connection string for the CosmosDB account.
    primarySqlConnectionString String
    The primary SQL connection string 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.
    secondaryMongodbConnectionString String
    The secondary Mongodb connection string for the CosmosDB account.
    secondaryReadonlyKey String
    The secondary read-only key for the CosmosDB account.
    secondaryReadonlyMongodbConnectionString String
    The secondary readonly Mongodb connection string for the CosmosDB account.
    secondaryReadonlySqlConnectionString String
    The secondary read-only SQL connection string for the CosmosDB account.
    secondarySqlConnectionString String
    The secondary SQL connection string 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.
    automaticFailoverEnabled boolean
    If automatic failover is enabled for this CosmosDB Account.
    capabilities GetAccountCapability[]
    Capabilities enabled on this Cosmos DB account.
    connectionStrings string[]

    Deprecated: This property has been superseded by the primary and secondary connection strings for sql, mongodb and readonly and will be removed in v4.0 of the AzureRM provider

    consistencyPolicies GetAccountConsistencyPolicy[]
    enableAutomaticFailover boolean

    Deprecated: This property has been renamed to automatic_failover_enabled and will be removed in v4.0 of the AzureRM provider

    enableFreeTier boolean

    Deprecated: This property has been renamed to free_tier_enabled and will be removed in v4.0 of the AzureRM provider

    enableMultipleWriteLocations boolean

    Deprecated: This property has been renamed to multiple_write_locations_enabled and will be removed in v4.0 of the AzureRM provider

    endpoint string
    The endpoint used to connect to the CosmosDB account.
    freeTierEnabled 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.
    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.
    multipleWriteLocationsEnabled boolean
    If multiple write locations are enabled for this Cosmos DB account.
    name string
    offerType string
    The Offer Type to used by this CosmosDB Account.
    primaryKey string
    The primary key for the CosmosDB account.
    primaryMongodbConnectionString string
    The primary Mongodb connection string for the CosmosDB account.
    primaryReadonlyKey string
    The primary read-only Key for the CosmosDB account.
    primaryReadonlyMongodbConnectionString string
    The primary readonly Mongodb connection string for the CosmosDB account.
    primaryReadonlySqlConnectionString string
    The primary read-only SQL connection string for the CosmosDB account.
    primarySqlConnectionString string
    The primary SQL connection string 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.
    secondaryMongodbConnectionString string
    The secondary Mongodb connection string for the CosmosDB account.
    secondaryReadonlyKey string
    The secondary read-only key for the CosmosDB account.
    secondaryReadonlyMongodbConnectionString string
    The secondary readonly Mongodb connection string for the CosmosDB account.
    secondaryReadonlySqlConnectionString string
    The secondary read-only SQL connection string for the CosmosDB account.
    secondarySqlConnectionString string
    The secondary SQL connection string 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.
    automatic_failover_enabled bool
    If automatic failover is enabled for this CosmosDB Account.
    capabilities Sequence[GetAccountCapability]
    Capabilities enabled on this Cosmos DB account.
    connection_strings Sequence[str]

    Deprecated: This property has been superseded by the primary and secondary connection strings for sql, mongodb and readonly and will be removed in v4.0 of the AzureRM provider

    consistency_policies Sequence[GetAccountConsistencyPolicy]
    enable_automatic_failover bool

    Deprecated: This property has been renamed to automatic_failover_enabled and will be removed in v4.0 of the AzureRM provider

    enable_free_tier bool

    Deprecated: This property has been renamed to free_tier_enabled and will be removed in v4.0 of the AzureRM provider

    enable_multiple_write_locations bool

    Deprecated: This property has been renamed to multiple_write_locations_enabled and will be removed in v4.0 of the AzureRM provider

    endpoint str
    The endpoint used to connect to the CosmosDB account.
    free_tier_enabled 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.
    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.
    multiple_write_locations_enabled bool
    If multiple write locations are enabled for this Cosmos DB account.
    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_mongodb_connection_string str
    The primary Mongodb connection string for the CosmosDB account.
    primary_readonly_key str
    The primary read-only Key for the CosmosDB account.
    primary_readonly_mongodb_connection_string str
    The primary readonly Mongodb connection string for the CosmosDB account.
    primary_readonly_sql_connection_string str
    The primary read-only SQL connection string for the CosmosDB account.
    primary_sql_connection_string str
    The primary SQL connection string 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_mongodb_connection_string str
    The secondary Mongodb connection string for the CosmosDB account.
    secondary_readonly_key str
    The secondary read-only key for the CosmosDB account.
    secondary_readonly_mongodb_connection_string str
    The secondary readonly Mongodb connection string for the CosmosDB account.
    secondary_readonly_sql_connection_string str
    The secondary read-only SQL connection string for the CosmosDB account.
    secondary_sql_connection_string str
    The secondary SQL connection string 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.
    automaticFailoverEnabled Boolean
    If automatic failover is enabled for this CosmosDB Account.
    capabilities List<Property Map>
    Capabilities enabled on this Cosmos DB account.
    connectionStrings List<String>

    Deprecated: This property has been superseded by the primary and secondary connection strings for sql, mongodb and readonly and will be removed in v4.0 of the AzureRM provider

    consistencyPolicies List<Property Map>
    enableAutomaticFailover Boolean

    Deprecated: This property has been renamed to automatic_failover_enabled and will be removed in v4.0 of the AzureRM provider

    enableFreeTier Boolean

    Deprecated: This property has been renamed to free_tier_enabled and will be removed in v4.0 of the AzureRM provider

    enableMultipleWriteLocations Boolean

    Deprecated: This property has been renamed to multiple_write_locations_enabled and will be removed in v4.0 of the AzureRM provider

    endpoint String
    The endpoint used to connect to the CosmosDB account.
    freeTierEnabled 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.
    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.
    multipleWriteLocationsEnabled Boolean
    If multiple write locations are enabled for this Cosmos DB account.
    name String
    offerType String
    The Offer Type to used by this CosmosDB Account.
    primaryKey String
    The primary key for the CosmosDB account.
    primaryMongodbConnectionString String
    The primary Mongodb connection string for the CosmosDB account.
    primaryReadonlyKey String
    The primary read-only Key for the CosmosDB account.
    primaryReadonlyMongodbConnectionString String
    The primary readonly Mongodb connection string for the CosmosDB account.
    primaryReadonlySqlConnectionString String
    The primary read-only SQL connection string for the CosmosDB account.
    primarySqlConnectionString String
    The primary SQL connection string 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.
    secondaryMongodbConnectionString String
    The secondary Mongodb connection string for the CosmosDB account.
    secondaryReadonlyKey String
    The secondary read-only key for the CosmosDB account.
    secondaryReadonlyMongodbConnectionString String
    The secondary readonly Mongodb connection string for the CosmosDB account.
    secondaryReadonlySqlConnectionString String
    The secondary read-only SQL connection string for the CosmosDB account.
    secondarySqlConnectionString String
    The secondary SQL connection string 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.80.0 published on Monday, Jun 10, 2024 by Pulumi