Account

Manages a CosmosDB (formally DocumentDB) Account.

Create a Account Resource

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);

def Account(resource_name, opts=None, capabilities=None, consistency_policy=None, enable_automatic_failover=None, enable_multiple_write_locations=None, geo_locations=None, ip_range_filter=None, is_virtual_network_filter_enabled=None, kind=None, location=None, name=None, offer_type=None, resource_group_name=None, tags=None, virtual_network_rules=None, __props__=None);

func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)

public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AccountArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AccountArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccountArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Account Resource Properties

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

Inputs

The Account resource accepts the following input properties:

ConsistencyPolicy AccountConsistencyPolicyArgs: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
GeoLocations List<AccountGeoLocationArgs>: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
OfferType string: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
ResourceGroupName string: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
Capabilities List<AccountCapabilityArgs>: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
EnableAutomaticFailover bool: Enable automatic fail over for this Cosmos DB account.
EnableMultipleWriteLocations bool: Enable multi-master support for this Cosmos DB account.
IpRangeFilter string: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IsVirtualNetworkFilterEnabled bool: Enables virtual network filtering for this Cosmos DB account.
Kind string: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VirtualNetworkRules List<AccountVirtualNetworkRuleArgs>: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.

ConsistencyPolicy AccountConsistencyPolicy: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
GeoLocations []AccountGeoLocation: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
OfferType string: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
ResourceGroupName string: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
Capabilities []AccountCapability: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
EnableAutomaticFailover bool: Enable automatic fail over for this Cosmos DB account.
EnableMultipleWriteLocations bool: Enable multi-master support for this Cosmos DB account.
IpRangeFilter string: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IsVirtualNetworkFilterEnabled bool: Enables virtual network filtering for this Cosmos DB account.
Kind string: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
VirtualNetworkRules []AccountVirtualNetworkRule: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.

consistencyPolicy AccountConsistencyPolicy: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
geoLocations AccountGeoLocation[]: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
offerType string: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
resourceGroupName string: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
capabilities AccountCapability[]: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
enableAutomaticFailover boolean: Enable automatic fail over for this Cosmos DB account.
enableMultipleWriteLocations boolean: Enable multi-master support for this Cosmos DB account.
ipRangeFilter string: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
isVirtualNetworkFilterEnabled boolean: Enables virtual network filtering for this Cosmos DB account.
kind string: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
virtualNetworkRules AccountVirtualNetworkRule[]: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.

consistency_policy Dict[AccountConsistencyPolicy]: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
geo_locations List[AccountGeoLocation]: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
offer_type str: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
resource_group_name str: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
capabilities List[AccountCapability]: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
enable_automatic_failover bool: Enable automatic fail over for this Cosmos DB account.
enable_multiple_write_locations bool: Enable multi-master support for this Cosmos DB account.
ip_range_filter str: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
is_virtual_network_filter_enabled bool: Enables virtual network filtering for this Cosmos DB account.
kind str: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
virtual_network_rules List[AccountVirtualNetworkRule]: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.

Outputs

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

ConnectionStrings List<string>: A list of connection strings available for this CosmosDB account.
Endpoint string: The endpoint used to connect to the CosmosDB account.
Id string: The provider-assigned unique ID for this managed resource.
PrimaryMasterKey string: The Primary master key for the CosmosDB Account.
PrimaryReadonlyMasterKey string: The Primary read-only master Key for the CosmosDB Account.
ReadEndpoints List<string>: A list of read endpoints available for this CosmosDB account.
SecondaryMasterKey string: The Secondary master key for the CosmosDB Account.
SecondaryReadonlyMasterKey string: The Secondary read-only master key for the CosmosDB Account.
WriteEndpoints List<string>: A list of write endpoints available for this CosmosDB account.

ConnectionStrings []string: A list of connection strings available for this CosmosDB account.
Endpoint string: The endpoint used to connect to the CosmosDB account.
Id string: The provider-assigned unique ID for this managed resource.
PrimaryMasterKey string: The Primary master key for the CosmosDB Account.
PrimaryReadonlyMasterKey string: The Primary read-only master Key for the CosmosDB Account.
ReadEndpoints []string: A list of read endpoints available for this CosmosDB account.
SecondaryMasterKey string: The Secondary master key for the CosmosDB Account.
SecondaryReadonlyMasterKey string: The Secondary read-only master key for the CosmosDB Account.
WriteEndpoints []string: A list of write endpoints available for this CosmosDB account.

connectionStrings string[]: A list of connection strings available for this CosmosDB account.
endpoint string: The endpoint used to connect to the CosmosDB account.
id string: The provider-assigned unique ID for this managed resource.
primaryMasterKey string: The Primary master key for the CosmosDB Account.
primaryReadonlyMasterKey string: The Primary read-only master Key for the CosmosDB Account.
readEndpoints string[]: A list of read endpoints available for this CosmosDB account.
secondaryMasterKey string: The Secondary master key for the CosmosDB Account.
secondaryReadonlyMasterKey string: The Secondary read-only master key for the CosmosDB Account.
writeEndpoints string[]: A list of write endpoints available for this CosmosDB account.

connection_strings List[str]: A list of connection strings available for this CosmosDB account.
endpoint str: The endpoint used to connect to the CosmosDB account.
id str: The provider-assigned unique ID for this managed resource.
primary_master_key str: The Primary master key for the CosmosDB Account.
primary_readonly_master_key str: The Primary read-only master Key for the CosmosDB Account.
read_endpoints List[str]: A list of read endpoints available for this CosmosDB account.
secondary_master_key str: The Secondary master key for the CosmosDB Account.
secondary_readonly_master_key str: The Secondary read-only master key for the CosmosDB Account.
write_endpoints List[str]: A list of write endpoints available for this CosmosDB account.

Look up an 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

static get(resource_name, id, opts=None, capabilities=None, connection_strings=None, consistency_policy=None, enable_automatic_failover=None, enable_multiple_write_locations=None, endpoint=None, geo_locations=None, ip_range_filter=None, is_virtual_network_filter_enabled=None, kind=None, location=None, name=None, offer_type=None, primary_master_key=None, primary_readonly_master_key=None, read_endpoints=None, resource_group_name=None, secondary_master_key=None, secondary_readonly_master_key=None, tags=None, virtual_network_rules=None, write_endpoints=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Capabilities List<AccountCapabilityArgs>: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
ConnectionStrings List<string>: A list of connection strings available for this CosmosDB account.
ConsistencyPolicy AccountConsistencyPolicyArgs: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
EnableAutomaticFailover bool: Enable automatic fail over for this Cosmos DB account.
EnableMultipleWriteLocations bool: Enable multi-master support for this Cosmos DB account.
Endpoint string: The endpoint used to connect to the CosmosDB account.
GeoLocations List<AccountGeoLocationArgs>: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
IpRangeFilter string: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IsVirtualNetworkFilterEnabled bool: Enables virtual network filtering for this Cosmos DB account.
Kind string: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
OfferType string: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
PrimaryMasterKey string: The Primary master key for the CosmosDB Account.
PrimaryReadonlyMasterKey string: The Primary read-only master Key for the CosmosDB Account.
ReadEndpoints List<string>: A list of read endpoints available for this CosmosDB account.
ResourceGroupName string: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
SecondaryMasterKey string: The Secondary master key for the CosmosDB Account.
SecondaryReadonlyMasterKey string: The Secondary read-only master key for the CosmosDB Account.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VirtualNetworkRules List<AccountVirtualNetworkRuleArgs>: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
WriteEndpoints List<string>: A list of write endpoints available for this CosmosDB account.

Capabilities []AccountCapability: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
ConnectionStrings []string: A list of connection strings available for this CosmosDB account.
ConsistencyPolicy AccountConsistencyPolicy: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
EnableAutomaticFailover bool: Enable automatic fail over for this Cosmos DB account.
EnableMultipleWriteLocations bool: Enable multi-master support for this Cosmos DB account.
Endpoint string: The endpoint used to connect to the CosmosDB account.
GeoLocations []AccountGeoLocation: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
IpRangeFilter string: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IsVirtualNetworkFilterEnabled bool: Enables virtual network filtering for this Cosmos DB account.
Kind string: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
OfferType string: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
PrimaryMasterKey string: The Primary master key for the CosmosDB Account.
PrimaryReadonlyMasterKey string: The Primary read-only master Key for the CosmosDB Account.
ReadEndpoints []string: A list of read endpoints available for this CosmosDB account.
ResourceGroupName string: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
SecondaryMasterKey string: The Secondary master key for the CosmosDB Account.
SecondaryReadonlyMasterKey string: The Secondary read-only master key for the CosmosDB Account.
Tags map[string]string: A mapping of tags to assign to the resource.
VirtualNetworkRules []AccountVirtualNetworkRule: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
WriteEndpoints []string: A list of write endpoints available for this CosmosDB account.

capabilities AccountCapability[]: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
connectionStrings string[]: A list of connection strings available for this CosmosDB account.
consistencyPolicy AccountConsistencyPolicy: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
enableAutomaticFailover boolean: Enable automatic fail over for this Cosmos DB account.
enableMultipleWriteLocations boolean: Enable multi-master support for this Cosmos DB account.
endpoint string: The endpoint used to connect to the CosmosDB account.
geoLocations AccountGeoLocation[]: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
ipRangeFilter string: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
isVirtualNetworkFilterEnabled boolean: Enables virtual network filtering for this Cosmos DB account.
kind string: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
offerType string: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
primaryMasterKey string: The Primary master key for the CosmosDB Account.
primaryReadonlyMasterKey string: The Primary read-only master Key for the CosmosDB Account.
readEndpoints string[]: A list of read endpoints available for this CosmosDB account.
resourceGroupName string: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
secondaryMasterKey string: The Secondary master key for the CosmosDB Account.
secondaryReadonlyMasterKey string: The Secondary read-only master key for the CosmosDB Account.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
virtualNetworkRules AccountVirtualNetworkRule[]: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
writeEndpoints string[]: A list of write endpoints available for this CosmosDB account.

capabilities List[AccountCapability]: The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.
connection_strings List[str]: A list of connection strings available for this CosmosDB account.
consistency_policy Dict[AccountConsistencyPolicy]: Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.
enable_automatic_failover bool: Enable automatic fail over for this Cosmos DB account.
enable_multiple_write_locations bool: Enable multi-master support for this Cosmos DB account.
endpoint str: The endpoint used to connect to the CosmosDB account.
geo_locations List[AccountGeoLocation]: Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.
ip_range_filter str: CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP’s for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
is_virtual_network_filter_enabled bool: Enables virtual network filtering for this Cosmos DB account.
kind str: Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
offer_type str: Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.
primary_master_key str: The Primary master key for the CosmosDB Account.
primary_readonly_master_key str: The Primary read-only master Key for the CosmosDB Account.
read_endpoints List[str]: A list of read endpoints available for this CosmosDB account.
resource_group_name str: The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
secondary_master_key str: The Secondary master key for the CosmosDB Account.
secondary_readonly_master_key str: The Secondary read-only master key for the CosmosDB Account.
tags Dict[str, str]: A mapping of tags to assign to the resource.
virtual_network_rules List[AccountVirtualNetworkRule]: Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.
write_endpoints List[str]: A list of write endpoints available for this CosmosDB account.

Supporting Types

AccountCapability

See the input and output API doc for this type.

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

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

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

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

AccountConsistencyPolicy

See the input and output API doc for this type.

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

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

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

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

AccountGeoLocation

See the input and output API doc for this type.

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

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

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

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

AccountVirtualNetworkRule

See the input and output API doc for this type.

Id string: The ID of the virtual network subnet.

Id string: The ID of the virtual network subnet.

id string: The ID of the virtual network subnet.

id str: The ID of the virtual network subnet.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Account

Create a Account Resource

Account Resource Properties

Inputs

Outputs

Look up an Existing Account Resource

Supporting Types

AccountCapability

AccountConsistencyPolicy

AccountGeoLocation

AccountVirtualNetworkRule

Package Details

On This Page