documentdb.azure.com/v1beta20210515

"2021-05-15"

"FullFidelity"

"WellDefined"

"FullFidelity"

"WellDefined"

ServerVersion: Describes the ServerVersion of an a MongoDB account.

ServerVersion: Describes the ServerVersion of an a MongoDB account.

"3.2"

"3.6"

"4.0"

"3.2"

"3.6"

"4.0"

ServerVersion: Describes the ServerVersion of an a MongoDB account.

ServerVersion: Describes the ServerVersion of an a MongoDB account.

ThroughputPolicy: Cosmos DB resource throughput policy

ThroughputPolicy: Cosmos DB resource throughput policy

ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade

ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade

MaxThroughput: Represents maximum throughput, the resource can scale up to.

MaxThroughput: Represents maximum throughput, the resource can scale up to.

AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy

MaxThroughput: Represents maximum throughput container can scale up to.

AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy

MaxThroughput: Represents maximum throughput container can scale up to.

AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy

MaxThroughput: Represents maximum throughput container can scale up to.

TargetMaxThroughput: Represents target maximum throughput container can scale up to once offer is no longer in pending state.

AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy

MaxThroughput: Represents maximum throughput container can scale up to.

TargetMaxThroughput: Represents target maximum throughput container can scale up to once offer is no longer in pending state.

MaxThroughput: Represents maximum throughput, the resource can scale up to.

MaxThroughput: Represents maximum throughput, the resource can scale up to.

Continuous: Mutually exclusive with all other properties

Periodic: Mutually exclusive with all other properties

Continuous: Mutually exclusive with all other properties

Periodic: Mutually exclusive with all other properties

"Continuous"

"Periodic"

Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

Order: Sort order for composite paths.

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Order: Sort order for composite paths.

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

"ascending"

"descending"

"ascending"

"descending"

Order: Sort order for composite paths.

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Order: Sort order for composite paths.

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode.

ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode.

Mode: Indicates the conflict resolution mode.

ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode.

ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode.

Mode: Indicates the conflict resolution mode.

"Custom"

"LastWriterWins"

"Custom"

"LastWriterWins"

ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode.

ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode.

Mode: Indicates the conflict resolution mode.

ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode.

ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode.

Mode: Indicates the conflict resolution mode.

"Small"

DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account.

MaxIntervalInSeconds: 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. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account.

MaxIntervalInSeconds: 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. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

"BoundedStaleness"

"ConsistentPrefix"

"Eventual"

"Session"

"Strong"

"BoundedStaleness"

"ConsistentPrefix"

"Eventual"

"Session"

"Strong"

DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account.

MaxIntervalInSeconds: 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. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account.

MaxIntervalInSeconds: 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. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to ‘BoundedStaleness’.

Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.

Paths: List of paths using which data within the container can be partitioned

Version: Indicates the version of the partition key definition

Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.

Paths: List of paths using which data within the container can be partitioned

Version: Indicates the version of the partition key definition

"Hash"

"MultiHash"

"Range"

"Hash"

"MultiHash"

"Range"

Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create

Paths: List of paths using which data within the container can be partitioned

SystemKey: Indicates if the container is using a system generated partition key

Version: Indicates the version of the partition key definition

Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create

Paths: List of paths using which data within the container can be partitioned

SystemKey: Indicates if the container is using a system generated partition key

Version: Indicates the version of the partition key definition

"Continuous"

AllowedHeaders: The request headers that the origin domain may specify on the CORS request.

AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request.

AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS.

ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request.

AllowedHeaders: The request headers that the origin domain may specify on the CORS request.

AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request.

AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS.

ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request.

AllowedHeaders: The request headers that the origin domain may specify on the CORS request.

AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request.

AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS.

ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request.

AllowedHeaders: The request headers that the origin domain may specify on the CORS request.

AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request.

AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS.

ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request.

Throughput: Request Units per second. For example, “throughput”: 10000.

Throughput: Request Units per second. For example, “throughput”: 10000.

AnalyticalStorageConfiguration: Analytical storage specific properties.

BackupPolicy: The object representing the policy for taking backups on an account.

Capabilities: List of Cosmos DB capabilities for the account

ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account.

ConsistencyPolicy: The consistency policy for the Cosmos DB database account.

Cors: The CORS policy for the Cosmos DB database account.

DatabaseAccountOfferType: The offer type for the database

DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.

DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys

EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics.

EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account

EnableFreeTier: Flag to indicate whether Free Tier is enabled.

EnableMultipleWriteLocations: Enables the account to write in multiple locations

IpRules: Array of IpAddressOrRange objects.

IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules.

KeyVaultKeyUri: The URI of the key vault

Locations: An array that contains the georeplication locations enabled for the Cosmos DB account.

NetworkAclBypass: Indicates what services are allowed to bypass firewall checks.

NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

PublicNetworkAccess: Whether requests from Public Network are allowed.

VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

"Small"

"Standard"

"AzureServices"

"None"

"Disabled"

"Enabled"

AnalyticalStorageConfiguration: Analytical storage specific properties.

ApiProperties: API specific properties.

BackupPolicy: The object representing the policy for taking backups on an account.

Capabilities: List of Cosmos DB capabilities for the account

ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account.

ConsistencyPolicy: The consistency policy for the Cosmos DB database account.

Cors: The CORS policy for the Cosmos DB database account.

DatabaseAccountOfferType: The offer type for the Cosmos DB database account. Default value: Standard.

DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.

DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys

DocumentEndpoint: The connection endpoint for the Cosmos DB database account.

EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics.

EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account

EnableFreeTier: Flag to indicate whether Free Tier is enabled.

EnableMultipleWriteLocations: Enables the account to write in multiple locations

FailoverPolicies: An array that contains the regions ordered by their failover priorities.

IpRules: List of IpRules.

IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules.

KeyVaultKeyUri: The URI of the key vault

Locations: An array that contains all of the locations enabled for the Cosmos DB account.

NetworkAclBypass: Indicates what services are allowed to bypass firewall checks.

NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

PrivateEndpointConnections: List of Private Endpoint Connections configured for the Cosmos DB account.

PublicNetworkAccess: Whether requests from Public Network are allowed

ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account.

VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

WriteLocations: An array that contains the write location for the Cosmos DB account.

"GlobalDocumentDB"

"MongoDB"

"Parse"

AnalyticalStorageConfiguration: Analytical storage specific properties.

ApiProperties: API specific properties.

BackupPolicy: The object representing the policy for taking backups on an account.

Capabilities: List of Cosmos DB capabilities for the account

Conditions: The observed state of the resource

ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account.

ConsistencyPolicy: The consistency policy for the Cosmos DB database account.

Cors: The CORS policy for the Cosmos DB database account.

DatabaseAccountOfferType: The offer type for the Cosmos DB database account. Default value: Standard.

DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.

DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys

DocumentEndpoint: The connection endpoint for the Cosmos DB database account.

EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics.

EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account

EnableFreeTier: Flag to indicate whether Free Tier is enabled.

EnableMultipleWriteLocations: Enables the account to write in multiple locations

FailoverPolicies: An array that contains the regions ordered by their failover priorities.

Id: The unique resource identifier of the ARM resource.

IpRules: List of IpRules.

IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules.

KeyVaultKeyUri: The URI of the key vault

Kind: Indicates the type of database account. This can only be set at database account creation.

Location: The location of the resource group to which the resource belongs.

Locations: An array that contains all of the locations enabled for the Cosmos DB account.

Name: The name of the ARM resource.

NetworkAclBypass: Indicates what services are allowed to bypass firewall checks.

NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

PrivateEndpointConnections: List of Private Endpoint Connections configured for the Cosmos DB account.

PublicNetworkAccess: Whether requests from Public Network are allowed

ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account.

Type: The type of Azure resource.

VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

WriteLocations: An array that contains the write location for the Cosmos DB account.

Id: The unique resource identifier of the ARM resource.

Kind: Indicates the type of database account. This can only be set at database account creation.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Type: The type of Azure resource.

"Standard"

DocumentEndpoint: indicates where the DocumentEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure.

PrimaryMasterKey: indicates where the PrimaryMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

PrimaryReadonlyMasterKey: indicates where the PrimaryReadonlyMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

SecondaryMasterKey: indicates where the SecondaryMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

SecondaryReadonlyMasterKey: indicates where the SecondaryReadonlyMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

Secrets: configures where to place Azure generated secrets.

Location: The location of the resource group to which the resource belongs.

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/MongodbDatabaseCollection resource

Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Name of the resource

Properties: Properties to update Azure Cosmos DB resource throughput.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/MongodbDatabase resource

Resource: Cosmos DB MongoDB collection resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB collection name.

Properties: Properties to create and update Azure Cosmos DB MongoDB collection.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/MongodbDatabase resource

Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Name of the resource

Properties: Properties to update Azure Cosmos DB resource throughput.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/DatabaseAccount resource

Resource: Cosmos DB MongoDB database resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB database name.

Properties: Properties to create and update Azure Cosmos DB MongoDB database.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

"GlobalDocumentDB"

"MongoDB"

"Parse"

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource

Resource: Cosmos DB SQL storedProcedure resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB storedProcedure name.

Properties: Properties to create and update Azure Cosmos DB storedProcedure.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource

Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Name of the resource

Properties: Properties to update Azure Cosmos DB resource throughput.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource

Resource: Cosmos DB SQL trigger resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB trigger name.

Properties: Properties to create and update Azure Cosmos DB trigger.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource

Resource: Cosmos DB SQL userDefinedFunction resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB userDefinedFunction name.

Properties: Properties to create and update Azure Cosmos DB userDefinedFunction.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabase resource

Resource: Cosmos DB SQL container resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB container name.

Properties: Properties to create and update Azure Cosmos DB container.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabase resource

Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Name of the resource

Properties: Properties to update Azure Cosmos DB resource throughput.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

Location: The location of the resource group to which the resource belongs.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/DatabaseAccount resource

Resource: Cosmos DB SQL database resource object

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB database name.

Properties: Properties to create and update Azure Cosmos DB SQL database.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

AnalyticalStorageConfiguration: Analytical storage specific properties.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

BackupPolicy: The object representing the policy for taking backups on an account.

Capabilities: List of Cosmos DB capabilities for the account

ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account.

ConsistencyPolicy: The consistency policy for the Cosmos DB database account.

Cors: The CORS policy for the Cosmos DB database account.

DatabaseAccountOfferType: The offer type for the database

DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more.

DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys

EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics.

EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account

EnableFreeTier: Flag to indicate whether Free Tier is enabled.

EnableMultipleWriteLocations: Enables the account to write in multiple locations

Identity: Identity for the resource.

IpRules: Array of IpAddressOrRange objects.

IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules.

KeyVaultKeyUri: The URI of the key vault

Kind: Indicates the type of database account. This can only be set at database account creation.

Location: The location of the resource group to which the resource belongs.

Locations: An array that contains the georeplication locations enabled for the Cosmos DB account.

NetworkAclBypass: Indicates what services are allowed to bypass firewall checks.

NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

PublicNetworkAccess: Whether requests from Public Network are allowed.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

Identity: Identity for the resource.

Kind: Indicates the type of database account. This can only be set at database account creation.

Location: The location of the resource group to which the resource belongs.

Name: Cosmos DB database account name.

Properties: Properties to create and update Azure Cosmos DB database accounts.

Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”.

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

FailoverPriority: 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.

Id: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

LocationName: The name of the region in which the database account exists.

FailoverPriority: 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.

Id: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

LocationName: The name of the region in which the database account exists.

Indexes: List of indexes for this path

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Indexes: List of indexes for this path

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Indexes: List of indexes for this path

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Indexes: List of indexes for this path

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

DataType: The datatype for which the indexing behavior is applied to.

Kind: Indicates the type of index.

Precision: The precision of the index. -1 is maximum precision.

DataType: The datatype for which the indexing behavior is applied to.

Kind: Indicates the type of index.

Precision: The precision of the index. -1 is maximum precision.

"LineString"

"MultiPolygon"

"Number"

"Point"

"Polygon"

"String"

"Hash"

"Range"

"Spatial"

"LineString"

"MultiPolygon"

"Number"

"Point"

"Polygon"

"String"

"Hash"

"Range"

"Spatial"

DataType: The datatype for which the indexing behavior is applied to.

Kind: Indicates the type of index.

Precision: The precision of the index. -1 is maximum precision.

DataType: The datatype for which the indexing behavior is applied to.

Kind: Indicates the type of index.

Precision: The precision of the index. -1 is maximum precision.

Automatic: Indicates if the indexing policy is automatic

CompositeIndexes: List of composite path list

ExcludedPaths: List of paths to exclude from indexing

IncludedPaths: List of paths to include in the indexing

IndexingMode: Indicates the indexing mode.

SpatialIndexes: List of spatial specifics

Automatic: Indicates if the indexing policy is automatic

CompositeIndexes: List of composite path list

ExcludedPaths: List of paths to exclude from indexing

IncludedPaths: List of paths to include in the indexing

IndexingMode: Indicates the indexing mode.

SpatialIndexes: List of spatial specifics

"consistent"

"lazy"

"none"

"consistent"

"lazy"

"none"

Automatic: Indicates if the indexing policy is automatic

CompositeIndexes: List of composite path list

ExcludedPaths: List of paths to exclude from indexing

IncludedPaths: List of paths to include in the indexing

IndexingMode: Indicates the indexing mode.

SpatialIndexes: List of spatial specifics

Automatic: Indicates if the indexing policy is automatic

CompositeIndexes: List of composite path list

ExcludedPaths: List of paths to exclude from indexing

IncludedPaths: List of paths to include in the indexing

IndexingMode: Indicates the indexing mode.

SpatialIndexes: List of spatial specifics

IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

FailoverPriority: 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.

IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region

LocationName: The name of the region.

FailoverPriority: 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.

IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region

LocationName: The name of the region.

DocumentEndpoint: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

FailoverPriority: 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.

Id: The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region

LocationName: The name of the region.

DocumentEndpoint: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

FailoverPriority: 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.

Id: The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region

LocationName: The name of the region.

Type: The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

Type: The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

"None"

"SystemAssigned"

"SystemAssigned,UserAssigned"

"UserAssigned"

"None"

"SystemAssigned"

"SystemAssigned,UserAssigned"

"UserAssigned"

PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

Type: The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

Type: The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

ClientId: The client id of user assigned identity.

PrincipalId: The principal id of user assigned identity.

ClientId: The client id of user assigned identity.

PrincipalId: The principal id of user assigned identity.

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Resource: Cosmos DB MongoDB collection resource object

AnalyticalStorageTtl: Analytical TTL.

Etag: A system generated property representing the resource etag required for optimistic concurrency control.

Id: Name of the Cosmos DB MongoDB collection

Indexes: List of index keys

Rid: A system generated property. A unique identifier.

ShardKey: A key-value pair of shard keys to be applied for the request.

Ts: A system generated property that denotes the last updated timestamp of the resource.

AnalyticalStorageTtl: Analytical TTL.

Etag: A system generated property representing the resource etag required for optimistic concurrency control.

Id: Name of the Cosmos DB MongoDB collection

Indexes: List of index keys

Rid: A system generated property. A unique identifier.

ShardKey: A key-value pair of shard keys to be applied for the request.

Ts: A system generated property that denotes the last updated timestamp of the resource.

Conditions: The observed state of the resource

Id: The unique resource identifier of the ARM resource.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Type: The type of Azure resource.

Id: The unique resource identifier of the ARM resource.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Properties: The properties of an Azure Cosmos DB MongoDB collection

Type: The type of Azure resource.

AnalyticalStorageTtl: Analytical TTL.

Id: Name of the Cosmos DB MongoDB collection

Indexes: List of index keys

ShardKey: The shard key and partition kind pair, only support “Hash” partition kind

AnalyticalStorageTtl: Analytical TTL.

Id: Name of the Cosmos DB MongoDB collection

Indexes: List of index keys

ShardKey: The shard key and partition kind pair, only support “Hash” partition kind

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Resource: Cosmos DB MongoDB database resource object

Etag: A system generated property representing the resource etag required for optimistic concurrency control.

Id: Name of the Cosmos DB MongoDB database

Rid: A system generated property. A unique identifier.

Ts: A system generated property that denotes the last updated timestamp of the resource.

Etag: A system generated property representing the resource etag required for optimistic concurrency control.

Id: Name of the Cosmos DB MongoDB database

Rid: A system generated property. A unique identifier.

Ts: A system generated property that denotes the last updated timestamp of the resource.

Conditions: The observed state of the resource

Id: The unique resource identifier of the ARM resource.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Type: The type of Azure resource.

Id: The unique resource identifier of the ARM resource.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Properties: The properties of an Azure Cosmos DB MongoDB database

Type: The type of Azure resource.

Id: Name of the Cosmos DB MongoDB database

Id: Name of the Cosmos DB MongoDB database

Key: Cosmos DB MongoDB collection resource object

Options: Cosmos DB MongoDB collection index options

Key: Cosmos DB MongoDB collection resource object

Options: Cosmos DB MongoDB collection index options

Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

ExpireAfterSeconds: Expire after seconds

Unique: Is unique or not

ExpireAfterSeconds: Expire after seconds

Unique: Is unique or not

ExpireAfterSeconds: Expire after seconds

Unique: Is unique or not

ExpireAfterSeconds: Expire after seconds

Unique: Is unique or not

Key: Cosmos DB MongoDB collection index keys

Options: Cosmos DB MongoDB collection index key options

Key: Cosmos DB MongoDB collection index keys

Options: Cosmos DB MongoDB collection index key options

"AzureServices"

"None"

AutoscaleSettings: Specifies the Autoscale settings.

Throughput: Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

AutoscaleSettings: Specifies the Autoscale settings.

Throughput: Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

PeriodicModeProperties: Configuration values for periodic mode backup

PeriodicModeProperties: Configuration values for periodic mode backup

"Periodic"

BackupIntervalInMinutes: An integer representing the interval in minutes between two backups

BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained

BackupIntervalInMinutes: An integer representing the interval in minutes between two backups

BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained

Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

"Disabled"

"Enabled"

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Types: List of path’s spatial type

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Types: List of path’s spatial type

"LineString"

"MultiPolygon"

"Point"

"Polygon"

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Types: List of path’s spatial type

Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Types: List of path’s spatial type

"LineString"

"MultiPolygon"

"Point"

"Polygon"

Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”

Resource: Cosmos DB SQL container resource object

AnalyticalStorageTtl: Analytical TTL.

ConflictResolutionPolicy: The conflict resolution policy for the container.

DefaultTtl: Default time to live

Etag: A system generated property representing the resource etag required for optimistic concurrency control.

Id: Name of the Cosmos DB SQL container

IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container

PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions

Rid: A system generated property. A unique identifier.

Ts: A system generated property that denotes the last updated timestamp of the resource.

UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

AnalyticalStorageTtl: Analytical TTL.

ConflictResolutionPolicy: The conflict resolution policy for the container.

DefaultTtl: Default time to live

Etag: A system generated property representing the resource etag required for optimistic concurrency control.

Id: Name of the Cosmos DB SQL container

IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container

PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions

Rid: A system generated property. A unique identifier.

Ts: A system generated property that denotes the last updated timestamp of the resource.

UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Conditions: The observed state of the resource

Id: The unique resource identifier of the ARM resource.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Type: The type of Azure resource.

Id: The unique resource identifier of the ARM resource.

Location: The location of the resource group to which the resource belongs.

Name: The name of the ARM resource.

Properties: The properties of an Azure Cosmos DB container

Type: The type of Azure resource.

AnalyticalStorageTtl: Analytical TTL.

ConflictResolutionPolicy: The conflict resolution policy for the container.

DefaultTtl: Default time to live

Id: Name of the Cosmos DB SQL container

IndexingPolicy: Cosmos DB indexing policy

PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions

UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

AnalyticalStorageTtl: Analytical TTL.

ConflictResolutionPolicy: The conflict resolution policy for the container.

DefaultTtl: Default time to live

Id: Name of the Cosmos DB SQL container

IndexingPolicy: Cosmos DB indexing policy

PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions

UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.