Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. cosmosdb
  6. Account

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.cosmosdb.Account

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a CosmosDB (formally DocumentDB) Account.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;
using Random = Pulumi.Random;

class MyStack : Stack
{
    public MyStack()
    {
        var rg = new Azure.Core.ResourceGroup("rg", new Azure.Core.ResourceGroupArgs
        {
            Location = "westus",
        });
        var ri = new Random.RandomInteger("ri", new Random.RandomIntegerArgs
        {
            Min = 10000,
            Max = 99999,
        });
        var db = new Azure.CosmosDB.Account("db", new Azure.CosmosDB.AccountArgs
        {
            Location = rg.Location,
            ResourceGroupName = rg.Name,
            OfferType = "Standard",
            Kind = "MongoDB",
            EnableAutomaticFailover = true,
            Capabilities = 
            {
                new Azure.CosmosDB.Inputs.AccountCapabilityArgs
                {
                    Name = "EnableAggregationPipeline",
                },
                new Azure.CosmosDB.Inputs.AccountCapabilityArgs
                {
                    Name = "mongoEnableDocLevelTTL",
                },
                new Azure.CosmosDB.Inputs.AccountCapabilityArgs
                {
                    Name = "MongoDBv3.4",
                },
                new Azure.CosmosDB.Inputs.AccountCapabilityArgs
                {
                    Name = "EnableMongo",
                },
            },
            ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
            {
                ConsistencyLevel = "BoundedStaleness",
                MaxIntervalInSeconds = 300,
                MaxStalenessPrefix = 100000,
            },
            GeoLocations = 
            {
                new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
                {
                    Location = @var.Failover_location,
                    FailoverPriority = 1,
                },
                new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
                {
                    Location = rg.Location,
                    FailoverPriority = 0,
                },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		rg, err := core.NewResourceGroup(ctx, "rg", &core.ResourceGroupArgs{
			Location: pulumi.String("westus"),
		})
		if err != nil {
			return err
		}
		_, err = random.NewRandomInteger(ctx, "ri", &random.RandomIntegerArgs{
			Min: pulumi.Int(10000),
			Max: pulumi.Int(99999),
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewAccount(ctx, "db", &cosmosdb.AccountArgs{
			Location:                rg.Location,
			ResourceGroupName:       rg.Name,
			OfferType:               pulumi.String("Standard"),
			Kind:                    pulumi.String("MongoDB"),
			EnableAutomaticFailover: pulumi.Bool(true),
			Capabilities: cosmosdb.AccountCapabilityArray{
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("EnableAggregationPipeline"),
				},
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("mongoEnableDocLevelTTL"),
				},
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("MongoDBv3.4"),
				},
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("EnableMongo"),
				},
			},
			ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
				ConsistencyLevel:     pulumi.String("BoundedStaleness"),
				MaxIntervalInSeconds: pulumi.Int(300),
				MaxStalenessPrefix:   pulumi.Int(100000),
			},
			GeoLocations: cosmosdb.AccountGeoLocationArray{
				&cosmosdb.AccountGeoLocationArgs{
					Location:         pulumi.Any(_var.Failover_location),
					FailoverPriority: pulumi.Int(1),
				},
				&cosmosdb.AccountGeoLocationArgs{
					Location:         rg.Location,
					FailoverPriority: pulumi.Int(0),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as random from "@pulumi/random";

const rg = new azure.core.ResourceGroup("rg", {location: "westus"});
const ri = new random.RandomInteger("ri", {
    min: 10000,
    max: 99999,
});
const db = new azure.cosmosdb.Account("db", {
    location: rg.location,
    resourceGroupName: rg.name,
    offerType: "Standard",
    kind: "MongoDB",
    enableAutomaticFailover: true,
    capabilities: [
        {
            name: "EnableAggregationPipeline",
        },
        {
            name: "mongoEnableDocLevelTTL",
        },
        {
            name: "MongoDBv3.4",
        },
        {
            name: "EnableMongo",
        },
    ],
    consistencyPolicy: {
        consistencyLevel: "BoundedStaleness",
        maxIntervalInSeconds: 300,
        maxStalenessPrefix: 100000,
    },
    geoLocations: [
        {
            location: _var.failover_location,
            failoverPriority: 1,
        },
        {
            location: rg.location,
            failoverPriority: 0,
        },
    ],
});

    import pulumi
import pulumi_azure as azure
import pulumi_random as random

rg = azure.core.ResourceGroup("rg", location="westus")
ri = random.RandomInteger("ri",
    min=10000,
    max=99999)
db = azure.cosmosdb.Account("db",
    location=rg.location,
    resource_group_name=rg.name,
    offer_type="Standard",
    kind="MongoDB",
    enable_automatic_failover=True,
    capabilities=[
        azure.cosmosdb.AccountCapabilityArgs(
            name="EnableAggregationPipeline",
        ),
        azure.cosmosdb.AccountCapabilityArgs(
            name="mongoEnableDocLevelTTL",
        ),
        azure.cosmosdb.AccountCapabilityArgs(
            name="MongoDBv3.4",
        ),
        azure.cosmosdb.AccountCapabilityArgs(
            name="EnableMongo",
        ),
    ],
    consistency_policy=azure.cosmosdb.AccountConsistencyPolicyArgs(
        consistency_level="BoundedStaleness",
        max_interval_in_seconds=300,
        max_staleness_prefix=100000,
    ),
    geo_locations=[
        azure.cosmosdb.AccountGeoLocationArgs(
            location=var["failover_location"],
            failover_priority=1,
        ),
        azure.cosmosdb.AccountGeoLocationArgs(
            location=rg.location,
            failover_priority=0,
        ),
    ])

    Example coming soon!

    Create Account Resource

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

    Constructor syntax

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

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            consistency_policy: Optional[AccountConsistencyPolicyArgs] = None,
            resource_group_name: Optional[str] = None,
            offer_type: Optional[str] = None,
            geo_locations: Optional[Sequence[AccountGeoLocationArgs]] = None,
            identity: Optional[AccountIdentityArgs] = None,
            key_vault_key_id: Optional[str] = None,
            capabilities: Optional[Sequence[AccountCapabilityArgs]] = None,
            cors_rule: Optional[AccountCorsRuleArgs] = None,
            create_mode: Optional[str] = None,
            default_identity_type: Optional[str] = None,
            enable_automatic_failover: Optional[bool] = None,
            enable_free_tier: Optional[bool] = None,
            enable_multiple_write_locations: Optional[bool] = None,
            backup: Optional[AccountBackupArgs] = None,
            access_key_metadata_writes_enabled: Optional[bool] = None,
            ip_range_filter: Optional[str] = None,
            is_virtual_network_filter_enabled: Optional[bool] = None,
            capacity: Optional[AccountCapacityArgs] = None,
            kind: Optional[str] = None,
            local_authentication_disabled: Optional[bool] = None,
            location: Optional[str] = None,
            mongo_server_version: Optional[str] = None,
            name: Optional[str] = None,
            network_acl_bypass_for_azure_services: Optional[bool] = None,
            network_acl_bypass_ids: Optional[Sequence[str]] = None,
            analytical_storage_enabled: Optional[bool] = None,
            public_network_access_enabled: Optional[bool] = None,
            analytical_storage: Optional[AccountAnalyticalStorageArgs] = None,
            restore: Optional[AccountRestoreArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            virtual_network_rules: Optional[Sequence[AccountVirtualNetworkRuleArgs]] = None)
    func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
    public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
    public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)

    type: azure:cosmosdb:Account
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 AccountArgs
    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 AccountArgs
    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 AccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountArgs
    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 exampleaccountResourceResourceFromCosmosdbaccount = new Azure.CosmosDB.Account("exampleaccountResourceResourceFromCosmosdbaccount", new()
{
    ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
    {
        ConsistencyLevel = "string",
        MaxIntervalInSeconds = 0,
        MaxStalenessPrefix = 0,
    },
    ResourceGroupName = "string",
    OfferType = "string",
    GeoLocations = new[]
    {
        new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
        {
            FailoverPriority = 0,
            Location = "string",
            Id = "string",
            ZoneRedundant = false,
        },
    },
    Identity = new Azure.CosmosDB.Inputs.AccountIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    KeyVaultKeyId = "string",
    Capabilities = new[]
    {
        new Azure.CosmosDB.Inputs.AccountCapabilityArgs
        {
            Name = "string",
        },
    },
    CorsRule = new Azure.CosmosDB.Inputs.AccountCorsRuleArgs
    {
        AllowedHeaders = new[]
        {
            "string",
        },
        AllowedMethods = new[]
        {
            "string",
        },
        AllowedOrigins = new[]
        {
            "string",
        },
        ExposedHeaders = new[]
        {
            "string",
        },
        MaxAgeInSeconds = 0,
    },
    CreateMode = "string",
    DefaultIdentityType = "string",
    EnableAutomaticFailover = false,
    EnableFreeTier = false,
    EnableMultipleWriteLocations = false,
    Backup = new Azure.CosmosDB.Inputs.AccountBackupArgs
    {
        Type = "string",
        IntervalInMinutes = 0,
        RetentionInHours = 0,
        StorageRedundancy = "string",
    },
    AccessKeyMetadataWritesEnabled = false,
    IpRangeFilter = "string",
    IsVirtualNetworkFilterEnabled = false,
    Capacity = new Azure.CosmosDB.Inputs.AccountCapacityArgs
    {
        TotalThroughputLimit = 0,
    },
    Kind = "string",
    LocalAuthenticationDisabled = false,
    Location = "string",
    MongoServerVersion = "string",
    Name = "string",
    NetworkAclBypassForAzureServices = false,
    NetworkAclBypassIds = new[]
    {
        "string",
    },
    AnalyticalStorageEnabled = false,
    PublicNetworkAccessEnabled = false,
    AnalyticalStorage = new Azure.CosmosDB.Inputs.AccountAnalyticalStorageArgs
    {
        SchemaType = "string",
    },
    Restore = new Azure.CosmosDB.Inputs.AccountRestoreArgs
    {
        RestoreTimestampInUtc = "string",
        SourceCosmosdbAccountId = "string",
        Databases = new[]
        {
            new Azure.CosmosDB.Inputs.AccountRestoreDatabaseArgs
            {
                Name = "string",
                CollectionNames = new[]
                {
                    "string",
                },
            },
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    VirtualNetworkRules = new[]
    {
        new Azure.CosmosDB.Inputs.AccountVirtualNetworkRuleArgs
        {
            Id = "string",
            IgnoreMissingVnetServiceEndpoint = false,
        },
    },
});

    example, err := cosmosdb.NewAccount(ctx, "exampleaccountResourceResourceFromCosmosdbaccount", &cosmosdb.AccountArgs{
	ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
		ConsistencyLevel:     pulumi.String("string"),
		MaxIntervalInSeconds: pulumi.Int(0),
		MaxStalenessPrefix:   pulumi.Int(0),
	},
	ResourceGroupName: pulumi.String("string"),
	OfferType:         pulumi.String("string"),
	GeoLocations: cosmosdb.AccountGeoLocationArray{
		&cosmosdb.AccountGeoLocationArgs{
			FailoverPriority: pulumi.Int(0),
			Location:         pulumi.String("string"),
			Id:               pulumi.String("string"),
			ZoneRedundant:    pulumi.Bool(false),
		},
	},
	Identity: &cosmosdb.AccountIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	KeyVaultKeyId: pulumi.String("string"),
	Capabilities: cosmosdb.AccountCapabilityArray{
		&cosmosdb.AccountCapabilityArgs{
			Name: pulumi.String("string"),
		},
	},
	CorsRule: &cosmosdb.AccountCorsRuleArgs{
		AllowedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedMethods: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOrigins: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExposedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxAgeInSeconds: pulumi.Int(0),
	},
	CreateMode:                   pulumi.String("string"),
	DefaultIdentityType:          pulumi.String("string"),
	EnableAutomaticFailover:      pulumi.Bool(false),
	EnableFreeTier:               pulumi.Bool(false),
	EnableMultipleWriteLocations: pulumi.Bool(false),
	Backup: &cosmosdb.AccountBackupArgs{
		Type:              pulumi.String("string"),
		IntervalInMinutes: pulumi.Int(0),
		RetentionInHours:  pulumi.Int(0),
		StorageRedundancy: pulumi.String("string"),
	},
	AccessKeyMetadataWritesEnabled: pulumi.Bool(false),
	IpRangeFilter:                  pulumi.String("string"),
	IsVirtualNetworkFilterEnabled:  pulumi.Bool(false),
	Capacity: &cosmosdb.AccountCapacityArgs{
		TotalThroughputLimit: pulumi.Int(0),
	},
	Kind:                             pulumi.String("string"),
	LocalAuthenticationDisabled:      pulumi.Bool(false),
	Location:                         pulumi.String("string"),
	MongoServerVersion:               pulumi.String("string"),
	Name:                             pulumi.String("string"),
	NetworkAclBypassForAzureServices: pulumi.Bool(false),
	NetworkAclBypassIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	AnalyticalStorageEnabled:   pulumi.Bool(false),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	AnalyticalStorage: &cosmosdb.AccountAnalyticalStorageArgs{
		SchemaType: pulumi.String("string"),
	},
	Restore: &cosmosdb.AccountRestoreArgs{
		RestoreTimestampInUtc:   pulumi.String("string"),
		SourceCosmosdbAccountId: pulumi.String("string"),
		Databases: cosmosdb.AccountRestoreDatabaseArray{
			&cosmosdb.AccountRestoreDatabaseArgs{
				Name: pulumi.String("string"),
				CollectionNames: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VirtualNetworkRules: cosmosdb.AccountVirtualNetworkRuleArray{
		&cosmosdb.AccountVirtualNetworkRuleArgs{
			Id:                               pulumi.String("string"),
			IgnoreMissingVnetServiceEndpoint: pulumi.Bool(false),
		},
	},
})

    var exampleaccountResourceResourceFromCosmosdbaccount = new com.pulumi.azure.cosmosdb.Account("exampleaccountResourceResourceFromCosmosdbaccount", com.pulumi.azure.cosmosdb.AccountArgs.builder()
    .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
        .consistencyLevel("string")
        .maxIntervalInSeconds(0)
        .maxStalenessPrefix(0)
        .build())
    .resourceGroupName("string")
    .offerType("string")
    .geoLocations(AccountGeoLocationArgs.builder()
        .failoverPriority(0)
        .location("string")
        .id("string")
        .zoneRedundant(false)
        .build())
    .identity(AccountIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .keyVaultKeyId("string")
    .capabilities(AccountCapabilityArgs.builder()
        .name("string")
        .build())
    .corsRule(AccountCorsRuleArgs.builder()
        .allowedHeaders("string")
        .allowedMethods("string")
        .allowedOrigins("string")
        .exposedHeaders("string")
        .maxAgeInSeconds(0)
        .build())
    .createMode("string")
    .defaultIdentityType("string")
    .enableAutomaticFailover(false)
    .enableFreeTier(false)
    .enableMultipleWriteLocations(false)
    .backup(AccountBackupArgs.builder()
        .type("string")
        .intervalInMinutes(0)
        .retentionInHours(0)
        .storageRedundancy("string")
        .build())
    .accessKeyMetadataWritesEnabled(false)
    .ipRangeFilter("string")
    .isVirtualNetworkFilterEnabled(false)
    .capacity(AccountCapacityArgs.builder()
        .totalThroughputLimit(0)
        .build())
    .kind("string")
    .localAuthenticationDisabled(false)
    .location("string")
    .mongoServerVersion("string")
    .name("string")
    .networkAclBypassForAzureServices(false)
    .networkAclBypassIds("string")
    .analyticalStorageEnabled(false)
    .publicNetworkAccessEnabled(false)
    .analyticalStorage(AccountAnalyticalStorageArgs.builder()
        .schemaType("string")
        .build())
    .restore(AccountRestoreArgs.builder()
        .restoreTimestampInUtc("string")
        .sourceCosmosdbAccountId("string")
        .databases(AccountRestoreDatabaseArgs.builder()
            .name("string")
            .collectionNames("string")
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .virtualNetworkRules(AccountVirtualNetworkRuleArgs.builder()
        .id("string")
        .ignoreMissingVnetServiceEndpoint(false)
        .build())
    .build());

    exampleaccount_resource_resource_from_cosmosdbaccount = azure.cosmosdb.Account("exampleaccountResourceResourceFromCosmosdbaccount",
    consistency_policy={
        "consistency_level": "string",
        "max_interval_in_seconds": 0,
        "max_staleness_prefix": 0,
    },
    resource_group_name="string",
    offer_type="string",
    geo_locations=[{
        "failover_priority": 0,
        "location": "string",
        "id": "string",
        "zone_redundant": False,
    }],
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    key_vault_key_id="string",
    capabilities=[{
        "name": "string",
    }],
    cors_rule={
        "allowed_headers": ["string"],
        "allowed_methods": ["string"],
        "allowed_origins": ["string"],
        "exposed_headers": ["string"],
        "max_age_in_seconds": 0,
    },
    create_mode="string",
    default_identity_type="string",
    enable_automatic_failover=False,
    enable_free_tier=False,
    enable_multiple_write_locations=False,
    backup={
        "type": "string",
        "interval_in_minutes": 0,
        "retention_in_hours": 0,
        "storage_redundancy": "string",
    },
    access_key_metadata_writes_enabled=False,
    ip_range_filter="string",
    is_virtual_network_filter_enabled=False,
    capacity={
        "total_throughput_limit": 0,
    },
    kind="string",
    local_authentication_disabled=False,
    location="string",
    mongo_server_version="string",
    name="string",
    network_acl_bypass_for_azure_services=False,
    network_acl_bypass_ids=["string"],
    analytical_storage_enabled=False,
    public_network_access_enabled=False,
    analytical_storage={
        "schema_type": "string",
    },
    restore={
        "restore_timestamp_in_utc": "string",
        "source_cosmosdb_account_id": "string",
        "databases": [{
            "name": "string",
            "collection_names": ["string"],
        }],
    },
    tags={
        "string": "string",
    },
    virtual_network_rules=[{
        "id": "string",
        "ignore_missing_vnet_service_endpoint": False,
    }])

    const exampleaccountResourceResourceFromCosmosdbaccount = new azure.cosmosdb.Account("exampleaccountResourceResourceFromCosmosdbaccount", {
    consistencyPolicy: {
        consistencyLevel: "string",
        maxIntervalInSeconds: 0,
        maxStalenessPrefix: 0,
    },
    resourceGroupName: "string",
    offerType: "string",
    geoLocations: [{
        failoverPriority: 0,
        location: "string",
        id: "string",
        zoneRedundant: false,
    }],
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    keyVaultKeyId: "string",
    capabilities: [{
        name: "string",
    }],
    corsRule: {
        allowedHeaders: ["string"],
        allowedMethods: ["string"],
        allowedOrigins: ["string"],
        exposedHeaders: ["string"],
        maxAgeInSeconds: 0,
    },
    createMode: "string",
    defaultIdentityType: "string",
    enableAutomaticFailover: false,
    enableFreeTier: false,
    enableMultipleWriteLocations: false,
    backup: {
        type: "string",
        intervalInMinutes: 0,
        retentionInHours: 0,
        storageRedundancy: "string",
    },
    accessKeyMetadataWritesEnabled: false,
    ipRangeFilter: "string",
    isVirtualNetworkFilterEnabled: false,
    capacity: {
        totalThroughputLimit: 0,
    },
    kind: "string",
    localAuthenticationDisabled: false,
    location: "string",
    mongoServerVersion: "string",
    name: "string",
    networkAclBypassForAzureServices: false,
    networkAclBypassIds: ["string"],
    analyticalStorageEnabled: false,
    publicNetworkAccessEnabled: false,
    analyticalStorage: {
        schemaType: "string",
    },
    restore: {
        restoreTimestampInUtc: "string",
        sourceCosmosdbAccountId: "string",
        databases: [{
            name: "string",
            collectionNames: ["string"],
        }],
    },
    tags: {
        string: "string",
    },
    virtualNetworkRules: [{
        id: "string",
        ignoreMissingVnetServiceEndpoint: false,
    }],
});

    type: azure:cosmosdb:Account
properties:
    accessKeyMetadataWritesEnabled: false
    analyticalStorage:
        schemaType: string
    analyticalStorageEnabled: false
    backup:
        intervalInMinutes: 0
        retentionInHours: 0
        storageRedundancy: string
        type: string
    capabilities:
        - name: string
    capacity:
        totalThroughputLimit: 0
    consistencyPolicy:
        consistencyLevel: string
        maxIntervalInSeconds: 0
        maxStalenessPrefix: 0
    corsRule:
        allowedHeaders:
            - string
        allowedMethods:
            - string
        allowedOrigins:
            - string
        exposedHeaders:
            - string
        maxAgeInSeconds: 0
    createMode: string
    defaultIdentityType: string
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    geoLocations:
        - failoverPriority: 0
          id: string
          location: string
          zoneRedundant: false
    identity:
        principalId: string
        tenantId: string
        type: string
    ipRangeFilter: string
    isVirtualNetworkFilterEnabled: false
    keyVaultKeyId: string
    kind: string
    localAuthenticationDisabled: false
    location: string
    mongoServerVersion: string
    name: string
    networkAclBypassForAzureServices: false
    networkAclBypassIds:
        - string
    offerType: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    restore:
        databases:
            - collectionNames:
                - string
              name: string
        restoreTimestampInUtc: string
        sourceCosmosdbAccountId: string
    tags:
        string: string
    virtualNetworkRules:
        - id: string
          ignoreMissingVnetServiceEndpoint: false

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

    ConsistencyPolicy AccountConsistencyPolicy
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    GeoLocations List<AccountGeoLocation>
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    OfferType string
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    ResourceGroupName string
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    AccessKeyMetadataWritesEnabled bool
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    AnalyticalStorage AccountAnalyticalStorage
    An analytical_storage block as defined below.
    AnalyticalStorageEnabled bool
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    Backup AccountBackup
    A backup block as defined below.
    Capabilities List<AccountCapability>
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    Capacity AccountCapacity
    A capacity block as defined below.
    CorsRule AccountCorsRule
    A cors_rule block as defined below.
    CreateMode string
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    DefaultIdentityType string
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    EnableAutomaticFailover bool
    Enable automatic fail over for this Cosmos DB account.
    EnableFreeTier bool
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    EnableMultipleWriteLocations bool
    Enable multiple write locations for this Cosmos DB account.
    Identity AccountIdentity
    An identity block as defined below.
    IpRangeFilter string
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    IsVirtualNetworkFilterEnabled bool
    Enables virtual network filtering for this Cosmos DB account.
    KeyVaultKeyId string
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    Kind string
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    LocalAuthenticationDisabled bool
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MongoServerVersion string
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    Name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    NetworkAclBypassForAzureServices bool
    If azure services can bypass ACLs. Defaults to false.
    NetworkAclBypassIds List<string>
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this CosmosDB account.
    Restore AccountRestore
    A restore block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VirtualNetworkRules List<AccountVirtualNetworkRule>
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    ConsistencyPolicy AccountConsistencyPolicyArgs
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    GeoLocations []AccountGeoLocationArgs
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    OfferType string
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    ResourceGroupName string
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    AccessKeyMetadataWritesEnabled bool
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    AnalyticalStorage AccountAnalyticalStorageArgs
    An analytical_storage block as defined below.
    AnalyticalStorageEnabled bool
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    Backup AccountBackupArgs
    A backup block as defined below.
    Capabilities []AccountCapabilityArgs
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    Capacity AccountCapacityArgs
    A capacity block as defined below.
    CorsRule AccountCorsRuleArgs
    A cors_rule block as defined below.
    CreateMode string
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    DefaultIdentityType string
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    EnableAutomaticFailover bool
    Enable automatic fail over for this Cosmos DB account.
    EnableFreeTier bool
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    EnableMultipleWriteLocations bool
    Enable multiple write locations for this Cosmos DB account.
    Identity AccountIdentityArgs
    An identity block as defined below.
    IpRangeFilter string
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    IsVirtualNetworkFilterEnabled bool
    Enables virtual network filtering for this Cosmos DB account.
    KeyVaultKeyId string
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    Kind string
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    LocalAuthenticationDisabled bool
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MongoServerVersion string
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    Name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    NetworkAclBypassForAzureServices bool
    If azure services can bypass ACLs. Defaults to false.
    NetworkAclBypassIds []string
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this CosmosDB account.
    Restore AccountRestoreArgs
    A restore block as defined below.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    VirtualNetworkRules []AccountVirtualNetworkRuleArgs
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    consistencyPolicy AccountConsistencyPolicy
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    geoLocations List<AccountGeoLocation>
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    offerType String
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    resourceGroupName String
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    accessKeyMetadataWritesEnabled Boolean
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analyticalStorage AccountAnalyticalStorage
    An analytical_storage block as defined below.
    analyticalStorageEnabled Boolean
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup AccountBackup
    A backup block as defined below.
    capabilities List<AccountCapability>
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity AccountCapacity
    A capacity block as defined below.
    corsRule AccountCorsRule
    A cors_rule block as defined below.
    createMode String
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    defaultIdentityType String
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enableAutomaticFailover Boolean
    Enable automatic fail over for this Cosmos DB account.
    enableFreeTier Boolean
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enableMultipleWriteLocations Boolean
    Enable multiple write locations for this Cosmos DB account.
    identity AccountIdentity
    An identity block as defined below.
    ipRangeFilter String
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    isVirtualNetworkFilterEnabled Boolean
    Enables virtual network filtering for this Cosmos DB account.
    keyVaultKeyId String
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind String
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    localAuthenticationDisabled Boolean
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongoServerVersion String
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name String
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    networkAclBypassForAzureServices Boolean
    If azure services can bypass ACLs. Defaults to false.
    networkAclBypassIds List<String>
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this CosmosDB account.
    restore AccountRestore
    A restore block as defined below.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    virtualNetworkRules List<AccountVirtualNetworkRule>
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    consistencyPolicy AccountConsistencyPolicy
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    geoLocations AccountGeoLocation[]
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    offerType string
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    resourceGroupName string
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    accessKeyMetadataWritesEnabled boolean
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analyticalStorage AccountAnalyticalStorage
    An analytical_storage block as defined below.
    analyticalStorageEnabled boolean
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup AccountBackup
    A backup block as defined below.
    capabilities AccountCapability[]
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity AccountCapacity
    A capacity block as defined below.
    corsRule AccountCorsRule
    A cors_rule block as defined below.
    createMode string
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    defaultIdentityType string
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enableAutomaticFailover boolean
    Enable automatic fail over for this Cosmos DB account.
    enableFreeTier boolean
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enableMultipleWriteLocations boolean
    Enable multiple write locations for this Cosmos DB account.
    identity AccountIdentity
    An identity block as defined below.
    ipRangeFilter string
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    isVirtualNetworkFilterEnabled boolean
    Enables virtual network filtering for this Cosmos DB account.
    keyVaultKeyId string
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind string
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    localAuthenticationDisabled boolean
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongoServerVersion string
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    networkAclBypassForAzureServices boolean
    If azure services can bypass ACLs. Defaults to false.
    networkAclBypassIds string[]
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    publicNetworkAccessEnabled boolean
    Whether or not public network access is allowed for this CosmosDB account.
    restore AccountRestore
    A restore block as defined below.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    virtualNetworkRules AccountVirtualNetworkRule[]
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    consistency_policy AccountConsistencyPolicyArgs
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    geo_locations Sequence[AccountGeoLocationArgs]
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    offer_type str
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    resource_group_name str
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    access_key_metadata_writes_enabled bool
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analytical_storage AccountAnalyticalStorageArgs
    An analytical_storage block as defined below.
    analytical_storage_enabled bool
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup AccountBackupArgs
    A backup block as defined below.
    capabilities Sequence[AccountCapabilityArgs]
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity AccountCapacityArgs
    A capacity block as defined below.
    cors_rule AccountCorsRuleArgs
    A cors_rule block as defined below.
    create_mode str
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    default_identity_type str
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enable_automatic_failover bool
    Enable automatic fail over for this Cosmos DB account.
    enable_free_tier bool
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enable_multiple_write_locations bool
    Enable multiple write locations for this Cosmos DB account.
    identity AccountIdentityArgs
    An identity block as defined below.
    ip_range_filter str
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    is_virtual_network_filter_enabled bool
    Enables virtual network filtering for this Cosmos DB account.
    key_vault_key_id str
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind str
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    local_authentication_disabled bool
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongo_server_version str
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name str
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    network_acl_bypass_for_azure_services bool
    If azure services can bypass ACLs. Defaults to false.
    network_acl_bypass_ids Sequence[str]
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    public_network_access_enabled bool
    Whether or not public network access is allowed for this CosmosDB account.
    restore AccountRestoreArgs
    A restore block as defined below.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    virtual_network_rules Sequence[AccountVirtualNetworkRuleArgs]
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    consistencyPolicy Property Map
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    geoLocations List<Property Map>
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    offerType String
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    resourceGroupName String
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    accessKeyMetadataWritesEnabled Boolean
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analyticalStorage Property Map
    An analytical_storage block as defined below.
    analyticalStorageEnabled Boolean
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup Property Map
    A backup block as defined below.
    capabilities List<Property Map>
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity Property Map
    A capacity block as defined below.
    corsRule Property Map
    A cors_rule block as defined below.
    createMode String
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    defaultIdentityType String
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enableAutomaticFailover Boolean
    Enable automatic fail over for this Cosmos DB account.
    enableFreeTier Boolean
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enableMultipleWriteLocations Boolean
    Enable multiple write locations for this Cosmos DB account.
    identity Property Map
    An identity block as defined below.
    ipRangeFilter String
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    isVirtualNetworkFilterEnabled Boolean
    Enables virtual network filtering for this Cosmos DB account.
    keyVaultKeyId String
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind String
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    localAuthenticationDisabled Boolean
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongoServerVersion String
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name String
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    networkAclBypassForAzureServices Boolean
    If azure services can bypass ACLs. Defaults to false.
    networkAclBypassIds List<String>
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this CosmosDB account.
    restore Property Map
    A restore block as defined below.
    tags Map<String>
    A mapping of tags to assign to the resource.
    virtualNetworkRules List<Property Map>
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.

    Outputs

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

    ConnectionStrings List<string>
    A list of connection strings available for this CosmosDB account.
    Endpoint string
    The endpoint used to connect to the CosmosDB account.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryKey string
    The Primary key for the CosmosDB Account.
    PrimaryMasterKey string

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    PrimaryReadonlyKey string
    The Primary read-only Key for the CosmosDB Account.
    PrimaryReadonlyMasterKey string

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    ReadEndpoints List<string>
    A list of read endpoints available for this CosmosDB account.
    SecondaryKey string
    The Secondary key for the CosmosDB Account.
    SecondaryMasterKey string

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    SecondaryReadonlyKey string
    The Secondary read-only key for the CosmosDB Account.
    SecondaryReadonlyMasterKey string

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    WriteEndpoints List<string>
    A list of write endpoints available for this CosmosDB account.
    ConnectionStrings []string
    A list of connection strings available for this CosmosDB account.
    Endpoint string
    The endpoint used to connect to the CosmosDB account.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryKey string
    The Primary key for the CosmosDB Account.
    PrimaryMasterKey string

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    PrimaryReadonlyKey string
    The Primary read-only Key for the CosmosDB Account.
    PrimaryReadonlyMasterKey string

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    ReadEndpoints []string
    A list of read endpoints available for this CosmosDB account.
    SecondaryKey string
    The Secondary key for the CosmosDB Account.
    SecondaryMasterKey string

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    SecondaryReadonlyKey string
    The Secondary read-only key for the CosmosDB Account.
    SecondaryReadonlyMasterKey string

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    WriteEndpoints []string
    A list of write endpoints available for this CosmosDB account.
    connectionStrings List<String>
    A list of connection strings available for this CosmosDB account.
    endpoint String
    The endpoint used to connect to the CosmosDB account.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryKey String
    The Primary key for the CosmosDB Account.
    primaryMasterKey String

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primaryReadonlyKey String
    The Primary read-only Key for the CosmosDB Account.
    primaryReadonlyMasterKey String

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    readEndpoints List<String>
    A list of read endpoints available for this CosmosDB account.
    secondaryKey String
    The Secondary key for the CosmosDB Account.
    secondaryMasterKey String

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondaryReadonlyKey String
    The Secondary read-only key for the CosmosDB Account.
    secondaryReadonlyMasterKey String

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    writeEndpoints List<String>
    A list of write endpoints available for this CosmosDB account.
    connectionStrings string[]
    A list of connection strings available for this CosmosDB account.
    endpoint string
    The endpoint used to connect to the CosmosDB account.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryKey string
    The Primary key for the CosmosDB Account.
    primaryMasterKey string

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primaryReadonlyKey string
    The Primary read-only Key for the CosmosDB Account.
    primaryReadonlyMasterKey string

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    readEndpoints string[]
    A list of read endpoints available for this CosmosDB account.
    secondaryKey string
    The Secondary key for the CosmosDB Account.
    secondaryMasterKey string

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondaryReadonlyKey string
    The Secondary read-only key for the CosmosDB Account.
    secondaryReadonlyMasterKey string

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    writeEndpoints string[]
    A list of write endpoints available for this CosmosDB account.
    connection_strings Sequence[str]
    A list of connection strings available for this CosmosDB account.
    endpoint str
    The endpoint used to connect to the CosmosDB account.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_key str
    The Primary key for the CosmosDB Account.
    primary_master_key str

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primary_readonly_key str
    The Primary read-only Key for the CosmosDB Account.
    primary_readonly_master_key str

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    read_endpoints Sequence[str]
    A list of read endpoints available for this CosmosDB account.
    secondary_key str
    The Secondary key for the CosmosDB Account.
    secondary_master_key str

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondary_readonly_key str
    The Secondary read-only key for the CosmosDB Account.
    secondary_readonly_master_key str

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    write_endpoints Sequence[str]
    A list of write endpoints available for this CosmosDB account.
    connectionStrings List<String>
    A list of connection strings available for this CosmosDB account.
    endpoint String
    The endpoint used to connect to the CosmosDB account.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryKey String
    The Primary key for the CosmosDB Account.
    primaryMasterKey String

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primaryReadonlyKey String
    The Primary read-only Key for the CosmosDB Account.
    primaryReadonlyMasterKey String

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    readEndpoints List<String>
    A list of read endpoints available for this CosmosDB account.
    secondaryKey String
    The Secondary key for the CosmosDB Account.
    secondaryMasterKey String

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondaryReadonlyKey String
    The Secondary read-only key for the CosmosDB Account.
    secondaryReadonlyMasterKey String

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    writeEndpoints List<String>
    A list of write endpoints available for this CosmosDB account.

    Look up Existing Account Resource

    Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccountState, opts?: CustomResourceOptions): Account
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key_metadata_writes_enabled: Optional[bool] = None,
        analytical_storage: Optional[AccountAnalyticalStorageArgs] = None,
        analytical_storage_enabled: Optional[bool] = None,
        backup: Optional[AccountBackupArgs] = None,
        capabilities: Optional[Sequence[AccountCapabilityArgs]] = None,
        capacity: Optional[AccountCapacityArgs] = None,
        connection_strings: Optional[Sequence[str]] = None,
        consistency_policy: Optional[AccountConsistencyPolicyArgs] = None,
        cors_rule: Optional[AccountCorsRuleArgs] = None,
        create_mode: Optional[str] = None,
        default_identity_type: Optional[str] = None,
        enable_automatic_failover: Optional[bool] = None,
        enable_free_tier: Optional[bool] = None,
        enable_multiple_write_locations: Optional[bool] = None,
        endpoint: Optional[str] = None,
        geo_locations: Optional[Sequence[AccountGeoLocationArgs]] = None,
        identity: Optional[AccountIdentityArgs] = None,
        ip_range_filter: Optional[str] = None,
        is_virtual_network_filter_enabled: Optional[bool] = None,
        key_vault_key_id: Optional[str] = None,
        kind: Optional[str] = None,
        local_authentication_disabled: Optional[bool] = None,
        location: Optional[str] = None,
        mongo_server_version: Optional[str] = None,
        name: Optional[str] = None,
        network_acl_bypass_for_azure_services: Optional[bool] = None,
        network_acl_bypass_ids: Optional[Sequence[str]] = None,
        offer_type: Optional[str] = None,
        primary_key: Optional[str] = None,
        primary_master_key: Optional[str] = None,
        primary_readonly_key: Optional[str] = None,
        primary_readonly_master_key: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        read_endpoints: Optional[Sequence[str]] = None,
        resource_group_name: Optional[str] = None,
        restore: Optional[AccountRestoreArgs] = None,
        secondary_key: Optional[str] = None,
        secondary_master_key: Optional[str] = None,
        secondary_readonly_key: Optional[str] = None,
        secondary_readonly_master_key: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_network_rules: Optional[Sequence[AccountVirtualNetworkRuleArgs]] = None,
        write_endpoints: Optional[Sequence[str]] = None) -> Account
    func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
    public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
    public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
    resources:  _:    type: azure:cosmosdb:Account    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessKeyMetadataWritesEnabled bool
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    AnalyticalStorage AccountAnalyticalStorage
    An analytical_storage block as defined below.
    AnalyticalStorageEnabled bool
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    Backup AccountBackup
    A backup block as defined below.
    Capabilities List<AccountCapability>
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    Capacity AccountCapacity
    A capacity block as defined below.
    ConnectionStrings List<string>
    A list of connection strings available for this CosmosDB account.
    ConsistencyPolicy AccountConsistencyPolicy
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    CorsRule AccountCorsRule
    A cors_rule block as defined below.
    CreateMode string
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    DefaultIdentityType string
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    EnableAutomaticFailover bool
    Enable automatic fail over for this Cosmos DB account.
    EnableFreeTier bool
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    EnableMultipleWriteLocations bool
    Enable multiple write locations for this Cosmos DB account.
    Endpoint string
    The endpoint used to connect to the CosmosDB account.
    GeoLocations List<AccountGeoLocation>
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    Identity AccountIdentity
    An identity block as defined below.
    IpRangeFilter string
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    IsVirtualNetworkFilterEnabled bool
    Enables virtual network filtering for this Cosmos DB account.
    KeyVaultKeyId string
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    Kind string
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    LocalAuthenticationDisabled bool
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MongoServerVersion string
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    Name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    NetworkAclBypassForAzureServices bool
    If azure services can bypass ACLs. Defaults to false.
    NetworkAclBypassIds List<string>
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    OfferType string
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    PrimaryKey string
    The Primary key for the CosmosDB Account.
    PrimaryMasterKey string

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    PrimaryReadonlyKey string
    The Primary read-only Key for the CosmosDB Account.
    PrimaryReadonlyMasterKey string

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this CosmosDB account.
    ReadEndpoints List<string>
    A list of read endpoints available for this CosmosDB account.
    ResourceGroupName string
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    Restore AccountRestore
    A restore block as defined below.
    SecondaryKey string
    The Secondary key for the CosmosDB Account.
    SecondaryMasterKey string

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    SecondaryReadonlyKey string
    The Secondary read-only key for the CosmosDB Account.
    SecondaryReadonlyMasterKey string

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VirtualNetworkRules List<AccountVirtualNetworkRule>
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    WriteEndpoints List<string>
    A list of write endpoints available for this CosmosDB account.
    AccessKeyMetadataWritesEnabled bool
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    AnalyticalStorage AccountAnalyticalStorageArgs
    An analytical_storage block as defined below.
    AnalyticalStorageEnabled bool
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    Backup AccountBackupArgs
    A backup block as defined below.
    Capabilities []AccountCapabilityArgs
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    Capacity AccountCapacityArgs
    A capacity block as defined below.
    ConnectionStrings []string
    A list of connection strings available for this CosmosDB account.
    ConsistencyPolicy AccountConsistencyPolicyArgs
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    CorsRule AccountCorsRuleArgs
    A cors_rule block as defined below.
    CreateMode string
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    DefaultIdentityType string
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    EnableAutomaticFailover bool
    Enable automatic fail over for this Cosmos DB account.
    EnableFreeTier bool
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    EnableMultipleWriteLocations bool
    Enable multiple write locations for this Cosmos DB account.
    Endpoint string
    The endpoint used to connect to the CosmosDB account.
    GeoLocations []AccountGeoLocationArgs
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    Identity AccountIdentityArgs
    An identity block as defined below.
    IpRangeFilter string
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    IsVirtualNetworkFilterEnabled bool
    Enables virtual network filtering for this Cosmos DB account.
    KeyVaultKeyId string
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    Kind string
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    LocalAuthenticationDisabled bool
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MongoServerVersion string
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    Name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    NetworkAclBypassForAzureServices bool
    If azure services can bypass ACLs. Defaults to false.
    NetworkAclBypassIds []string
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    OfferType string
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    PrimaryKey string
    The Primary key for the CosmosDB Account.
    PrimaryMasterKey string

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    PrimaryReadonlyKey string
    The Primary read-only Key for the CosmosDB Account.
    PrimaryReadonlyMasterKey string

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this CosmosDB account.
    ReadEndpoints []string
    A list of read endpoints available for this CosmosDB account.
    ResourceGroupName string
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    Restore AccountRestoreArgs
    A restore block as defined below.
    SecondaryKey string
    The Secondary key for the CosmosDB Account.
    SecondaryMasterKey string

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    SecondaryReadonlyKey string
    The Secondary read-only key for the CosmosDB Account.
    SecondaryReadonlyMasterKey string

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    Tags map[string]string
    A mapping of tags to assign to the resource.
    VirtualNetworkRules []AccountVirtualNetworkRuleArgs
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    WriteEndpoints []string
    A list of write endpoints available for this CosmosDB account.
    accessKeyMetadataWritesEnabled Boolean
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analyticalStorage AccountAnalyticalStorage
    An analytical_storage block as defined below.
    analyticalStorageEnabled Boolean
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup AccountBackup
    A backup block as defined below.
    capabilities List<AccountCapability>
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity AccountCapacity
    A capacity block as defined below.
    connectionStrings List<String>
    A list of connection strings available for this CosmosDB account.
    consistencyPolicy AccountConsistencyPolicy
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    corsRule AccountCorsRule
    A cors_rule block as defined below.
    createMode String
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    defaultIdentityType String
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enableAutomaticFailover Boolean
    Enable automatic fail over for this Cosmos DB account.
    enableFreeTier Boolean
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enableMultipleWriteLocations Boolean
    Enable multiple write locations for this Cosmos DB account.
    endpoint String
    The endpoint used to connect to the CosmosDB account.
    geoLocations List<AccountGeoLocation>
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    identity AccountIdentity
    An identity block as defined below.
    ipRangeFilter String
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    isVirtualNetworkFilterEnabled Boolean
    Enables virtual network filtering for this Cosmos DB account.
    keyVaultKeyId String
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind String
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    localAuthenticationDisabled Boolean
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongoServerVersion String
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name String
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    networkAclBypassForAzureServices Boolean
    If azure services can bypass ACLs. Defaults to false.
    networkAclBypassIds List<String>
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    offerType String
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    primaryKey String
    The Primary key for the CosmosDB Account.
    primaryMasterKey String

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primaryReadonlyKey String
    The Primary read-only Key for the CosmosDB Account.
    primaryReadonlyMasterKey String

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this CosmosDB account.
    readEndpoints List<String>
    A list of read endpoints available for this CosmosDB account.
    resourceGroupName String
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    restore AccountRestore
    A restore block as defined below.
    secondaryKey String
    The Secondary key for the CosmosDB Account.
    secondaryMasterKey String

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondaryReadonlyKey String
    The Secondary read-only key for the CosmosDB Account.
    secondaryReadonlyMasterKey String

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    tags Map<String,String>
    A mapping of tags to assign to the resource.
    virtualNetworkRules List<AccountVirtualNetworkRule>
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    writeEndpoints List<String>
    A list of write endpoints available for this CosmosDB account.
    accessKeyMetadataWritesEnabled boolean
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analyticalStorage AccountAnalyticalStorage
    An analytical_storage block as defined below.
    analyticalStorageEnabled boolean
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup AccountBackup
    A backup block as defined below.
    capabilities AccountCapability[]
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity AccountCapacity
    A capacity block as defined below.
    connectionStrings string[]
    A list of connection strings available for this CosmosDB account.
    consistencyPolicy AccountConsistencyPolicy
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    corsRule AccountCorsRule
    A cors_rule block as defined below.
    createMode string
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    defaultIdentityType string
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enableAutomaticFailover boolean
    Enable automatic fail over for this Cosmos DB account.
    enableFreeTier boolean
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enableMultipleWriteLocations boolean
    Enable multiple write locations for this Cosmos DB account.
    endpoint string
    The endpoint used to connect to the CosmosDB account.
    geoLocations AccountGeoLocation[]
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    identity AccountIdentity
    An identity block as defined below.
    ipRangeFilter string
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    isVirtualNetworkFilterEnabled boolean
    Enables virtual network filtering for this Cosmos DB account.
    keyVaultKeyId string
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind string
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    localAuthenticationDisabled boolean
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongoServerVersion string
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    networkAclBypassForAzureServices boolean
    If azure services can bypass ACLs. Defaults to false.
    networkAclBypassIds string[]
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    offerType string
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    primaryKey string
    The Primary key for the CosmosDB Account.
    primaryMasterKey string

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primaryReadonlyKey string
    The Primary read-only Key for the CosmosDB Account.
    primaryReadonlyMasterKey string

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    publicNetworkAccessEnabled boolean
    Whether or not public network access is allowed for this CosmosDB account.
    readEndpoints string[]
    A list of read endpoints available for this CosmosDB account.
    resourceGroupName string
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    restore AccountRestore
    A restore block as defined below.
    secondaryKey string
    The Secondary key for the CosmosDB Account.
    secondaryMasterKey string

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondaryReadonlyKey string
    The Secondary read-only key for the CosmosDB Account.
    secondaryReadonlyMasterKey string

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    virtualNetworkRules AccountVirtualNetworkRule[]
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    writeEndpoints string[]
    A list of write endpoints available for this CosmosDB account.
    access_key_metadata_writes_enabled bool
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analytical_storage AccountAnalyticalStorageArgs
    An analytical_storage block as defined below.
    analytical_storage_enabled bool
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup AccountBackupArgs
    A backup block as defined below.
    capabilities Sequence[AccountCapabilityArgs]
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity AccountCapacityArgs
    A capacity block as defined below.
    connection_strings Sequence[str]
    A list of connection strings available for this CosmosDB account.
    consistency_policy AccountConsistencyPolicyArgs
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    cors_rule AccountCorsRuleArgs
    A cors_rule block as defined below.
    create_mode str
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    default_identity_type str
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enable_automatic_failover bool
    Enable automatic fail over for this Cosmos DB account.
    enable_free_tier bool
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enable_multiple_write_locations bool
    Enable multiple write locations for this Cosmos DB account.
    endpoint str
    The endpoint used to connect to the CosmosDB account.
    geo_locations Sequence[AccountGeoLocationArgs]
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    identity AccountIdentityArgs
    An identity block as defined below.
    ip_range_filter str
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    is_virtual_network_filter_enabled bool
    Enables virtual network filtering for this Cosmos DB account.
    key_vault_key_id str
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind str
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    local_authentication_disabled bool
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongo_server_version str
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name str
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    network_acl_bypass_for_azure_services bool
    If azure services can bypass ACLs. Defaults to false.
    network_acl_bypass_ids Sequence[str]
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    offer_type str
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    primary_key str
    The Primary key for the CosmosDB Account.
    primary_master_key str

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primary_readonly_key str
    The Primary read-only Key for the CosmosDB Account.
    primary_readonly_master_key str

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    public_network_access_enabled bool
    Whether or not public network access is allowed for this CosmosDB account.
    read_endpoints Sequence[str]
    A list of read endpoints available for this CosmosDB account.
    resource_group_name str
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    restore AccountRestoreArgs
    A restore block as defined below.
    secondary_key str
    The Secondary key for the CosmosDB Account.
    secondary_master_key str

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondary_readonly_key str
    The Secondary read-only key for the CosmosDB Account.
    secondary_readonly_master_key str

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    virtual_network_rules Sequence[AccountVirtualNetworkRuleArgs]
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    write_endpoints Sequence[str]
    A list of write endpoints available for this CosmosDB account.
    accessKeyMetadataWritesEnabled Boolean
    Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true.
    analyticalStorage Property Map
    An analytical_storage block as defined below.
    analyticalStorageEnabled Boolean
    Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    backup Property Map
    A backup block as defined below.
    capabilities List<Property Map>
    The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below. Changing this forces a new resource to be created.
    capacity Property Map
    A capacity block as defined below.
    connectionStrings List<String>
    A list of connection strings available for this CosmosDB account.
    consistencyPolicy Property Map
    Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
    corsRule Property Map
    A cors_rule block as defined below.
    createMode String
    The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created.
    defaultIdentityType String
    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity. Defaults to FirstPartyIdentity.
    enableAutomaticFailover Boolean
    Enable automatic fail over for this Cosmos DB account.
    enableFreeTier Boolean
    Enable Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created.
    enableMultipleWriteLocations Boolean
    Enable multiple write locations for this Cosmos DB account.
    endpoint String
    The endpoint used to connect to the CosmosDB account.
    geoLocations List<Property Map>
    Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below.
    identity Property Map
    An identity block as defined below.
    ipRangeFilter String
    CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
    isVirtualNetworkFilterEnabled Boolean
    Enables virtual network filtering for this Cosmos DB account.
    keyVaultKeyId String
    A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created.
    kind String
    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
    localAuthenticationDisabled Boolean
    Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mongoServerVersion String
    The Server Version of a MongoDB account. Possible values are 4.0, 3.6, and 3.2.
    name String
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    networkAclBypassForAzureServices Boolean
    If azure services can bypass ACLs. Defaults to false.
    networkAclBypassIds List<String>
    The list of resource Ids for Network Acl Bypass for this Cosmos DB account.
    offerType String
    Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
    primaryKey String
    The Primary key for the CosmosDB Account.
    primaryMasterKey String

    Deprecated: This property has been renamed to primary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    primaryReadonlyKey String
    The Primary read-only Key for the CosmosDB Account.
    primaryReadonlyMasterKey String

    Deprecated: This property has been renamed to primary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this CosmosDB account.
    readEndpoints List<String>
    A list of read endpoints available for this CosmosDB account.
    resourceGroupName String
    The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
    restore Property Map
    A restore block as defined below.
    secondaryKey String
    The Secondary key for the CosmosDB Account.
    secondaryMasterKey String

    Deprecated: This property has been renamed to secondary_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    secondaryReadonlyKey String
    The Secondary read-only key for the CosmosDB Account.
    secondaryReadonlyMasterKey String

    Deprecated: This property has been renamed to secondary_readonly_key and will be removed in v3.0 of the provider in support of HashiCorp's inclusive language policy which can be found here: https://discuss.hashicorp.com/t/inclusive-language-changes

    tags Map<String>
    A mapping of tags to assign to the resource.
    virtualNetworkRules List<Property Map>
    Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
    writeEndpoints List<String>
    A list of write endpoints available for this CosmosDB account.

    Supporting Types

    AccountAnalyticalStorage, AccountAnalyticalStorageArgs

    SchemaType string
    The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined.
    SchemaType string
    The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined.
    schemaType String
    The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined.
    schemaType string
    The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined.
    schema_type str
    The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined.
    schemaType String
    The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined.

    AccountBackup, AccountBackupArgs

    Type string
    The type of the backup. Possible values are Continuous and Periodic. Defaults to Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created.
    IntervalInMinutes int
    The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440.
    RetentionInHours int
    The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720.
    StorageRedundancy string
    The storage redundancy which is used to indicate type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone.
    Type string
    The type of the backup. Possible values are Continuous and Periodic. Defaults to Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created.
    IntervalInMinutes int
    The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440.
    RetentionInHours int
    The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720.
    StorageRedundancy string
    The storage redundancy which is used to indicate type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone.
    type String
    The type of the backup. Possible values are Continuous and Periodic. Defaults to Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created.
    intervalInMinutes Integer
    The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440.
    retentionInHours Integer
    The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720.
    storageRedundancy String
    The storage redundancy which is used to indicate type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone.
    type string
    The type of the backup. Possible values are Continuous and Periodic. Defaults to Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created.
    intervalInMinutes number
    The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440.
    retentionInHours number
    The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720.
    storageRedundancy string
    The storage redundancy which is used to indicate type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone.
    type str
    The type of the backup. Possible values are Continuous and Periodic. Defaults to Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created.
    interval_in_minutes int
    The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440.
    retention_in_hours int
    The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720.
    storage_redundancy str
    The storage redundancy which is used to indicate type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone.
    type String
    The type of the backup. Possible values are Continuous and Periodic. Defaults to Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created.
    intervalInMinutes Number
    The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440.
    retentionInHours Number
    The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720.
    storageRedundancy String
    The storage redundancy which is used to indicate type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone.

    AccountCapability, AccountCapabilityArgs

    Name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    name String
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    name string
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    name str
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
    name String
    Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.

    AccountCapacity, AccountCapacityArgs

    TotalThroughputLimit int
    The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
    TotalThroughputLimit int
    The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
    totalThroughputLimit Integer
    The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
    totalThroughputLimit number
    The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
    total_throughput_limit int
    The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
    totalThroughputLimit Number
    The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.

    AccountConsistencyPolicy, AccountConsistencyPolicyArgs

    ConsistencyLevel string
    The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.
    MaxIntervalInSeconds int
    When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness.
    MaxStalenessPrefix int
    When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.
    ConsistencyLevel string
    The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.
    MaxIntervalInSeconds int
    When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness.
    MaxStalenessPrefix int
    When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.
    consistencyLevel String
    The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.
    maxIntervalInSeconds Integer
    When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness.
    maxStalenessPrefix Integer
    When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.
    consistencyLevel string
    The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.
    maxIntervalInSeconds number
    When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness.
    maxStalenessPrefix number
    When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.
    consistency_level str
    The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.
    max_interval_in_seconds int
    When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness.
    max_staleness_prefix int
    When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.
    consistencyLevel String
    The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.
    maxIntervalInSeconds Number
    When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness.
    maxStalenessPrefix Number
    When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    AccountCorsRule, AccountCorsRuleArgs

    AllowedHeaders List<string>
    A list of headers that are allowed to be a part of the cross-origin request.
    AllowedMethods List<string>
    A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.
    AllowedOrigins List<string>
    A list of origin domains that will be allowed by CORS.
    ExposedHeaders List<string>
    A list of response headers that are exposed to CORS clients.
    MaxAgeInSeconds int
    The number of seconds the client should cache a preflight response.
    AllowedHeaders []string
    A list of headers that are allowed to be a part of the cross-origin request.
    AllowedMethods []string
    A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.
    AllowedOrigins []string
    A list of origin domains that will be allowed by CORS.
    ExposedHeaders []string
    A list of response headers that are exposed to CORS clients.
    MaxAgeInSeconds int
    The number of seconds the client should cache a preflight response.
    allowedHeaders List<String>
    A list of headers that are allowed to be a part of the cross-origin request.
    allowedMethods List<String>
    A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.
    allowedOrigins List<String>
    A list of origin domains that will be allowed by CORS.
    exposedHeaders List<String>
    A list of response headers that are exposed to CORS clients.
    maxAgeInSeconds Integer
    The number of seconds the client should cache a preflight response.
    allowedHeaders string[]
    A list of headers that are allowed to be a part of the cross-origin request.
    allowedMethods string[]
    A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.
    allowedOrigins string[]
    A list of origin domains that will be allowed by CORS.
    exposedHeaders string[]
    A list of response headers that are exposed to CORS clients.
    maxAgeInSeconds number
    The number of seconds the client should cache a preflight response.
    allowed_headers Sequence[str]
    A list of headers that are allowed to be a part of the cross-origin request.
    allowed_methods Sequence[str]
    A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.
    allowed_origins Sequence[str]
    A list of origin domains that will be allowed by CORS.
    exposed_headers Sequence[str]
    A list of response headers that are exposed to CORS clients.
    max_age_in_seconds int
    The number of seconds the client should cache a preflight response.
    allowedHeaders List<String>
    A list of headers that are allowed to be a part of the cross-origin request.
    allowedMethods List<String>
    A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.
    allowedOrigins List<String>
    A list of origin domains that will be allowed by CORS.
    exposedHeaders List<String>
    A list of response headers that are exposed to CORS clients.
    maxAgeInSeconds Number
    The number of seconds the client should cache a preflight response.

    AccountGeoLocation, AccountGeoLocationArgs

    FailoverPriority int
    The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.
    Location string
    The name of the Azure region to host replicated data.
    Id string
    The ID of the virtual network subnet.
    Prefix string
    The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

    Deprecated: This is deprecated because the service no longer accepts this as an input since Apr 25, 2019

    ZoneRedundant bool
    Should zone redundancy be enabled for this region? Defaults to false.
    FailoverPriority int
    The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.
    Location string
    The name of the Azure region to host replicated data.
    Id string
    The ID of the virtual network subnet.
    Prefix string
    The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

    Deprecated: This is deprecated because the service no longer accepts this as an input since Apr 25, 2019

    ZoneRedundant bool
    Should zone redundancy be enabled for this region? Defaults to false.
    failoverPriority Integer
    The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.
    location String
    The name of the Azure region to host replicated data.
    id String
    The ID of the virtual network subnet.
    prefix String
    The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

    Deprecated: This is deprecated because the service no longer accepts this as an input since Apr 25, 2019

    zoneRedundant Boolean
    Should zone redundancy be enabled for this region? Defaults to false.
    failoverPriority number
    The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.
    location string
    The name of the Azure region to host replicated data.
    id string
    The ID of the virtual network subnet.
    prefix string
    The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

    Deprecated: This is deprecated because the service no longer accepts this as an input since Apr 25, 2019

    zoneRedundant boolean
    Should zone redundancy be enabled for this region? Defaults to false.
    failover_priority int
    The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.
    location str
    The name of the Azure region to host replicated data.
    id str
    The ID of the virtual network subnet.
    prefix str
    The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

    Deprecated: This is deprecated because the service no longer accepts this as an input since Apr 25, 2019

    zone_redundant bool
    Should zone redundancy be enabled for this region? Defaults to false.
    failoverPriority Number
    The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.
    location String
    The name of the Azure region to host replicated data.
    id String
    The ID of the virtual network subnet.
    prefix String
    The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

    Deprecated: This is deprecated because the service no longer accepts this as an input since Apr 25, 2019

    zoneRedundant Boolean
    Should zone redundancy be enabled for this region? Defaults to false.

    AccountIdentity, AccountIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Cosmos Account. Possible value is only SystemAssigned.
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Cosmos Account. Possible value is only SystemAssigned.
    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Cosmos Account. Possible value is only SystemAssigned.
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Cosmos Account. Possible value is only SystemAssigned.
    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Cosmos Account. Possible value is only SystemAssigned.
    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Cosmos Account. Possible value is only SystemAssigned.
    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    AccountRestore, AccountRestoreArgs

    RestoreTimestampInUtc string
    The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
    SourceCosmosdbAccountId string
    The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created.
    Databases List<AccountRestoreDatabase>
    A database block as defined below. Changing this forces a new resource to be created.
    RestoreTimestampInUtc string
    The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
    SourceCosmosdbAccountId string
    The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created.
    Databases []AccountRestoreDatabase
    A database block as defined below. Changing this forces a new resource to be created.
    restoreTimestampInUtc String
    The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
    sourceCosmosdbAccountId String
    The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created.
    databases List<AccountRestoreDatabase>
    A database block as defined below. Changing this forces a new resource to be created.
    restoreTimestampInUtc string
    The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
    sourceCosmosdbAccountId string
    The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created.
    databases AccountRestoreDatabase[]
    A database block as defined below. Changing this forces a new resource to be created.
    restore_timestamp_in_utc str
    The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
    source_cosmosdb_account_id str
    The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created.
    databases Sequence[AccountRestoreDatabase]
    A database block as defined below. Changing this forces a new resource to be created.
    restoreTimestampInUtc String
    The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
    sourceCosmosdbAccountId String
    The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created.
    databases List<Property Map>
    A database block as defined below. Changing this forces a new resource to be created.

    AccountRestoreDatabase, AccountRestoreDatabaseArgs

    Name string
    The database name for the restore request. Changing this forces a new resource to be created.
    CollectionNames List<string>
    A list of the collection names for the restore request. Changing this forces a new resource to be created.
    Name string
    The database name for the restore request. Changing this forces a new resource to be created.
    CollectionNames []string
    A list of the collection names for the restore request. Changing this forces a new resource to be created.
    name String
    The database name for the restore request. Changing this forces a new resource to be created.
    collectionNames List<String>
    A list of the collection names for the restore request. Changing this forces a new resource to be created.
    name string
    The database name for the restore request. Changing this forces a new resource to be created.
    collectionNames string[]
    A list of the collection names for the restore request. Changing this forces a new resource to be created.
    name str
    The database name for the restore request. Changing this forces a new resource to be created.
    collection_names Sequence[str]
    A list of the collection names for the restore request. Changing this forces a new resource to be created.
    name String
    The database name for the restore request. Changing this forces a new resource to be created.
    collectionNames List<String>
    A list of the collection names for the restore request. Changing this forces a new resource to be created.

    AccountVirtualNetworkRule, AccountVirtualNetworkRuleArgs

    Id string
    The ID of the virtual network subnet.
    IgnoreMissingVnetServiceEndpoint bool
    If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false.
    Id string
    The ID of the virtual network subnet.
    IgnoreMissingVnetServiceEndpoint bool
    If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false.
    id String
    The ID of the virtual network subnet.
    ignoreMissingVnetServiceEndpoint Boolean
    If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false.
    id string
    The ID of the virtual network subnet.
    ignoreMissingVnetServiceEndpoint boolean
    If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false.
    id str
    The ID of the virtual network subnet.
    ignore_missing_vnet_service_endpoint bool
    If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false.
    id String
    The ID of the virtual network subnet.
    ignoreMissingVnetServiceEndpoint Boolean
    If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false.

    Import

    CosmosDB Accounts can be imported using the resource id, e.g.

     $ pulumi import azure:cosmosdb/account:Account account1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DocumentDB/databaseAccounts/account1

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

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial