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

We recommend using Azure Native.

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

azure.cosmosdb.Account

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

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

    Manages a CosmosDB (formally DocumentDB) Account.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var rg = new Azure.Core.ResourceGroup("rg", new()
        {
            Location = "westus",
        });
    
        var ri = new Random.RandomInteger("ri", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var db = new Azure.CosmosDB.Account("db", new()
        {
            Location = azurerm_resource_group.Example.Location,
            ResourceGroupName = azurerm_resource_group.Example.Name,
            OfferType = "Standard",
            Kind = "MongoDB",
            EnableAutomaticFailover = true,
            Capabilities = new[]
            {
                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[]
            {
                new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
                {
                    Location = "eastus",
                    FailoverPriority = 1,
                },
                new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
                {
                    Location = "westus",
                    FailoverPriority = 0,
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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 {
    		_, 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:                pulumi.Any(azurerm_resource_group.Example.Location),
    			ResourceGroupName:       pulumi.Any(azurerm_resource_group.Example.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.String("eastus"),
    					FailoverPriority: pulumi.Int(1),
    				},
    				&cosmosdb.AccountGeoLocationArgs{
    					Location:         pulumi.String("westus"),
    					FailoverPriority: pulumi.Int(0),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.random.RandomInteger;
    import com.pulumi.random.RandomIntegerArgs;
    import com.pulumi.azure.cosmosdb.Account;
    import com.pulumi.azure.cosmosdb.AccountArgs;
    import com.pulumi.azure.cosmosdb.inputs.AccountCapabilityArgs;
    import com.pulumi.azure.cosmosdb.inputs.AccountConsistencyPolicyArgs;
    import com.pulumi.azure.cosmosdb.inputs.AccountGeoLocationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var rg = new ResourceGroup("rg", ResourceGroupArgs.builder()        
                .location("westus")
                .build());
    
            var ri = new RandomInteger("ri", RandomIntegerArgs.builder()        
                .min(10000)
                .max(99999)
                .build());
    
            var db = new Account("db", AccountArgs.builder()        
                .location(azurerm_resource_group.example().location())
                .resourceGroupName(azurerm_resource_group.example().name())
                .offerType("Standard")
                .kind("MongoDB")
                .enableAutomaticFailover(true)
                .capabilities(            
                    AccountCapabilityArgs.builder()
                        .name("EnableAggregationPipeline")
                        .build(),
                    AccountCapabilityArgs.builder()
                        .name("mongoEnableDocLevelTTL")
                        .build(),
                    AccountCapabilityArgs.builder()
                        .name("MongoDBv3.4")
                        .build(),
                    AccountCapabilityArgs.builder()
                        .name("EnableMongo")
                        .build())
                .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
                    .consistencyLevel("BoundedStaleness")
                    .maxIntervalInSeconds(300)
                    .maxStalenessPrefix(100000)
                    .build())
                .geoLocations(            
                    AccountGeoLocationArgs.builder()
                        .location("eastus")
                        .failoverPriority(1)
                        .build(),
                    AccountGeoLocationArgs.builder()
                        .location("westus")
                        .failoverPriority(0)
                        .build())
                .build());
    
        }
    }
    
    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=azurerm_resource_group["example"]["location"],
        resource_group_name=azurerm_resource_group["example"]["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="eastus",
                failover_priority=1,
            ),
            azure.cosmosdb.AccountGeoLocationArgs(
                location="westus",
                failover_priority=0,
            ),
        ])
    
    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: azurerm_resource_group.example.location,
        resourceGroupName: azurerm_resource_group.example.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: "eastus",
                failoverPriority: 1,
            },
            {
                location: "westus",
                failoverPriority: 0,
            },
        ],
    });
    
    resources:
      rg:
        type: azure:core:ResourceGroup
        properties:
          location: westus
      ri:
        type: random:RandomInteger
        properties:
          min: 10000
          max: 99999
      db:
        type: azure:cosmosdb:Account
        properties:
          location: ${azurerm_resource_group.example.location}
          resourceGroupName: ${azurerm_resource_group.example.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: eastus
              failoverPriority: 1
            - location: westus
              failoverPriority: 0
    

    Create Account Resource

    new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
    @overload
    def Account(resource_name: 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,
                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,
                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,
                public_network_access_enabled: Optional[bool] = None,
                resource_group_name: Optional[str] = None,
                restore: Optional[AccountRestoreArgs] = None,
                tags: Optional[Mapping[str, str]] = None,
                virtual_network_rules: Optional[Sequence[AccountVirtualNetworkRuleArgs]] = None)
    @overload
    def Account(resource_name: str,
                args: AccountArgs,
                opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    DefaultIdentityType string

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    EnableAutomaticFailover bool

    Enable automatic failover for this Cosmos DB account.

    EnableFreeTier bool

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    Kind string

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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. Defaults to true.

    Restore AccountRestore

    A restore block as defined below.

    NOTE: restore should be set when create_mode is Restore.

    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    DefaultIdentityType string

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    EnableAutomaticFailover bool

    Enable automatic failover for this Cosmos DB account.

    EnableFreeTier bool

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    Kind string

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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. Defaults to true.

    Restore AccountRestoreArgs

    A restore block as defined below.

    NOTE: restore should be set when create_mode is Restore.

    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    defaultIdentityType String

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enableAutomaticFailover Boolean

    Enable automatic failover for this Cosmos DB account.

    enableFreeTier Boolean

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind String

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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. Defaults to true.

    restore AccountRestore

    A restore block as defined below.

    NOTE: restore should be set when create_mode is Restore.

    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    defaultIdentityType string

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enableAutomaticFailover boolean

    Enable automatic failover for this Cosmos DB account.

    enableFreeTier boolean

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind string

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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. Defaults to true.

    restore AccountRestore

    A restore block as defined below.

    NOTE: restore should be set when create_mode is Restore.

    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    default_identity_type str

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enable_automatic_failover bool

    Enable automatic failover for this Cosmos DB account.

    enable_free_tier bool

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind str

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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. Defaults to true.

    restore AccountRestoreArgs

    A restore block as defined below.

    NOTE: restore should be set when create_mode is Restore.

    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    defaultIdentityType String

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enableAutomaticFailover Boolean

    Enable automatic failover for this Cosmos DB account.

    enableFreeTier Boolean

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind String

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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. Defaults to true.

    restore Property Map

    A restore block as defined below.

    NOTE: restore should be set when create_mode is Restore.

    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.

    PrimaryReadonlyKey string

    The Primary read-only Key for the CosmosDB Account.

    PrimaryReadonlySqlConnectionString string
    PrimarySqlConnectionString string
    ReadEndpoints List<string>

    A list of read endpoints available for this CosmosDB account.

    SecondaryKey string

    The Secondary key for the CosmosDB Account.

    SecondaryReadonlyKey string

    The Secondary read-only key for the CosmosDB Account.

    SecondaryReadonlySqlConnectionString string
    SecondarySqlConnectionString string
    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.

    PrimaryReadonlyKey string

    The Primary read-only Key for the CosmosDB Account.

    PrimaryReadonlySqlConnectionString string
    PrimarySqlConnectionString string
    ReadEndpoints []string

    A list of read endpoints available for this CosmosDB account.

    SecondaryKey string

    The Secondary key for the CosmosDB Account.

    SecondaryReadonlyKey string

    The Secondary read-only key for the CosmosDB Account.

    SecondaryReadonlySqlConnectionString string
    SecondarySqlConnectionString string
    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.

    primaryReadonlyKey String

    The Primary read-only Key for the CosmosDB Account.

    primaryReadonlySqlConnectionString String
    primarySqlConnectionString String
    readEndpoints List<String>

    A list of read endpoints available for this CosmosDB account.

    secondaryKey String

    The Secondary key for the CosmosDB Account.

    secondaryReadonlyKey String

    The Secondary read-only key for the CosmosDB Account.

    secondaryReadonlySqlConnectionString String
    secondarySqlConnectionString String
    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.

    primaryReadonlyKey string

    The Primary read-only Key for the CosmosDB Account.

    primaryReadonlySqlConnectionString string
    primarySqlConnectionString string
    readEndpoints string[]

    A list of read endpoints available for this CosmosDB account.

    secondaryKey string

    The Secondary key for the CosmosDB Account.

    secondaryReadonlyKey string

    The Secondary read-only key for the CosmosDB Account.

    secondaryReadonlySqlConnectionString string
    secondarySqlConnectionString string
    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_readonly_key str

    The Primary read-only Key for the CosmosDB Account.

    primary_readonly_sql_connection_string str
    primary_sql_connection_string str
    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_readonly_key str

    The Secondary read-only key for the CosmosDB Account.

    secondary_readonly_sql_connection_string str
    secondary_sql_connection_string str
    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.

    primaryReadonlyKey String

    The Primary read-only Key for the CosmosDB Account.

    primaryReadonlySqlConnectionString String
    primarySqlConnectionString String
    readEndpoints List<String>

    A list of read endpoints available for this CosmosDB account.

    secondaryKey String

    The Secondary key for the CosmosDB Account.

    secondaryReadonlyKey String

    The Secondary read-only key for the CosmosDB Account.

    secondaryReadonlySqlConnectionString String
    secondarySqlConnectionString String
    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_readonly_key: Optional[str] = None,
            primary_readonly_sql_connection_string: Optional[str] = None,
            primary_sql_connection_string: 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_readonly_key: Optional[str] = None,
            secondary_readonly_sql_connection_string: Optional[str] = None,
            secondary_sql_connection_string: 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)
    Resource lookup is not supported in YAML
    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    DefaultIdentityType string

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    EnableAutomaticFailover bool

    Enable automatic failover for this Cosmos DB account.

    EnableFreeTier bool

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    Kind string

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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.

    PrimaryReadonlyKey string

    The Primary read-only Key for the CosmosDB Account.

    PrimaryReadonlySqlConnectionString string
    PrimarySqlConnectionString string
    PublicNetworkAccessEnabled bool

    Whether or not public network access is allowed for this CosmosDB account. Defaults to true.

    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.

    NOTE: restore should be set when create_mode is Restore.

    SecondaryKey string

    The Secondary key for the CosmosDB Account.

    SecondaryReadonlyKey string

    The Secondary read-only key for the CosmosDB Account.

    SecondaryReadonlySqlConnectionString string
    SecondarySqlConnectionString string
    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    DefaultIdentityType string

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    EnableAutomaticFailover bool

    Enable automatic failover for this Cosmos DB account.

    EnableFreeTier bool

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    Kind string

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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.

    PrimaryReadonlyKey string

    The Primary read-only Key for the CosmosDB Account.

    PrimaryReadonlySqlConnectionString string
    PrimarySqlConnectionString string
    PublicNetworkAccessEnabled bool

    Whether or not public network access is allowed for this CosmosDB account. Defaults to true.

    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.

    NOTE: restore should be set when create_mode is Restore.

    SecondaryKey string

    The Secondary key for the CosmosDB Account.

    SecondaryReadonlyKey string

    The Secondary read-only key for the CosmosDB Account.

    SecondaryReadonlySqlConnectionString string
    SecondarySqlConnectionString string
    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    defaultIdentityType String

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enableAutomaticFailover Boolean

    Enable automatic failover for this Cosmos DB account.

    enableFreeTier Boolean

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind String

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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.

    primaryReadonlyKey String

    The Primary read-only Key for the CosmosDB Account.

    primaryReadonlySqlConnectionString String
    primarySqlConnectionString String
    publicNetworkAccessEnabled Boolean

    Whether or not public network access is allowed for this CosmosDB account. Defaults to true.

    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.

    NOTE: restore should be set when create_mode is Restore.

    secondaryKey String

    The Secondary key for the CosmosDB Account.

    secondaryReadonlyKey String

    The Secondary read-only key for the CosmosDB Account.

    secondaryReadonlySqlConnectionString String
    secondarySqlConnectionString String
    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    defaultIdentityType string

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enableAutomaticFailover boolean

    Enable automatic failover for this Cosmos DB account.

    enableFreeTier boolean

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind string

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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.

    primaryReadonlyKey string

    The Primary read-only Key for the CosmosDB Account.

    primaryReadonlySqlConnectionString string
    primarySqlConnectionString string
    publicNetworkAccessEnabled boolean

    Whether or not public network access is allowed for this CosmosDB account. Defaults to true.

    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.

    NOTE: restore should be set when create_mode is Restore.

    secondaryKey string

    The Secondary key for the CosmosDB Account.

    secondaryReadonlyKey string

    The Secondary read-only key for the CosmosDB Account.

    secondaryReadonlySqlConnectionString string
    secondarySqlConnectionString string
    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    default_identity_type str

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enable_automatic_failover bool

    Enable automatic failover for this Cosmos DB account.

    enable_free_tier bool

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind str

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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_readonly_key str

    The Primary read-only Key for the CosmosDB Account.

    primary_readonly_sql_connection_string str
    primary_sql_connection_string str
    public_network_access_enabled bool

    Whether or not public network access is allowed for this CosmosDB account. Defaults to true.

    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.

    NOTE: restore should be set when create_mode is Restore.

    secondary_key str

    The Secondary key for the CosmosDB Account.

    secondary_readonly_key str

    The Secondary read-only key for the CosmosDB Account.

    secondary_readonly_sql_connection_string str
    secondary_sql_connection_string str
    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. Enabling and then disabling analytical storage 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.

    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.

    NOTE: create_mode only works when backup.type is Continuous.

    defaultIdentityType String

    The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.

    enableAutomaticFailover Boolean

    Enable automatic failover for this Cosmos DB account.

    enableFreeTier Boolean

    Enable the 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 IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

    NOTE: To enable the "Allow access from the Azure portal" behavior, you should add the IP addresses provided by the documentation to this list.

    NOTE: To enable the "Accept connections from within public Azure datacenters" behavior, you should add 0.0.0.0 to the list, see the documentation for more details.

    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.

    NOTE: When referencing an azure.keyvault.Key resource, use versionless_id instead of id

    NOTE: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

    kind String

    Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. 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.2, 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.

    primaryReadonlyKey String

    The Primary read-only Key for the CosmosDB Account.

    primaryReadonlySqlConnectionString String
    primarySqlConnectionString String
    publicNetworkAccessEnabled Boolean

    Whether or not public network access is allowed for this CosmosDB account. Defaults to true.

    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.

    NOTE: restore should be set when create_mode is Restore.

    secondaryKey String

    The Secondary key for the CosmosDB Account.

    secondaryReadonlyKey String

    The Secondary read-only key for the CosmosDB Account.

    secondaryReadonlySqlConnectionString String
    secondarySqlConnectionString String
    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. 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 is used to indicate the 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. 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 is used to indicate the 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. 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 is used to indicate the 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. 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 is used to indicate the 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. 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 is used to indicate the 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. 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 is used to indicate the 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. The 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. The accepted range for this value is 102147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    Note: max_interval_in_seconds and max_staleness_prefix can only be set to custom values when consistency_level is set to BoundedStaleness - otherwise they will return the default values shown above.

    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. The 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. The accepted range for this value is 102147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    Note: max_interval_in_seconds and max_staleness_prefix can only be set to custom values when consistency_level is set to BoundedStaleness - otherwise they will return the default values shown above.

    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. The 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. The accepted range for this value is 102147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    Note: max_interval_in_seconds and max_staleness_prefix can only be set to custom values when consistency_level is set to BoundedStaleness - otherwise they will return the default values shown above.

    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. The 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. The accepted range for this value is 102147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    Note: max_interval_in_seconds and max_staleness_prefix can only be set to custom values when consistency_level is set to BoundedStaleness - otherwise they will return the default values shown above.

    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. The 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. The accepted range for this value is 102147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    Note: max_interval_in_seconds and max_staleness_prefix can only be set to custom values when consistency_level is set to BoundedStaleness - otherwise they will return the default values shown above.

    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. The 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. The accepted range for this value is 102147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness.

    Note: max_interval_in_seconds and max_staleness_prefix can only be set to custom values when consistency_level is set to BoundedStaleness - otherwise they will return the default values shown above.

    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. Possible values are between 1 and 2147483647.

    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. Possible values are between 1 and 2147483647.

    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. Possible values are between 1 and 2147483647.

    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. Possible values are between 1 and 2147483647.

    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. Possible values are between 1 and 2147483647.

    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. Possible values are between 1 and 2147483647.

    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.

    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.

    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.

    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.

    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.

    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.

    zoneRedundant Boolean

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

    AccountIdentity, AccountIdentityArgs

    Type string

    The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account.

    PrincipalId string

    The Principal ID associated with this Managed Service Identity.

    TenantId string

    The Tenant ID associated with this Managed Service Identity.

    Type string

    The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account.

    PrincipalId string

    The Principal ID associated with this Managed Service Identity.

    TenantId string

    The Tenant ID associated with this Managed Service Identity.

    type String

    The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account.

    principalId String

    The Principal ID associated with this Managed Service Identity.

    tenantId String

    The Tenant ID associated with this Managed Service Identity.

    type string

    The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account.

    principalId string

    The Principal ID associated with this Managed Service Identity.

    tenantId string

    The Tenant ID associated with this Managed Service Identity.

    type str

    The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account.

    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

    The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account.

    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.

    NOTE: Any database account with Continuous type (live account or accounts deleted in last 30 days) is a restorable database account and there cannot be Create/Update/Delete operations on the restorable database accounts. They can only be read and retrieved by azure.cosmosdb.getRestorableDatabaseAccounts.

    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.

    NOTE: Any database account with Continuous type (live account or accounts deleted in last 30 days) is a restorable database account and there cannot be Create/Update/Delete operations on the restorable database accounts. They can only be read and retrieved by azure.cosmosdb.getRestorableDatabaseAccounts.

    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.

    NOTE: Any database account with Continuous type (live account or accounts deleted in last 30 days) is a restorable database account and there cannot be Create/Update/Delete operations on the restorable database accounts. They can only be read and retrieved by azure.cosmosdb.getRestorableDatabaseAccounts.

    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.

    NOTE: Any database account with Continuous type (live account or accounts deleted in last 30 days) is a restorable database account and there cannot be Create/Update/Delete operations on the restorable database accounts. They can only be read and retrieved by azure.cosmosdb.getRestorableDatabaseAccounts.

    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.

    NOTE: Any database account with Continuous type (live account or accounts deleted in last 30 days) is a restorable database account and there cannot be Create/Update/Delete operations on the restorable database accounts. They can only be read and retrieved by azure.cosmosdb.getRestorableDatabaseAccounts.

    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.

    NOTE: Any database account with Continuous type (live account or accounts deleted in last 30 days) is a restorable database account and there cannot be Create/Update/Delete operations on the restorable database accounts. They can only be read and retrieved by azure.cosmosdb.getRestorableDatabaseAccounts.

    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
    

    Package Details

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

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

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