Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. Account

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.Account

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a CosmosDB (formally DocumentDB) Account.

Example Usage

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", {
    name: "sample-rg",
    location: "westus",
});
const ri = new random.RandomInteger("ri", {
    min: 10000,
    max: 99999,
});
const db = new azure.cosmosdb.Account("db", {
    name: pulumi.interpolate`tfex-cosmos-db-${ri.result}`,
    location: example.location,
    resourceGroupName: example.name,
    offerType: "Standard",
    kind: "MongoDB",
    automaticFailoverEnabled: 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,
        },
    ],
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_random as random

rg = azure.core.ResourceGroup("rg",
    name="sample-rg",
    location="westus")
ri = random.RandomInteger("ri",
    min=10000,
    max=99999)
db = azure.cosmosdb.Account("db",
    name=ri.result.apply(lambda result: f"tfex-cosmos-db-{result}"),
    location=example["location"],
    resource_group_name=example["name"],
    offer_type="Standard",
    kind="MongoDB",
    automatic_failover_enabled=True,
    capabilities=[
        {
            "name": "EnableAggregationPipeline",
        },
        {
            "name": "mongoEnableDocLevelTTL",
        },
        {
            "name": "MongoDBv3.4",
        },
        {
            "name": "EnableMongo",
        },
    ],
    consistency_policy={
        "consistency_level": "BoundedStaleness",
        "max_interval_in_seconds": 300,
        "max_staleness_prefix": 100000,
    },
    geo_locations=[
        {
            "location": "eastus",
            "failover_priority": 1,
        },
        {
            "location": "westus",
            "failover_priority": 0,
        },
    ])
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/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{
			Name:     pulumi.String("sample-rg"),
			Location: pulumi.String("westus"),
		})
		if err != nil {
			return err
		}
		ri, 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{
			Name: ri.Result.ApplyT(func(result int) (string, error) {
				return fmt.Sprintf("tfex-cosmos-db-%v", result), nil
			}).(pulumi.StringOutput),
			Location:                 pulumi.Any(example.Location),
			ResourceGroupName:        pulumi.Any(example.Name),
			OfferType:                pulumi.String("Standard"),
			Kind:                     pulumi.String("MongoDB"),
			AutomaticFailoverEnabled: 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
	})
}
Copy
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()
    {
        Name = "sample-rg",
        Location = "westus",
    });

    var ri = new Random.RandomInteger("ri", new()
    {
        Min = 10000,
        Max = 99999,
    });

    var db = new Azure.CosmosDB.Account("db", new()
    {
        Name = ri.Result.Apply(result => $"tfex-cosmos-db-{result}"),
        Location = example.Location,
        ResourceGroupName = example.Name,
        OfferType = "Standard",
        Kind = "MongoDB",
        AutomaticFailoverEnabled = 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,
            },
        },
    });

});
Copy
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()
            .name("sample-rg")
            .location("westus")
            .build());

        var ri = new RandomInteger("ri", RandomIntegerArgs.builder()
            .min(10000)
            .max(99999)
            .build());

        var db = new Account("db", AccountArgs.builder()
            .name(ri.result().applyValue(result -> String.format("tfex-cosmos-db-%s", result)))
            .location(example.location())
            .resourceGroupName(example.name())
            .offerType("Standard")
            .kind("MongoDB")
            .automaticFailoverEnabled(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());

    }
}
Copy
resources:
  rg:
    type: azure:core:ResourceGroup
    properties:
      name: sample-rg
      location: westus
  ri:
    type: random:RandomInteger
    properties:
      min: 10000
      max: 99999
  db:
    type: azure:cosmosdb:Account
    properties:
      name: tfex-cosmos-db-${ri.result}
      location: ${example.location}
      resourceGroupName: ${example.name}
      offerType: Standard
      kind: MongoDB
      automaticFailoverEnabled: 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
Copy

User Assigned Identity Example Usage

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

const example = new azure.authorization.UserAssignedIdentity("example", {
    resourceGroupName: exampleAzurermResourceGroup.name,
    location: exampleAzurermResourceGroup.location,
    name: "example-resource",
});
const exampleAccount = new azure.cosmosdb.Account("example", {
    name: "example-resource",
    location: exampleAzurermResourceGroup.location,
    resourceGroupName: exampleAzurermResourceGroup.name,
    defaultIdentityType: std.joinOutput({
        separator: "=",
        input: [
            "UserAssignedIdentity",
            example.id,
        ],
    }).apply(invoke => invoke.result),
    offerType: "Standard",
    kind: "MongoDB",
    capabilities: [{
        name: "EnableMongo",
    }],
    consistencyPolicy: {
        consistencyLevel: "Strong",
    },
    geoLocations: [{
        location: "westus",
        failoverPriority: 0,
    }],
    identity: {
        type: "UserAssigned",
        identityIds: [example.id],
    },
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_std as std

example = azure.authorization.UserAssignedIdentity("example",
    resource_group_name=example_azurerm_resource_group["name"],
    location=example_azurerm_resource_group["location"],
    name="example-resource")
example_account = azure.cosmosdb.Account("example",
    name="example-resource",
    location=example_azurerm_resource_group["location"],
    resource_group_name=example_azurerm_resource_group["name"],
    default_identity_type=std.join_output(separator="=",
        input=[
            "UserAssignedIdentity",
            example.id,
        ]).apply(lambda invoke: invoke.result),
    offer_type="Standard",
    kind="MongoDB",
    capabilities=[{
        "name": "EnableMongo",
    }],
    consistency_policy={
        "consistency_level": "Strong",
    },
    geo_locations=[{
        "location": "westus",
        "failover_priority": 0,
    }],
    identity={
        "type": "UserAssigned",
        "identity_ids": [example.id],
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := authorization.NewUserAssignedIdentity(ctx, "example", &authorization.UserAssignedIdentityArgs{
			ResourceGroupName: pulumi.Any(exampleAzurermResourceGroup.Name),
			Location:          pulumi.Any(exampleAzurermResourceGroup.Location),
			Name:              pulumi.String("example-resource"),
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewAccount(ctx, "example", &cosmosdb.AccountArgs{
			Name:              pulumi.String("example-resource"),
			Location:          pulumi.Any(exampleAzurermResourceGroup.Location),
			ResourceGroupName: pulumi.Any(exampleAzurermResourceGroup.Name),
			DefaultIdentityType: pulumi.String(std.JoinOutput(ctx, std.JoinOutputArgs{
				Separator: pulumi.String("="),
				Input: pulumi.StringArray{
					pulumi.String("UserAssignedIdentity"),
					example.ID(),
				},
			}, nil).ApplyT(func(invoke std.JoinResult) (*string, error) {
				return invoke.Result, nil
			}).(pulumi.StringPtrOutput)),
			OfferType: pulumi.String("Standard"),
			Kind:      pulumi.String("MongoDB"),
			Capabilities: cosmosdb.AccountCapabilityArray{
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("EnableMongo"),
				},
			},
			ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
				ConsistencyLevel: pulumi.String("Strong"),
			},
			GeoLocations: cosmosdb.AccountGeoLocationArray{
				&cosmosdb.AccountGeoLocationArgs{
					Location:         pulumi.String("westus"),
					FailoverPriority: pulumi.Int(0),
				},
			},
			Identity: &cosmosdb.AccountIdentityArgs{
				Type: pulumi.String("UserAssigned"),
				IdentityIds: pulumi.StringArray{
					example.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Authorization.UserAssignedIdentity("example", new()
    {
        ResourceGroupName = exampleAzurermResourceGroup.Name,
        Location = exampleAzurermResourceGroup.Location,
        Name = "example-resource",
    });

    var exampleAccount = new Azure.CosmosDB.Account("example", new()
    {
        Name = "example-resource",
        Location = exampleAzurermResourceGroup.Location,
        ResourceGroupName = exampleAzurermResourceGroup.Name,
        DefaultIdentityType = Std.Join.Invoke(new()
        {
            Separator = "=",
            Input = new[]
            {
                "UserAssignedIdentity",
                example.Id,
            },
        }).Apply(invoke => invoke.Result),
        OfferType = "Standard",
        Kind = "MongoDB",
        Capabilities = new[]
        {
            new Azure.CosmosDB.Inputs.AccountCapabilityArgs
            {
                Name = "EnableMongo",
            },
        },
        ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
        {
            ConsistencyLevel = "Strong",
        },
        GeoLocations = new[]
        {
            new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
            {
                Location = "westus",
                FailoverPriority = 0,
            },
        },
        Identity = new Azure.CosmosDB.Inputs.AccountIdentityArgs
        {
            Type = "UserAssigned",
            IdentityIds = new[]
            {
                example.Id,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.authorization.UserAssignedIdentity;
import com.pulumi.azure.authorization.UserAssignedIdentityArgs;
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 com.pulumi.azure.cosmosdb.inputs.AccountIdentityArgs;
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 example = new UserAssignedIdentity("example", UserAssignedIdentityArgs.builder()
            .resourceGroupName(exampleAzurermResourceGroup.name())
            .location(exampleAzurermResourceGroup.location())
            .name("example-resource")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example-resource")
            .location(exampleAzurermResourceGroup.location())
            .resourceGroupName(exampleAzurermResourceGroup.name())
            .defaultIdentityType(StdFunctions.join().applyValue(invoke -> invoke.result()))
            .offerType("Standard")
            .kind("MongoDB")
            .capabilities(AccountCapabilityArgs.builder()
                .name("EnableMongo")
                .build())
            .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
                .consistencyLevel("Strong")
                .build())
            .geoLocations(AccountGeoLocationArgs.builder()
                .location("westus")
                .failoverPriority(0)
                .build())
            .identity(AccountIdentityArgs.builder()
                .type("UserAssigned")
                .identityIds(example.id())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:authorization:UserAssignedIdentity
    properties:
      resourceGroupName: ${exampleAzurermResourceGroup.name}
      location: ${exampleAzurermResourceGroup.location}
      name: example-resource
  exampleAccount:
    type: azure:cosmosdb:Account
    name: example
    properties:
      name: example-resource
      location: ${exampleAzurermResourceGroup.location}
      resourceGroupName: ${exampleAzurermResourceGroup.name}
      defaultIdentityType:
        fn::invoke:
          function: std:join
          arguments:
            separator: =
            input:
              - UserAssignedIdentity
              - ${example.id}
          return: result
      offerType: Standard
      kind: MongoDB
      capabilities:
        - name: EnableMongo
      consistencyPolicy:
        consistencyLevel: Strong
      geoLocations:
        - location: westus
          failoverPriority: 0
      identity:
        type: UserAssigned
        identityIds:
          - ${example.id}
Copy

Create Account Resource

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

Constructor syntax

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

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

type: azure:cosmosdb:Account
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccountArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleaccountResourceResourceFromCosmosdbaccount = new Azure.CosmosDB.Account("exampleaccountResourceResourceFromCosmosdbaccount", new()
{
    ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
    {
        ConsistencyLevel = "string",
        MaxIntervalInSeconds = 0,
        MaxStalenessPrefix = 0,
    },
    ResourceGroupName = "string",
    OfferType = "string",
    GeoLocations = new[]
    {
        new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
        {
            FailoverPriority = 0,
            Location = "string",
            Id = "string",
            ZoneRedundant = false,
        },
    },
    IsVirtualNetworkFilterEnabled = false,
    LocalAuthenticationDisabled = false,
    Capabilities = new[]
    {
        new Azure.CosmosDB.Inputs.AccountCapabilityArgs
        {
            Name = "string",
        },
    },
    Capacity = new Azure.CosmosDB.Inputs.AccountCapacityArgs
    {
        TotalThroughputLimit = 0,
    },
    Backup = new Azure.CosmosDB.Inputs.AccountBackupArgs
    {
        Type = "string",
        IntervalInMinutes = 0,
        RetentionInHours = 0,
        StorageRedundancy = "string",
        Tier = "string",
    },
    CorsRule = new Azure.CosmosDB.Inputs.AccountCorsRuleArgs
    {
        AllowedHeaders = new[]
        {
            "string",
        },
        AllowedMethods = new[]
        {
            "string",
        },
        AllowedOrigins = new[]
        {
            "string",
        },
        ExposedHeaders = new[]
        {
            "string",
        },
        MaxAgeInSeconds = 0,
    },
    CreateMode = "string",
    DefaultIdentityType = "string",
    FreeTierEnabled = false,
    AutomaticFailoverEnabled = false,
    Identity = new Azure.CosmosDB.Inputs.AccountIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    IpRangeFilters = new[]
    {
        "string",
    },
    AccessKeyMetadataWritesEnabled = false,
    KeyVaultKeyId = "string",
    Kind = "string",
    BurstCapacityEnabled = false,
    Location = "string",
    ManagedHsmKeyId = "string",
    MinimalTlsVersion = "string",
    MongoServerVersion = "string",
    MultipleWriteLocationsEnabled = false,
    Name = "string",
    NetworkAclBypassForAzureServices = false,
    NetworkAclBypassIds = new[]
    {
        "string",
    },
    AnalyticalStorageEnabled = false,
    PartitionMergeEnabled = false,
    PublicNetworkAccessEnabled = false,
    AnalyticalStorage = new Azure.CosmosDB.Inputs.AccountAnalyticalStorageArgs
    {
        SchemaType = "string",
    },
    Restore = new Azure.CosmosDB.Inputs.AccountRestoreArgs
    {
        RestoreTimestampInUtc = "string",
        SourceCosmosdbAccountId = "string",
        Databases = new[]
        {
            new Azure.CosmosDB.Inputs.AccountRestoreDatabaseArgs
            {
                Name = "string",
                CollectionNames = new[]
                {
                    "string",
                },
            },
        },
        GremlinDatabases = new[]
        {
            new Azure.CosmosDB.Inputs.AccountRestoreGremlinDatabaseArgs
            {
                Name = "string",
                GraphNames = new[]
                {
                    "string",
                },
            },
        },
        TablesToRestores = new[]
        {
            "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    VirtualNetworkRules = new[]
    {
        new Azure.CosmosDB.Inputs.AccountVirtualNetworkRuleArgs
        {
            Id = "string",
            IgnoreMissingVnetServiceEndpoint = false,
        },
    },
});
Copy
example, err := cosmosdb.NewAccount(ctx, "exampleaccountResourceResourceFromCosmosdbaccount", &cosmosdb.AccountArgs{
	ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
		ConsistencyLevel:     pulumi.String("string"),
		MaxIntervalInSeconds: pulumi.Int(0),
		MaxStalenessPrefix:   pulumi.Int(0),
	},
	ResourceGroupName: pulumi.String("string"),
	OfferType:         pulumi.String("string"),
	GeoLocations: cosmosdb.AccountGeoLocationArray{
		&cosmosdb.AccountGeoLocationArgs{
			FailoverPriority: pulumi.Int(0),
			Location:         pulumi.String("string"),
			Id:               pulumi.String("string"),
			ZoneRedundant:    pulumi.Bool(false),
		},
	},
	IsVirtualNetworkFilterEnabled: pulumi.Bool(false),
	LocalAuthenticationDisabled:   pulumi.Bool(false),
	Capabilities: cosmosdb.AccountCapabilityArray{
		&cosmosdb.AccountCapabilityArgs{
			Name: pulumi.String("string"),
		},
	},
	Capacity: &cosmosdb.AccountCapacityArgs{
		TotalThroughputLimit: pulumi.Int(0),
	},
	Backup: &cosmosdb.AccountBackupArgs{
		Type:              pulumi.String("string"),
		IntervalInMinutes: pulumi.Int(0),
		RetentionInHours:  pulumi.Int(0),
		StorageRedundancy: pulumi.String("string"),
		Tier:              pulumi.String("string"),
	},
	CorsRule: &cosmosdb.AccountCorsRuleArgs{
		AllowedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedMethods: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOrigins: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExposedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxAgeInSeconds: pulumi.Int(0),
	},
	CreateMode:               pulumi.String("string"),
	DefaultIdentityType:      pulumi.String("string"),
	FreeTierEnabled:          pulumi.Bool(false),
	AutomaticFailoverEnabled: pulumi.Bool(false),
	Identity: &cosmosdb.AccountIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	IpRangeFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	AccessKeyMetadataWritesEnabled:   pulumi.Bool(false),
	KeyVaultKeyId:                    pulumi.String("string"),
	Kind:                             pulumi.String("string"),
	BurstCapacityEnabled:             pulumi.Bool(false),
	Location:                         pulumi.String("string"),
	ManagedHsmKeyId:                  pulumi.String("string"),
	MinimalTlsVersion:                pulumi.String("string"),
	MongoServerVersion:               pulumi.String("string"),
	MultipleWriteLocationsEnabled:    pulumi.Bool(false),
	Name:                             pulumi.String("string"),
	NetworkAclBypassForAzureServices: pulumi.Bool(false),
	NetworkAclBypassIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	AnalyticalStorageEnabled:   pulumi.Bool(false),
	PartitionMergeEnabled:      pulumi.Bool(false),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	AnalyticalStorage: &cosmosdb.AccountAnalyticalStorageArgs{
		SchemaType: pulumi.String("string"),
	},
	Restore: &cosmosdb.AccountRestoreArgs{
		RestoreTimestampInUtc:   pulumi.String("string"),
		SourceCosmosdbAccountId: pulumi.String("string"),
		Databases: cosmosdb.AccountRestoreDatabaseArray{
			&cosmosdb.AccountRestoreDatabaseArgs{
				Name: pulumi.String("string"),
				CollectionNames: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		GremlinDatabases: cosmosdb.AccountRestoreGremlinDatabaseArray{
			&cosmosdb.AccountRestoreGremlinDatabaseArgs{
				Name: pulumi.String("string"),
				GraphNames: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		TablesToRestores: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VirtualNetworkRules: cosmosdb.AccountVirtualNetworkRuleArray{
		&cosmosdb.AccountVirtualNetworkRuleArgs{
			Id:                               pulumi.String("string"),
			IgnoreMissingVnetServiceEndpoint: pulumi.Bool(false),
		},
	},
})
Copy
var exampleaccountResourceResourceFromCosmosdbaccount = new Account("exampleaccountResourceResourceFromCosmosdbaccount", AccountArgs.builder()
    .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
        .consistencyLevel("string")
        .maxIntervalInSeconds(0)
        .maxStalenessPrefix(0)
        .build())
    .resourceGroupName("string")
    .offerType("string")
    .geoLocations(AccountGeoLocationArgs.builder()
        .failoverPriority(0)
        .location("string")
        .id("string")
        .zoneRedundant(false)
        .build())
    .isVirtualNetworkFilterEnabled(false)
    .localAuthenticationDisabled(false)
    .capabilities(AccountCapabilityArgs.builder()
        .name("string")
        .build())
    .capacity(AccountCapacityArgs.builder()
        .totalThroughputLimit(0)
        .build())
    .backup(AccountBackupArgs.builder()
        .type("string")
        .intervalInMinutes(0)
        .retentionInHours(0)
        .storageRedundancy("string")
        .tier("string")
        .build())
    .corsRule(AccountCorsRuleArgs.builder()
        .allowedHeaders("string")
        .allowedMethods("string")
        .allowedOrigins("string")
        .exposedHeaders("string")
        .maxAgeInSeconds(0)
        .build())
    .createMode("string")
    .defaultIdentityType("string")
    .freeTierEnabled(false)
    .automaticFailoverEnabled(false)
    .identity(AccountIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .ipRangeFilters("string")
    .accessKeyMetadataWritesEnabled(false)
    .keyVaultKeyId("string")
    .kind("string")
    .burstCapacityEnabled(false)
    .location("string")
    .managedHsmKeyId("string")
    .minimalTlsVersion("string")
    .mongoServerVersion("string")
    .multipleWriteLocationsEnabled(false)
    .name("string")
    .networkAclBypassForAzureServices(false)
    .networkAclBypassIds("string")
    .analyticalStorageEnabled(false)
    .partitionMergeEnabled(false)
    .publicNetworkAccessEnabled(false)
    .analyticalStorage(AccountAnalyticalStorageArgs.builder()
        .schemaType("string")
        .build())
    .restore(AccountRestoreArgs.builder()
        .restoreTimestampInUtc("string")
        .sourceCosmosdbAccountId("string")
        .databases(AccountRestoreDatabaseArgs.builder()
            .name("string")
            .collectionNames("string")
            .build())
        .gremlinDatabases(AccountRestoreGremlinDatabaseArgs.builder()
            .name("string")
            .graphNames("string")
            .build())
        .tablesToRestores("string")
        .build())
    .tags(Map.of("string", "string"))
    .virtualNetworkRules(AccountVirtualNetworkRuleArgs.builder()
        .id("string")
        .ignoreMissingVnetServiceEndpoint(false)
        .build())
    .build());
Copy
exampleaccount_resource_resource_from_cosmosdbaccount = azure.cosmosdb.Account("exampleaccountResourceResourceFromCosmosdbaccount",
    consistency_policy={
        "consistency_level": "string",
        "max_interval_in_seconds": 0,
        "max_staleness_prefix": 0,
    },
    resource_group_name="string",
    offer_type="string",
    geo_locations=[{
        "failover_priority": 0,
        "location": "string",
        "id": "string",
        "zone_redundant": False,
    }],
    is_virtual_network_filter_enabled=False,
    local_authentication_disabled=False,
    capabilities=[{
        "name": "string",
    }],
    capacity={
        "total_throughput_limit": 0,
    },
    backup={
        "type": "string",
        "interval_in_minutes": 0,
        "retention_in_hours": 0,
        "storage_redundancy": "string",
        "tier": "string",
    },
    cors_rule={
        "allowed_headers": ["string"],
        "allowed_methods": ["string"],
        "allowed_origins": ["string"],
        "exposed_headers": ["string"],
        "max_age_in_seconds": 0,
    },
    create_mode="string",
    default_identity_type="string",
    free_tier_enabled=False,
    automatic_failover_enabled=False,
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    ip_range_filters=["string"],
    access_key_metadata_writes_enabled=False,
    key_vault_key_id="string",
    kind="string",
    burst_capacity_enabled=False,
    location="string",
    managed_hsm_key_id="string",
    minimal_tls_version="string",
    mongo_server_version="string",
    multiple_write_locations_enabled=False,
    name="string",
    network_acl_bypass_for_azure_services=False,
    network_acl_bypass_ids=["string"],
    analytical_storage_enabled=False,
    partition_merge_enabled=False,
    public_network_access_enabled=False,
    analytical_storage={
        "schema_type": "string",
    },
    restore={
        "restore_timestamp_in_utc": "string",
        "source_cosmosdb_account_id": "string",
        "databases": [{
            "name": "string",
            "collection_names": ["string"],
        }],
        "gremlin_databases": [{
            "name": "string",
            "graph_names": ["string"],
        }],
        "tables_to_restores": ["string"],
    },
    tags={
        "string": "string",
    },
    virtual_network_rules=[{
        "id": "string",
        "ignore_missing_vnet_service_endpoint": False,
    }])
Copy
const exampleaccountResourceResourceFromCosmosdbaccount = new azure.cosmosdb.Account("exampleaccountResourceResourceFromCosmosdbaccount", {
    consistencyPolicy: {
        consistencyLevel: "string",
        maxIntervalInSeconds: 0,
        maxStalenessPrefix: 0,
    },
    resourceGroupName: "string",
    offerType: "string",
    geoLocations: [{
        failoverPriority: 0,
        location: "string",
        id: "string",
        zoneRedundant: false,
    }],
    isVirtualNetworkFilterEnabled: false,
    localAuthenticationDisabled: false,
    capabilities: [{
        name: "string",
    }],
    capacity: {
        totalThroughputLimit: 0,
    },
    backup: {
        type: "string",
        intervalInMinutes: 0,
        retentionInHours: 0,
        storageRedundancy: "string",
        tier: "string",
    },
    corsRule: {
        allowedHeaders: ["string"],
        allowedMethods: ["string"],
        allowedOrigins: ["string"],
        exposedHeaders: ["string"],
        maxAgeInSeconds: 0,
    },
    createMode: "string",
    defaultIdentityType: "string",
    freeTierEnabled: false,
    automaticFailoverEnabled: false,
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    ipRangeFilters: ["string"],
    accessKeyMetadataWritesEnabled: false,
    keyVaultKeyId: "string",
    kind: "string",
    burstCapacityEnabled: false,
    location: "string",
    managedHsmKeyId: "string",
    minimalTlsVersion: "string",
    mongoServerVersion: "string",
    multipleWriteLocationsEnabled: false,
    name: "string",
    networkAclBypassForAzureServices: false,
    networkAclBypassIds: ["string"],
    analyticalStorageEnabled: false,
    partitionMergeEnabled: false,
    publicNetworkAccessEnabled: false,
    analyticalStorage: {
        schemaType: "string",
    },
    restore: {
        restoreTimestampInUtc: "string",
        sourceCosmosdbAccountId: "string",
        databases: [{
            name: "string",
            collectionNames: ["string"],
        }],
        gremlinDatabases: [{
            name: "string",
            graphNames: ["string"],
        }],
        tablesToRestores: ["string"],
    },
    tags: {
        string: "string",
    },
    virtualNetworkRules: [{
        id: "string",
        ignoreMissingVnetServiceEndpoint: false,
    }],
});
Copy
type: azure:cosmosdb:Account
properties:
    accessKeyMetadataWritesEnabled: false
    analyticalStorage:
        schemaType: string
    analyticalStorageEnabled: false
    automaticFailoverEnabled: false
    backup:
        intervalInMinutes: 0
        retentionInHours: 0
        storageRedundancy: string
        tier: string
        type: string
    burstCapacityEnabled: false
    capabilities:
        - name: string
    capacity:
        totalThroughputLimit: 0
    consistencyPolicy:
        consistencyLevel: string
        maxIntervalInSeconds: 0
        maxStalenessPrefix: 0
    corsRule:
        allowedHeaders:
            - string
        allowedMethods:
            - string
        allowedOrigins:
            - string
        exposedHeaders:
            - string
        maxAgeInSeconds: 0
    createMode: string
    defaultIdentityType: string
    freeTierEnabled: false
    geoLocations:
        - failoverPriority: 0
          id: string
          location: string
          zoneRedundant: false
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    ipRangeFilters:
        - string
    isVirtualNetworkFilterEnabled: false
    keyVaultKeyId: string
    kind: string
    localAuthenticationDisabled: false
    location: string
    managedHsmKeyId: string
    minimalTlsVersion: string
    mongoServerVersion: string
    multipleWriteLocationsEnabled: false
    name: string
    networkAclBypassForAzureServices: false
    networkAclBypassIds:
        - string
    offerType: string
    partitionMergeEnabled: false
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    restore:
        databases:
            - collectionNames:
                - string
              name: string
        gremlinDatabases:
            - graphNames:
                - string
              name: string
        restoreTimestampInUtc: string
        sourceCosmosdbAccountId: string
        tablesToRestores:
            - string
    tags:
        string: string
    virtualNetworkRules:
        - id: string
          ignoreMissingVnetServiceEndpoint: false
Copy

Account Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Account resource accepts the following input properties:

ConsistencyPolicy This property is required. AccountConsistencyPolicy
GeoLocations This property is required. List<AccountGeoLocation>
OfferType This property is required. string
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
AnalyticalStorage AccountAnalyticalStorage
An analytical_storage block as defined below.
AnalyticalStorageEnabled bool
AutomaticFailoverEnabled bool
Backup AccountBackup
BurstCapacityEnabled bool
Capabilities List<AccountCapability>
Capacity AccountCapacity
A capacity block as defined below.
CorsRule AccountCorsRule
CreateMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

DefaultIdentityType string
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
FreeTierEnabled Changes to this property will trigger replacement. bool
Identity AccountIdentity
IpRangeFilters List<string>
IsVirtualNetworkFilterEnabled bool
KeyVaultKeyId Changes to this property will trigger replacement. string
Kind Changes to this property will trigger replacement. string
LocalAuthenticationDisabled bool
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
ManagedHsmKeyId Changes to this property will trigger replacement. string
MinimalTlsVersion string

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

MongoServerVersion string
MultipleWriteLocationsEnabled bool
Name Changes to this property will trigger replacement. string
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
NetworkAclBypassForAzureServices bool
NetworkAclBypassIds List<string>
PartitionMergeEnabled bool
PublicNetworkAccessEnabled bool
Restore AccountRestore
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
VirtualNetworkRules List<AccountVirtualNetworkRule>
ConsistencyPolicy This property is required. AccountConsistencyPolicyArgs
GeoLocations This property is required. []AccountGeoLocationArgs
OfferType This property is required. string
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
AnalyticalStorage AccountAnalyticalStorageArgs
An analytical_storage block as defined below.
AnalyticalStorageEnabled bool
AutomaticFailoverEnabled bool
Backup AccountBackupArgs
BurstCapacityEnabled bool
Capabilities []AccountCapabilityArgs
Capacity AccountCapacityArgs
A capacity block as defined below.
CorsRule AccountCorsRuleArgs
CreateMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

DefaultIdentityType string
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
FreeTierEnabled Changes to this property will trigger replacement. bool
Identity AccountIdentityArgs
IpRangeFilters []string
IsVirtualNetworkFilterEnabled bool
KeyVaultKeyId Changes to this property will trigger replacement. string
Kind Changes to this property will trigger replacement. string
LocalAuthenticationDisabled bool
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
ManagedHsmKeyId Changes to this property will trigger replacement. string
MinimalTlsVersion string

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

MongoServerVersion string
MultipleWriteLocationsEnabled bool
Name Changes to this property will trigger replacement. string
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
NetworkAclBypassForAzureServices bool
NetworkAclBypassIds []string
PartitionMergeEnabled bool
PublicNetworkAccessEnabled bool
Restore AccountRestoreArgs
Tags map[string]string
A mapping of tags to assign to the resource.
VirtualNetworkRules []AccountVirtualNetworkRuleArgs
consistencyPolicy This property is required. AccountConsistencyPolicy
geoLocations This property is required. List<AccountGeoLocation>
offerType This property is required. String
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
analyticalStorage AccountAnalyticalStorage
An analytical_storage block as defined below.
analyticalStorageEnabled Boolean
automaticFailoverEnabled Boolean
backup AccountBackup
burstCapacityEnabled Boolean
capabilities List<AccountCapability>
capacity AccountCapacity
A capacity block as defined below.
corsRule AccountCorsRule
createMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

defaultIdentityType String
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
freeTierEnabled Changes to this property will trigger replacement. Boolean
identity AccountIdentity
ipRangeFilters List<String>
isVirtualNetworkFilterEnabled Boolean
keyVaultKeyId Changes to this property will trigger replacement. String
kind Changes to this property will trigger replacement. String
localAuthenticationDisabled Boolean
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managedHsmKeyId Changes to this property will trigger replacement. String
minimalTlsVersion String

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongoServerVersion String
multipleWriteLocationsEnabled Boolean
name Changes to this property will trigger replacement. String
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
networkAclBypassForAzureServices Boolean
networkAclBypassIds List<String>
partitionMergeEnabled Boolean
publicNetworkAccessEnabled Boolean
restore AccountRestore
tags Map<String,String>
A mapping of tags to assign to the resource.
virtualNetworkRules List<AccountVirtualNetworkRule>
consistencyPolicy This property is required. AccountConsistencyPolicy
geoLocations This property is required. AccountGeoLocation[]
offerType This property is required. string
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
analyticalStorage AccountAnalyticalStorage
An analytical_storage block as defined below.
analyticalStorageEnabled boolean
automaticFailoverEnabled boolean
backup AccountBackup
burstCapacityEnabled boolean
capabilities AccountCapability[]
capacity AccountCapacity
A capacity block as defined below.
corsRule AccountCorsRule
createMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

defaultIdentityType string
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
freeTierEnabled Changes to this property will trigger replacement. boolean
identity AccountIdentity
ipRangeFilters string[]
isVirtualNetworkFilterEnabled boolean
keyVaultKeyId Changes to this property will trigger replacement. string
kind Changes to this property will trigger replacement. string
localAuthenticationDisabled boolean
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managedHsmKeyId Changes to this property will trigger replacement. string
minimalTlsVersion string

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongoServerVersion string
multipleWriteLocationsEnabled boolean
name Changes to this property will trigger replacement. string
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
networkAclBypassForAzureServices boolean
networkAclBypassIds string[]
partitionMergeEnabled boolean
publicNetworkAccessEnabled boolean
restore AccountRestore
tags {[key: string]: string}
A mapping of tags to assign to the resource.
virtualNetworkRules AccountVirtualNetworkRule[]
consistency_policy This property is required. AccountConsistencyPolicyArgs
geo_locations This property is required. Sequence[AccountGeoLocationArgs]
offer_type This property is required. str
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
analytical_storage AccountAnalyticalStorageArgs
An analytical_storage block as defined below.
analytical_storage_enabled bool
automatic_failover_enabled bool
backup AccountBackupArgs
burst_capacity_enabled bool
capabilities Sequence[AccountCapabilityArgs]
capacity AccountCapacityArgs
A capacity block as defined below.
cors_rule AccountCorsRuleArgs
create_mode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

default_identity_type str
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
free_tier_enabled Changes to this property will trigger replacement. bool
identity AccountIdentityArgs
ip_range_filters Sequence[str]
is_virtual_network_filter_enabled bool
key_vault_key_id Changes to this property will trigger replacement. str
kind Changes to this property will trigger replacement. str
local_authentication_disabled bool
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managed_hsm_key_id Changes to this property will trigger replacement. str
minimal_tls_version str

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongo_server_version str
multiple_write_locations_enabled bool
name Changes to this property will trigger replacement. str
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
network_acl_bypass_for_azure_services bool
network_acl_bypass_ids Sequence[str]
partition_merge_enabled bool
public_network_access_enabled bool
restore AccountRestoreArgs
tags Mapping[str, str]
A mapping of tags to assign to the resource.
virtual_network_rules Sequence[AccountVirtualNetworkRuleArgs]
consistencyPolicy This property is required. Property Map
geoLocations This property is required. List<Property Map>
offerType This property is required. String
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
analyticalStorage Property Map
An analytical_storage block as defined below.
analyticalStorageEnabled Boolean
automaticFailoverEnabled Boolean
backup Property Map
burstCapacityEnabled Boolean
capabilities List<Property Map>
capacity Property Map
A capacity block as defined below.
corsRule Property Map
createMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

defaultIdentityType String
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
freeTierEnabled Changes to this property will trigger replacement. Boolean
identity Property Map
ipRangeFilters List<String>
isVirtualNetworkFilterEnabled Boolean
keyVaultKeyId Changes to this property will trigger replacement. String
kind Changes to this property will trigger replacement. String
localAuthenticationDisabled Boolean
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managedHsmKeyId Changes to this property will trigger replacement. String
minimalTlsVersion String

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongoServerVersion String
multipleWriteLocationsEnabled Boolean
name Changes to this property will trigger replacement. String
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
networkAclBypassForAzureServices Boolean
networkAclBypassIds List<String>
partitionMergeEnabled Boolean
publicNetworkAccessEnabled Boolean
restore Property Map
tags Map<String>
A mapping of tags to assign to the resource.
virtualNetworkRules List<Property Map>

Outputs

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

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.
PrimaryMongodbConnectionString string
Primary Mongodb connection string for the CosmosDB Account.
PrimaryReadonlyKey string
The Primary read-only Key for the CosmosDB Account.
PrimaryReadonlyMongodbConnectionString string
Primary readonly Mongodb connection string for the CosmosDB Account.
PrimaryReadonlySqlConnectionString string
Primary readonly SQL connection string for the CosmosDB Account.
PrimarySqlConnectionString string
Primary SQL connection string for the CosmosDB Account.
ReadEndpoints List<string>
A list of read endpoints available for this CosmosDB account.
SecondaryKey string
The Secondary key for the CosmosDB Account.
SecondaryMongodbConnectionString string
Secondary Mongodb connection string for the CosmosDB Account.
SecondaryReadonlyKey string
The Secondary read-only key for the CosmosDB Account.
SecondaryReadonlyMongodbConnectionString string
Secondary readonly Mongodb connection string for the CosmosDB Account.
SecondaryReadonlySqlConnectionString string
Secondary readonly SQL connection string for the CosmosDB Account.
SecondarySqlConnectionString string
Secondary SQL connection string for the CosmosDB Account.
WriteEndpoints List<string>
A list of write endpoints 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.
PrimaryMongodbConnectionString string
Primary Mongodb connection string for the CosmosDB Account.
PrimaryReadonlyKey string
The Primary read-only Key for the CosmosDB Account.
PrimaryReadonlyMongodbConnectionString string
Primary readonly Mongodb connection string for the CosmosDB Account.
PrimaryReadonlySqlConnectionString string
Primary readonly SQL connection string for the CosmosDB Account.
PrimarySqlConnectionString string
Primary SQL connection string for the CosmosDB Account.
ReadEndpoints []string
A list of read endpoints available for this CosmosDB account.
SecondaryKey string
The Secondary key for the CosmosDB Account.
SecondaryMongodbConnectionString string
Secondary Mongodb connection string for the CosmosDB Account.
SecondaryReadonlyKey string
The Secondary read-only key for the CosmosDB Account.
SecondaryReadonlyMongodbConnectionString string
Secondary readonly Mongodb connection string for the CosmosDB Account.
SecondaryReadonlySqlConnectionString string
Secondary readonly SQL connection string for the CosmosDB Account.
SecondarySqlConnectionString string
Secondary SQL connection string for the CosmosDB Account.
WriteEndpoints []string
A list of write endpoints 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.
primaryMongodbConnectionString String
Primary Mongodb connection string for the CosmosDB Account.
primaryReadonlyKey String
The Primary read-only Key for the CosmosDB Account.
primaryReadonlyMongodbConnectionString String
Primary readonly Mongodb connection string for the CosmosDB Account.
primaryReadonlySqlConnectionString String
Primary readonly SQL connection string for the CosmosDB Account.
primarySqlConnectionString String
Primary SQL connection string for the CosmosDB Account.
readEndpoints List<String>
A list of read endpoints available for this CosmosDB account.
secondaryKey String
The Secondary key for the CosmosDB Account.
secondaryMongodbConnectionString String
Secondary Mongodb connection string for the CosmosDB Account.
secondaryReadonlyKey String
The Secondary read-only key for the CosmosDB Account.
secondaryReadonlyMongodbConnectionString String
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondaryReadonlySqlConnectionString String
Secondary readonly SQL connection string for the CosmosDB Account.
secondarySqlConnectionString String
Secondary SQL connection string for the CosmosDB Account.
writeEndpoints List<String>
A list of write endpoints 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.
primaryMongodbConnectionString string
Primary Mongodb connection string for the CosmosDB Account.
primaryReadonlyKey string
The Primary read-only Key for the CosmosDB Account.
primaryReadonlyMongodbConnectionString string
Primary readonly Mongodb connection string for the CosmosDB Account.
primaryReadonlySqlConnectionString string
Primary readonly SQL connection string for the CosmosDB Account.
primarySqlConnectionString string
Primary SQL connection string for the CosmosDB Account.
readEndpoints string[]
A list of read endpoints available for this CosmosDB account.
secondaryKey string
The Secondary key for the CosmosDB Account.
secondaryMongodbConnectionString string
Secondary Mongodb connection string for the CosmosDB Account.
secondaryReadonlyKey string
The Secondary read-only key for the CosmosDB Account.
secondaryReadonlyMongodbConnectionString string
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondaryReadonlySqlConnectionString string
Secondary readonly SQL connection string for the CosmosDB Account.
secondarySqlConnectionString string
Secondary SQL connection string for the CosmosDB Account.
writeEndpoints string[]
A list of write endpoints 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_mongodb_connection_string str
Primary Mongodb connection string for the CosmosDB Account.
primary_readonly_key str
The Primary read-only Key for the CosmosDB Account.
primary_readonly_mongodb_connection_string str
Primary readonly Mongodb connection string for the CosmosDB Account.
primary_readonly_sql_connection_string str
Primary readonly SQL connection string for the CosmosDB Account.
primary_sql_connection_string str
Primary SQL connection string for the CosmosDB Account.
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_mongodb_connection_string str
Secondary Mongodb connection string for the CosmosDB Account.
secondary_readonly_key str
The Secondary read-only key for the CosmosDB Account.
secondary_readonly_mongodb_connection_string str
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondary_readonly_sql_connection_string str
Secondary readonly SQL connection string for the CosmosDB Account.
secondary_sql_connection_string str
Secondary SQL connection string for the CosmosDB Account.
write_endpoints Sequence[str]
A list of write endpoints 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.
primaryMongodbConnectionString String
Primary Mongodb connection string for the CosmosDB Account.
primaryReadonlyKey String
The Primary read-only Key for the CosmosDB Account.
primaryReadonlyMongodbConnectionString String
Primary readonly Mongodb connection string for the CosmosDB Account.
primaryReadonlySqlConnectionString String
Primary readonly SQL connection string for the CosmosDB Account.
primarySqlConnectionString String
Primary SQL connection string for the CosmosDB Account.
readEndpoints List<String>
A list of read endpoints available for this CosmosDB account.
secondaryKey String
The Secondary key for the CosmosDB Account.
secondaryMongodbConnectionString String
Secondary Mongodb connection string for the CosmosDB Account.
secondaryReadonlyKey String
The Secondary read-only key for the CosmosDB Account.
secondaryReadonlyMongodbConnectionString String
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondaryReadonlySqlConnectionString String
Secondary readonly SQL connection string for the CosmosDB Account.
secondarySqlConnectionString String
Secondary SQL connection string for the CosmosDB Account.
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,
        automatic_failover_enabled: Optional[bool] = None,
        backup: Optional[AccountBackupArgs] = None,
        burst_capacity_enabled: Optional[bool] = 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,
        endpoint: Optional[str] = None,
        free_tier_enabled: Optional[bool] = None,
        geo_locations: Optional[Sequence[AccountGeoLocationArgs]] = None,
        identity: Optional[AccountIdentityArgs] = None,
        ip_range_filters: Optional[Sequence[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,
        managed_hsm_key_id: Optional[str] = None,
        minimal_tls_version: Optional[str] = None,
        mongo_server_version: Optional[str] = None,
        multiple_write_locations_enabled: Optional[bool] = 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,
        partition_merge_enabled: Optional[bool] = None,
        primary_key: Optional[str] = None,
        primary_mongodb_connection_string: Optional[str] = None,
        primary_readonly_key: Optional[str] = None,
        primary_readonly_mongodb_connection_string: 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_mongodb_connection_string: Optional[str] = None,
        secondary_readonly_key: Optional[str] = None,
        secondary_readonly_mongodb_connection_string: 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)
resources:  _:    type: azure:cosmosdb:Account    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
AnalyticalStorage AccountAnalyticalStorage
An analytical_storage block as defined below.
AnalyticalStorageEnabled bool
AutomaticFailoverEnabled bool
Backup AccountBackup
BurstCapacityEnabled bool
Capabilities List<AccountCapability>
Capacity AccountCapacity
A capacity block as defined below.
ConsistencyPolicy AccountConsistencyPolicy
CorsRule AccountCorsRule
CreateMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

DefaultIdentityType string
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
Endpoint string
The endpoint used to connect to the CosmosDB account.
FreeTierEnabled Changes to this property will trigger replacement. bool
GeoLocations List<AccountGeoLocation>
Identity AccountIdentity
IpRangeFilters List<string>
IsVirtualNetworkFilterEnabled bool
KeyVaultKeyId Changes to this property will trigger replacement. string
Kind Changes to this property will trigger replacement. string
LocalAuthenticationDisabled bool
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
ManagedHsmKeyId Changes to this property will trigger replacement. string
MinimalTlsVersion string

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

MongoServerVersion string
MultipleWriteLocationsEnabled bool
Name Changes to this property will trigger replacement. string
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
NetworkAclBypassForAzureServices bool
NetworkAclBypassIds List<string>
OfferType string
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
PartitionMergeEnabled bool
PrimaryKey string
The Primary key for the CosmosDB Account.
PrimaryMongodbConnectionString string
Primary Mongodb connection string for the CosmosDB Account.
PrimaryReadonlyKey string
The Primary read-only Key for the CosmosDB Account.
PrimaryReadonlyMongodbConnectionString string
Primary readonly Mongodb connection string for the CosmosDB Account.
PrimaryReadonlySqlConnectionString string
Primary readonly SQL connection string for the CosmosDB Account.
PrimarySqlConnectionString string
Primary SQL connection string for the CosmosDB Account.
PublicNetworkAccessEnabled bool
ReadEndpoints List<string>
A list of read endpoints available for this CosmosDB account.
ResourceGroupName Changes to this property will trigger replacement. 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
SecondaryKey string
The Secondary key for the CosmosDB Account.
SecondaryMongodbConnectionString string
Secondary Mongodb connection string for the CosmosDB Account.
SecondaryReadonlyKey string
The Secondary read-only key for the CosmosDB Account.
SecondaryReadonlyMongodbConnectionString string
Secondary readonly Mongodb connection string for the CosmosDB Account.
SecondaryReadonlySqlConnectionString string
Secondary readonly SQL connection string for the CosmosDB Account.
SecondarySqlConnectionString string
Secondary SQL connection string for the CosmosDB Account.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
VirtualNetworkRules List<AccountVirtualNetworkRule>
WriteEndpoints List<string>
A list of write endpoints available for this CosmosDB account.
AccessKeyMetadataWritesEnabled bool
AnalyticalStorage AccountAnalyticalStorageArgs
An analytical_storage block as defined below.
AnalyticalStorageEnabled bool
AutomaticFailoverEnabled bool
Backup AccountBackupArgs
BurstCapacityEnabled bool
Capabilities []AccountCapabilityArgs
Capacity AccountCapacityArgs
A capacity block as defined below.
ConsistencyPolicy AccountConsistencyPolicyArgs
CorsRule AccountCorsRuleArgs
CreateMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

DefaultIdentityType string
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
Endpoint string
The endpoint used to connect to the CosmosDB account.
FreeTierEnabled Changes to this property will trigger replacement. bool
GeoLocations []AccountGeoLocationArgs
Identity AccountIdentityArgs
IpRangeFilters []string
IsVirtualNetworkFilterEnabled bool
KeyVaultKeyId Changes to this property will trigger replacement. string
Kind Changes to this property will trigger replacement. string
LocalAuthenticationDisabled bool
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
ManagedHsmKeyId Changes to this property will trigger replacement. string
MinimalTlsVersion string

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

MongoServerVersion string
MultipleWriteLocationsEnabled bool
Name Changes to this property will trigger replacement. string
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
NetworkAclBypassForAzureServices bool
NetworkAclBypassIds []string
OfferType string
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
PartitionMergeEnabled bool
PrimaryKey string
The Primary key for the CosmosDB Account.
PrimaryMongodbConnectionString string
Primary Mongodb connection string for the CosmosDB Account.
PrimaryReadonlyKey string
The Primary read-only Key for the CosmosDB Account.
PrimaryReadonlyMongodbConnectionString string
Primary readonly Mongodb connection string for the CosmosDB Account.
PrimaryReadonlySqlConnectionString string
Primary readonly SQL connection string for the CosmosDB Account.
PrimarySqlConnectionString string
Primary SQL connection string for the CosmosDB Account.
PublicNetworkAccessEnabled bool
ReadEndpoints []string
A list of read endpoints available for this CosmosDB account.
ResourceGroupName Changes to this property will trigger replacement. 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
SecondaryKey string
The Secondary key for the CosmosDB Account.
SecondaryMongodbConnectionString string
Secondary Mongodb connection string for the CosmosDB Account.
SecondaryReadonlyKey string
The Secondary read-only key for the CosmosDB Account.
SecondaryReadonlyMongodbConnectionString string
Secondary readonly Mongodb connection string for the CosmosDB Account.
SecondaryReadonlySqlConnectionString string
Secondary readonly SQL connection string for the CosmosDB Account.
SecondarySqlConnectionString string
Secondary SQL connection string for the CosmosDB Account.
Tags map[string]string
A mapping of tags to assign to the resource.
VirtualNetworkRules []AccountVirtualNetworkRuleArgs
WriteEndpoints []string
A list of write endpoints available for this CosmosDB account.
accessKeyMetadataWritesEnabled Boolean
analyticalStorage AccountAnalyticalStorage
An analytical_storage block as defined below.
analyticalStorageEnabled Boolean
automaticFailoverEnabled Boolean
backup AccountBackup
burstCapacityEnabled Boolean
capabilities List<AccountCapability>
capacity AccountCapacity
A capacity block as defined below.
consistencyPolicy AccountConsistencyPolicy
corsRule AccountCorsRule
createMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

defaultIdentityType String
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
endpoint String
The endpoint used to connect to the CosmosDB account.
freeTierEnabled Changes to this property will trigger replacement. Boolean
geoLocations List<AccountGeoLocation>
identity AccountIdentity
ipRangeFilters List<String>
isVirtualNetworkFilterEnabled Boolean
keyVaultKeyId Changes to this property will trigger replacement. String
kind Changes to this property will trigger replacement. String
localAuthenticationDisabled Boolean
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managedHsmKeyId Changes to this property will trigger replacement. String
minimalTlsVersion String

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongoServerVersion String
multipleWriteLocationsEnabled Boolean
name Changes to this property will trigger replacement. String
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
networkAclBypassForAzureServices Boolean
networkAclBypassIds List<String>
offerType String
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
partitionMergeEnabled Boolean
primaryKey String
The Primary key for the CosmosDB Account.
primaryMongodbConnectionString String
Primary Mongodb connection string for the CosmosDB Account.
primaryReadonlyKey String
The Primary read-only Key for the CosmosDB Account.
primaryReadonlyMongodbConnectionString String
Primary readonly Mongodb connection string for the CosmosDB Account.
primaryReadonlySqlConnectionString String
Primary readonly SQL connection string for the CosmosDB Account.
primarySqlConnectionString String
Primary SQL connection string for the CosmosDB Account.
publicNetworkAccessEnabled Boolean
readEndpoints List<String>
A list of read endpoints available for this CosmosDB account.
resourceGroupName Changes to this property will trigger replacement. 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
secondaryKey String
The Secondary key for the CosmosDB Account.
secondaryMongodbConnectionString String
Secondary Mongodb connection string for the CosmosDB Account.
secondaryReadonlyKey String
The Secondary read-only key for the CosmosDB Account.
secondaryReadonlyMongodbConnectionString String
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondaryReadonlySqlConnectionString String
Secondary readonly SQL connection string for the CosmosDB Account.
secondarySqlConnectionString String
Secondary SQL connection string for the CosmosDB Account.
tags Map<String,String>
A mapping of tags to assign to the resource.
virtualNetworkRules List<AccountVirtualNetworkRule>
writeEndpoints List<String>
A list of write endpoints available for this CosmosDB account.
accessKeyMetadataWritesEnabled boolean
analyticalStorage AccountAnalyticalStorage
An analytical_storage block as defined below.
analyticalStorageEnabled boolean
automaticFailoverEnabled boolean
backup AccountBackup
burstCapacityEnabled boolean
capabilities AccountCapability[]
capacity AccountCapacity
A capacity block as defined below.
consistencyPolicy AccountConsistencyPolicy
corsRule AccountCorsRule
createMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

defaultIdentityType string
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
endpoint string
The endpoint used to connect to the CosmosDB account.
freeTierEnabled Changes to this property will trigger replacement. boolean
geoLocations AccountGeoLocation[]
identity AccountIdentity
ipRangeFilters string[]
isVirtualNetworkFilterEnabled boolean
keyVaultKeyId Changes to this property will trigger replacement. string
kind Changes to this property will trigger replacement. string
localAuthenticationDisabled boolean
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managedHsmKeyId Changes to this property will trigger replacement. string
minimalTlsVersion string

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongoServerVersion string
multipleWriteLocationsEnabled boolean
name Changes to this property will trigger replacement. string
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
networkAclBypassForAzureServices boolean
networkAclBypassIds string[]
offerType string
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
partitionMergeEnabled boolean
primaryKey string
The Primary key for the CosmosDB Account.
primaryMongodbConnectionString string
Primary Mongodb connection string for the CosmosDB Account.
primaryReadonlyKey string
The Primary read-only Key for the CosmosDB Account.
primaryReadonlyMongodbConnectionString string
Primary readonly Mongodb connection string for the CosmosDB Account.
primaryReadonlySqlConnectionString string
Primary readonly SQL connection string for the CosmosDB Account.
primarySqlConnectionString string
Primary SQL connection string for the CosmosDB Account.
publicNetworkAccessEnabled boolean
readEndpoints string[]
A list of read endpoints available for this CosmosDB account.
resourceGroupName Changes to this property will trigger replacement. 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
secondaryKey string
The Secondary key for the CosmosDB Account.
secondaryMongodbConnectionString string
Secondary Mongodb connection string for the CosmosDB Account.
secondaryReadonlyKey string
The Secondary read-only key for the CosmosDB Account.
secondaryReadonlyMongodbConnectionString string
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondaryReadonlySqlConnectionString string
Secondary readonly SQL connection string for the CosmosDB Account.
secondarySqlConnectionString string
Secondary SQL connection string for the CosmosDB Account.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
virtualNetworkRules AccountVirtualNetworkRule[]
writeEndpoints string[]
A list of write endpoints available for this CosmosDB account.
access_key_metadata_writes_enabled bool
analytical_storage AccountAnalyticalStorageArgs
An analytical_storage block as defined below.
analytical_storage_enabled bool
automatic_failover_enabled bool
backup AccountBackupArgs
burst_capacity_enabled bool
capabilities Sequence[AccountCapabilityArgs]
capacity AccountCapacityArgs
A capacity block as defined below.
consistency_policy AccountConsistencyPolicyArgs
cors_rule AccountCorsRuleArgs
create_mode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

default_identity_type str
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
endpoint str
The endpoint used to connect to the CosmosDB account.
free_tier_enabled Changes to this property will trigger replacement. bool
geo_locations Sequence[AccountGeoLocationArgs]
identity AccountIdentityArgs
ip_range_filters Sequence[str]
is_virtual_network_filter_enabled bool
key_vault_key_id Changes to this property will trigger replacement. str
kind Changes to this property will trigger replacement. str
local_authentication_disabled bool
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managed_hsm_key_id Changes to this property will trigger replacement. str
minimal_tls_version str

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongo_server_version str
multiple_write_locations_enabled bool
name Changes to this property will trigger replacement. str
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
network_acl_bypass_for_azure_services bool
network_acl_bypass_ids Sequence[str]
offer_type str
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
partition_merge_enabled bool
primary_key str
The Primary key for the CosmosDB Account.
primary_mongodb_connection_string str
Primary Mongodb connection string for the CosmosDB Account.
primary_readonly_key str
The Primary read-only Key for the CosmosDB Account.
primary_readonly_mongodb_connection_string str
Primary readonly Mongodb connection string for the CosmosDB Account.
primary_readonly_sql_connection_string str
Primary readonly SQL connection string for the CosmosDB Account.
primary_sql_connection_string str
Primary SQL connection string for the CosmosDB Account.
public_network_access_enabled bool
read_endpoints Sequence[str]
A list of read endpoints available for this CosmosDB account.
resource_group_name Changes to this property will trigger replacement. 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
secondary_key str
The Secondary key for the CosmosDB Account.
secondary_mongodb_connection_string str
Secondary Mongodb connection string for the CosmosDB Account.
secondary_readonly_key str
The Secondary read-only key for the CosmosDB Account.
secondary_readonly_mongodb_connection_string str
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondary_readonly_sql_connection_string str
Secondary readonly SQL connection string for the CosmosDB Account.
secondary_sql_connection_string str
Secondary SQL connection string for the CosmosDB Account.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
virtual_network_rules Sequence[AccountVirtualNetworkRuleArgs]
write_endpoints Sequence[str]
A list of write endpoints available for this CosmosDB account.
accessKeyMetadataWritesEnabled Boolean
analyticalStorage Property Map
An analytical_storage block as defined below.
analyticalStorageEnabled Boolean
automaticFailoverEnabled Boolean
backup Property Map
burstCapacityEnabled Boolean
capabilities List<Property Map>
capacity Property Map
A capacity block as defined below.
consistencyPolicy Property Map
corsRule Property Map
createMode Changes to this property will trigger replacement. 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 can only be defined when the backup.type is set to Continuous.

defaultIdentityType String
The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or UserAssignedIdentity. Defaults to FirstPartyIdentity.
endpoint String
The endpoint used to connect to the CosmosDB account.
freeTierEnabled Changes to this property will trigger replacement. Boolean
geoLocations List<Property Map>
identity Property Map
ipRangeFilters List<String>
isVirtualNetworkFilterEnabled Boolean
keyVaultKeyId Changes to this property will trigger replacement. String
kind Changes to this property will trigger replacement. String
localAuthenticationDisabled Boolean
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managedHsmKeyId Changes to this property will trigger replacement. String
minimalTlsVersion String

Specifies the minimal TLS version for the CosmosDB account. Possible values are: Tls, Tls11, and Tls12. Defaults to Tls12.

Note Azure Services will require TLS 1.2+ by August 2025, please see this announcement for more details.

mongoServerVersion String
multipleWriteLocationsEnabled Boolean
name Changes to this property will trigger replacement. String
Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
networkAclBypassForAzureServices Boolean
networkAclBypassIds List<String>
offerType String
Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard.
partitionMergeEnabled Boolean
primaryKey String
The Primary key for the CosmosDB Account.
primaryMongodbConnectionString String
Primary Mongodb connection string for the CosmosDB Account.
primaryReadonlyKey String
The Primary read-only Key for the CosmosDB Account.
primaryReadonlyMongodbConnectionString String
Primary readonly Mongodb connection string for the CosmosDB Account.
primaryReadonlySqlConnectionString String
Primary readonly SQL connection string for the CosmosDB Account.
primarySqlConnectionString String
Primary SQL connection string for the CosmosDB Account.
publicNetworkAccessEnabled Boolean
readEndpoints List<String>
A list of read endpoints available for this CosmosDB account.
resourceGroupName Changes to this property will trigger replacement. 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
secondaryKey String
The Secondary key for the CosmosDB Account.
secondaryMongodbConnectionString String
Secondary Mongodb connection string for the CosmosDB Account.
secondaryReadonlyKey String
The Secondary read-only key for the CosmosDB Account.
secondaryReadonlyMongodbConnectionString String
Secondary readonly Mongodb connection string for the CosmosDB Account.
secondaryReadonlySqlConnectionString String
Secondary readonly SQL connection string for the CosmosDB Account.
secondarySqlConnectionString String
Secondary SQL connection string for the CosmosDB Account.
tags Map<String>
A mapping of tags to assign to the resource.
virtualNetworkRules List<Property Map>
writeEndpoints List<String>
A list of write endpoints available for this CosmosDB account.

Supporting Types

AccountAnalyticalStorage
, AccountAnalyticalStorageArgs

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

AccountBackup
, AccountBackupArgs

Type This property is required. string

The type of the backup. Possible values are Continuous and Periodic.

Note: 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. Possible values are between 60 and 1440. Defaults to 240.
RetentionInHours int
The time in hours that each backup is retained. Possible values are between 8 and 720. Defaults to 8.
StorageRedundancy string

The storage redundancy is used to indicate the type of backup residency. Possible values are Geo, Local and Zone. Defaults to Geo.

Note: You can only configure interval_in_minutes, retention_in_hours and storage_redundancy when the type field is set to Periodic.

Tier string
The continuous backup tier. Possible values are Continuous7Days and Continuous30Days.
Type This property is required. string

The type of the backup. Possible values are Continuous and Periodic.

Note: 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. Possible values are between 60 and 1440. Defaults to 240.
RetentionInHours int
The time in hours that each backup is retained. Possible values are between 8 and 720. Defaults to 8.
StorageRedundancy string

The storage redundancy is used to indicate the type of backup residency. Possible values are Geo, Local and Zone. Defaults to Geo.

Note: You can only configure interval_in_minutes, retention_in_hours and storage_redundancy when the type field is set to Periodic.

Tier string
The continuous backup tier. Possible values are Continuous7Days and Continuous30Days.
type This property is required. String

The type of the backup. Possible values are Continuous and Periodic.

Note: 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. Possible values are between 60 and 1440. Defaults to 240.
retentionInHours Integer
The time in hours that each backup is retained. Possible values are between 8 and 720. Defaults to 8.
storageRedundancy String

The storage redundancy is used to indicate the type of backup residency. Possible values are Geo, Local and Zone. Defaults to Geo.

Note: You can only configure interval_in_minutes, retention_in_hours and storage_redundancy when the type field is set to Periodic.

tier String
The continuous backup tier. Possible values are Continuous7Days and Continuous30Days.
type This property is required. string

The type of the backup. Possible values are Continuous and Periodic.

Note: 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. Possible values are between 60 and 1440. Defaults to 240.
retentionInHours number
The time in hours that each backup is retained. Possible values are between 8 and 720. Defaults to 8.
storageRedundancy string

The storage redundancy is used to indicate the type of backup residency. Possible values are Geo, Local and Zone. Defaults to Geo.

Note: You can only configure interval_in_minutes, retention_in_hours and storage_redundancy when the type field is set to Periodic.

tier string
The continuous backup tier. Possible values are Continuous7Days and Continuous30Days.
type This property is required. str

The type of the backup. Possible values are Continuous and Periodic.

Note: 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. Possible values are between 60 and 1440. Defaults to 240.
retention_in_hours int
The time in hours that each backup is retained. Possible values are between 8 and 720. Defaults to 8.
storage_redundancy str

The storage redundancy is used to indicate the type of backup residency. Possible values are Geo, Local and Zone. Defaults to Geo.

Note: You can only configure interval_in_minutes, retention_in_hours and storage_redundancy when the type field is set to Periodic.

tier str
The continuous backup tier. Possible values are Continuous7Days and Continuous30Days.
type This property is required. String

The type of the backup. Possible values are Continuous and Periodic.

Note: 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. Possible values are between 60 and 1440. Defaults to 240.
retentionInHours Number
The time in hours that each backup is retained. Possible values are between 8 and 720. Defaults to 8.
storageRedundancy String

The storage redundancy is used to indicate the type of backup residency. Possible values are Geo, Local and Zone. Defaults to Geo.

Note: You can only configure interval_in_minutes, retention_in_hours and storage_redundancy when the type field is set to Periodic.

tier String
The continuous backup tier. Possible values are Continuous7Days and Continuous30Days.

AccountCapability
, AccountCapabilityArgs

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

AccountCapacity
, AccountCapacityArgs

TotalThroughputLimit This property is required. int
The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
TotalThroughputLimit This property is required. int
The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
totalThroughputLimit This property is required. Integer
The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
totalThroughputLimit This property is required. 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 This property is required. int
The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit.
totalThroughputLimit This property is required. 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 This property is required. 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 10 – 2147483647. 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 values other than default when the consistency_level is set to BoundedStaleness.

ConsistencyLevel This property is required. 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 10 – 2147483647. 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 values other than default when the consistency_level is set to BoundedStaleness.

consistencyLevel This property is required. 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 10 – 2147483647. 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 values other than default when the consistency_level is set to BoundedStaleness.

consistencyLevel This property is required. 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 10 – 2147483647. 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 values other than default when the consistency_level is set to BoundedStaleness.

consistency_level This property is required. 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 10 – 2147483647. 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 values other than default when the consistency_level is set to BoundedStaleness.

consistencyLevel This property is required. 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 10 – 2147483647. 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 values other than default when the consistency_level is set to BoundedStaleness.

AccountCorsRule
, AccountCorsRuleArgs

AllowedHeaders This property is required. List<string>
A list of headers that are allowed to be a part of the cross-origin request.
AllowedMethods This property is required. 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 This property is required. List<string>
A list of origin domains that will be allowed by CORS.
ExposedHeaders This property is required. 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 This property is required. []string
A list of headers that are allowed to be a part of the cross-origin request.
AllowedMethods This property is required. []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 This property is required. []string
A list of origin domains that will be allowed by CORS.
ExposedHeaders This property is required. []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 This property is required. List<String>
A list of headers that are allowed to be a part of the cross-origin request.
allowedMethods This property is required. 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 This property is required. List<String>
A list of origin domains that will be allowed by CORS.
exposedHeaders This property is required. 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 This property is required. string[]
A list of headers that are allowed to be a part of the cross-origin request.
allowedMethods This property is required. 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 This property is required. string[]
A list of origin domains that will be allowed by CORS.
exposedHeaders This property is required. 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 This property is required. Sequence[str]
A list of headers that are allowed to be a part of the cross-origin request.
allowed_methods This property is required. 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 This property is required. Sequence[str]
A list of origin domains that will be allowed by CORS.
exposed_headers This property is required. 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 This property is required. List<String>
A list of headers that are allowed to be a part of the cross-origin request.
allowedMethods This property is required. 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 This property is required. List<String>
A list of origin domains that will be allowed by CORS.
exposedHeaders This property is required. 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 This property is required. 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 This property is required. string
The name of the Azure region to host replicated data.
Id string
The CosmosDB Account ID.
ZoneRedundant bool
Should zone redundancy be enabled for this region? Defaults to false.
FailoverPriority This property is required. 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 This property is required. string
The name of the Azure region to host replicated data.
Id string
The CosmosDB Account ID.
ZoneRedundant bool
Should zone redundancy be enabled for this region? Defaults to false.
failoverPriority This property is required. 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 This property is required. String
The name of the Azure region to host replicated data.
id String
The CosmosDB Account ID.
zoneRedundant Boolean
Should zone redundancy be enabled for this region? Defaults to false.
failoverPriority This property is required. 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 This property is required. string
The name of the Azure region to host replicated data.
id string
The CosmosDB Account ID.
zoneRedundant boolean
Should zone redundancy be enabled for this region? Defaults to false.
failover_priority This property is required. 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 This property is required. str
The name of the Azure region to host replicated data.
id str
The CosmosDB Account ID.
zone_redundant bool
Should zone redundancy be enabled for this region? Defaults to false.
failoverPriority This property is required. 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 This property is required. String
The name of the Azure region to host replicated data.
id String
The CosmosDB Account ID.
zoneRedundant Boolean
Should zone redundancy be enabled for this region? Defaults to false.

AccountIdentity
, AccountIdentityArgs

Type This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
SourceCosmosdbAccountId
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. List<AccountRestoreDatabase>
A database block as defined below. Changing this forces a new resource to be created.
GremlinDatabases Changes to this property will trigger replacement. List<AccountRestoreGremlinDatabase>
One or more gremlin_database blocks as defined below. Changing this forces a new resource to be created.
TablesToRestores Changes to this property will trigger replacement. List<string>
A list of specific tables available for restore. Changing this forces a new resource to be created.
RestoreTimestampInUtc
This property is required.
Changes to this property will trigger replacement.
string
The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
SourceCosmosdbAccountId
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. []AccountRestoreDatabase
A database block as defined below. Changing this forces a new resource to be created.
GremlinDatabases Changes to this property will trigger replacement. []AccountRestoreGremlinDatabase
One or more gremlin_database blocks as defined below. Changing this forces a new resource to be created.
TablesToRestores Changes to this property will trigger replacement. []string
A list of specific tables available for restore. Changing this forces a new resource to be created.
restoreTimestampInUtc
This property is required.
Changes to this property will trigger replacement.
String
The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
sourceCosmosdbAccountId
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. List<AccountRestoreDatabase>
A database block as defined below. Changing this forces a new resource to be created.
gremlinDatabases Changes to this property will trigger replacement. List<AccountRestoreGremlinDatabase>
One or more gremlin_database blocks as defined below. Changing this forces a new resource to be created.
tablesToRestores Changes to this property will trigger replacement. List<String>
A list of specific tables available for restore. Changing this forces a new resource to be created.
restoreTimestampInUtc
This property is required.
Changes to this property will trigger replacement.
string
The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
sourceCosmosdbAccountId
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. AccountRestoreDatabase[]
A database block as defined below. Changing this forces a new resource to be created.
gremlinDatabases Changes to this property will trigger replacement. AccountRestoreGremlinDatabase[]
One or more gremlin_database blocks as defined below. Changing this forces a new resource to be created.
tablesToRestores Changes to this property will trigger replacement. string[]
A list of specific tables available for restore. Changing this forces a new resource to be created.
restore_timestamp_in_utc
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. Sequence[AccountRestoreDatabase]
A database block as defined below. Changing this forces a new resource to be created.
gremlin_databases Changes to this property will trigger replacement. Sequence[AccountRestoreGremlinDatabase]
One or more gremlin_database blocks as defined below. Changing this forces a new resource to be created.
tables_to_restores Changes to this property will trigger replacement. Sequence[str]
A list of specific tables available for restore. Changing this forces a new resource to be created.
restoreTimestampInUtc
This property is required.
Changes to this property will trigger replacement.
String
The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created.
sourceCosmosdbAccountId
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. List<Property Map>
A database block as defined below. Changing this forces a new resource to be created.
gremlinDatabases Changes to this property will trigger replacement. List<Property Map>
One or more gremlin_database blocks as defined below. Changing this forces a new resource to be created.
tablesToRestores Changes to this property will trigger replacement. List<String>
A list of specific tables available for restore. Changing this forces a new resource to be created.

AccountRestoreDatabase
, AccountRestoreDatabaseArgs

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

AccountRestoreGremlinDatabase
, AccountRestoreGremlinDatabaseArgs

Name
This property is required.
Changes to this property will trigger replacement.
string
The Gremlin Database name for the restore request. Changing this forces a new resource to be created.
GraphNames Changes to this property will trigger replacement. List<string>
A list of the Graph names for the restore request. Changing this forces a new resource to be created.
Name
This property is required.
Changes to this property will trigger replacement.
string
The Gremlin Database name for the restore request. Changing this forces a new resource to be created.
GraphNames Changes to this property will trigger replacement. []string
A list of the Graph names for the restore request. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
String
The Gremlin Database name for the restore request. Changing this forces a new resource to be created.
graphNames Changes to this property will trigger replacement. List<String>
A list of the Graph names for the restore request. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
string
The Gremlin Database name for the restore request. Changing this forces a new resource to be created.
graphNames Changes to this property will trigger replacement. string[]
A list of the Graph names for the restore request. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
str
The Gremlin Database name for the restore request. Changing this forces a new resource to be created.
graph_names Changes to this property will trigger replacement. Sequence[str]
A list of the Graph names for the restore request. Changing this forces a new resource to be created.
name
This property is required.
Changes to this property will trigger replacement.
String
The Gremlin Database name for the restore request. Changing this forces a new resource to be created.
graphNames Changes to this property will trigger replacement. List<String>
A list of the Graph names for the restore request. Changing this forces a new resource to be created.

AccountVirtualNetworkRule
, AccountVirtualNetworkRuleArgs

Id This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure