Skip to main content

CosmosdbMongo


Resource Icon​

Resource Overview​

Cosmos DB is a multi-model distributed database provided by Microsoft Azure that supports NoSQL document, key-value, graph, and column-family data models. It is a globally distributed database that replicates data across multiple regions to provide low latency and high availability.

Parent Resource​

Resource Setting Values​

  • capabilities_list : List of the Cosmos DB API which should be used - EnableServerless, EnableAggregationPipeline

  • enable_multiple_write_locations : Enable multi-region writes to leverage provisioned throughput across global databases and containers - true, false

  • public_network_access_enabled : Enable connection to the account by public IP address or service endpoint - true, false

  • enable_automatic_failover : Enable automatic failover for the account - true, false

  • virtual_network_filter_enabled : Enable filters so that only certain Subnets in the Virtual network can access the account - true, false

  • network_acl_bypass_for_azure_services :Allow ACL bypass for Azure service - true, false

  • geo_location

    • failover_priority : The failover priority of the region - 0~ 0
    • zone_redundant : Enable the zone redundancy in case of an error - true~ false

  • consistency_policy

    • consistency_level : The consistency level of Cassandra DB to set availability and performance of database - Eventual, Session, Strong, ConsistentPrefix, BoundedStaleness
    • max_interval_in_seconds : If using Bounded Staleness, the time amount of staleness tolerated in seconds - 5~ 86400
    • max_staleness_prefix : If using Bounded Staleness, the number of stale requests tolerated - 10~2147483647

  • backup

    • type : The type of backup - Continuous, Periodic
    • interval_in_minutes : The interval of backup in minutes, Between 60 and 1440 - 60~ 1440
    • retention_in_hours : The time in hours that the backup is retained, Between 8 and 720 - 8~720

  • mongo_database

    • throughput : The throughput of Cassandra keyspace - 400~ 1000000
    • enable_autoscale : Whether to apply auto scaling to Cassandra keyspace - true, false

  • mongo_collection

    • ttl_seconds : The default Time To Live of collection in seconds
    • shard_key : The name of key to partition on for sharding
    • throughput : The throughput of the MongoDB Collection - 400~ 100000
    • enable_autoscale : Whether to apply auto scaling to Cassandra keyspace - true, false
    • included_mongo_database_name : The name of Mongo Database in which the collection is created

  • tag : Tag to categorize resources - up to 512 characters, key:value

Reference Materials​