documentdb.azure.com/v1api20231115

"2023-11-15"

GenerationTime: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.

SchemaType: Describes the types of schema for analytical storage.

SchemaType: Describes the types of schema for analytical storage.

"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"

"4.2"

"3.2"

"3.6"

"4.0"

"4.2"

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.

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.

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

Continuous: Mutually exclusive with all other properties

Periodic: Mutually exclusive with all other properties

StartTime: Time at which the backup policy migration started (ISO-8601 format).

Status: Describes the status of migration between backup policy types.

TargetType: Describes the target backup policy type of the backup policy migration.

StartTime: Time at which the backup policy migration started (ISO-8601 format).

Status: Describes the status of migration between backup policy types.

TargetType: Describes the target backup policy type of the backup policy migration.

"Completed"

"Failed"

"InProgress"

"Invalid"

"Completed"

"Failed"

"InProgress"

"Invalid"

"Continuous"

"Periodic"

"Continuous"

"Periodic"

Continuous: Mutually exclusive with all other properties

Periodic: Mutually exclusive with all other properties

"Geo"

"Local"

"Zone"

"Geo"

"Local"

"Zone"

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”.

TotalThroughputLimit: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

TotalThroughputLimit: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

ClientEncryptionKeyId: The identifier of the Client Encryption Key to be used to encrypt the path.

EncryptionAlgorithm: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

EncryptionType: The type of encryption to be performed. Eg - Deterministic, Randomized.

Path: Path that needs to be encrypted.

ClientEncryptionKeyId: The identifier of the Client Encryption Key to be used to encrypt the path.

EncryptionAlgorithm: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

EncryptionType: The type of encryption to be performed. Eg - Deterministic, Randomized.

Path: Path that needs to be encrypted.

IncludedPaths: Paths of the item that need encryption along with path-specific settings.

PolicyFormatVersion: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

IncludedPaths: Paths of the item that need encryption along with path-specific settings.

PolicyFormatVersion: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

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/*)

Name: The name of a computed property, for example - “cp_lowerName”

Query: The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c”

Name: The name of a computed property, for example - “cp_lowerName”

Query: The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c”

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.

"Small"

"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’.

"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’.

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

ContinuousModeProperties: Configuration values for continuous mode backup

MigrationState: The object representing the state of the migration between the backup policies.

Type: Describes the mode of backups.

ContinuousModeProperties: Configuration values for continuous mode backup

MigrationState: The object representing the state of the migration between the backup policies.

Type: Describes the mode of backups.

"Continuous"

"Continuous"

Tier: Enum to indicate type of Continuous backup mode

Tier: Enum to indicate type of Continuous backup mode

"Continuous30Days"

"Continuous7Days"

"Continuous30Days"

"Continuous7Days"

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.

"Default"

"Restore"

"Default"

"Restore"

AutoscaleSettings: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.

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

PrimaryMasterKey: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.

PrimaryReadonlyMasterKey: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.

SecondaryMasterKey: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.

SecondaryReadonlyMasterKey: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.

"Standard"

"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.

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

Secrets: configures where to place Azure generated secrets.

"GlobalDocumentDB"

"MongoDB"

"Parse"

"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

Capacity: The object that represents all properties related to capacity enforcement on an 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.

CreateMode: Enum to indicate the mode of account creation.

CustomerManagedKeyStatus: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.

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

DisableLocalAuth: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

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.

EnableBurstCapacity: Flag to indicate enabling/disabling of Burst Capacity feature on 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

EnablePartitionMerge: Flag to indicate enabling/disabling of Partition Merge feature on the account

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

Id: The unique resource identifier of the ARM resource.

Identity: Identity for the resource.

InstanceId: A unique identifier assigned to the database account

IpRules: List of IpRules.

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

KeyVaultKeyUri: The URI of the key vault

KeysMetadata: The object that represents the metadata for the Account Keys of the Cosmos DB account.

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.

MinimalTlsVersion: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.

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.

RestoreParameters: Parameters to indicate the information about the restore.

SystemData: The system meta data relating to this resource.

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.

AnalyticalStorageConfiguration: Analytical storage specific properties.

ApiProperties: API specific properties. Currently, supported only for MongoDB API.

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

Capacity: The object that represents all properties related to capacity enforcement on an account.

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

ConsistencyPolicy: The consistency policy for the Cosmos DB account.

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

CreateMode: Enum to indicate the mode of account creation.

CustomerManagedKeyStatus: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.

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

DisableLocalAuth: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

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.

EnableBurstCapacity: Flag to indicate enabling/disabling of Burst Capacity feature on 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

EnablePartitionMerge: Flag to indicate enabling/disabling of Partition Merge feature on the account

Identity: Identity for the 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 the georeplication locations enabled for the Cosmos DB account.

MinimalTlsVersion: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.

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

NetworkAclBypassResourceReferences: 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

RestoreParameters: Parameters to indicate the information about the restore.

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

CollectionNames: The names of the collections available for restore.

DatabaseName: The name of the database available for restore.

CollectionNames: The names of the collections available for restore.

DatabaseName: The name of the database available for restore.

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.

DatabaseName: The name of the gremlin database available for restore.

GraphNames: The names of the graphs available for restore.

DatabaseName: The name of the gremlin database available for restore.

GraphNames: The names of the graphs available for restore.

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.

"LineString"

"MultiPolygon"

"Number"

"Point"

"Polygon"

"String"

"LineString"

"MultiPolygon"

"Number"

"Point"

"Polygon"

"String"

"Hash"

"Range"

"Spatial"

"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.

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

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.

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.

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}’.

"None"

"SystemAssigned"

"SystemAssigned,UserAssigned"

"UserAssigned"

"None"

"SystemAssigned"

"SystemAssigned,UserAssigned"

"UserAssigned"

ClientId: The client id of user assigned identity.

PrincipalId: The principal id of user assigned identity.

"Tls"

"Tls11"

"Tls12"

"Tls"

"Tls11"

"Tls12"

AnalyticalStorageTtl: Analytical TTL.

CreateMode: Enum to indicate the mode of resource creation.

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

RestoreParameters: Parameters to indicate the information about the restore

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.

CreateMode: Enum to indicate the mode of resource creation.

Id: Name of the Cosmos DB MongoDB collection

Indexes: List of index keys

RestoreParameters: Parameters to indicate the information about the restore

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

CreateMode: Enum to indicate the mode of resource creation.

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

Id: Name of the Cosmos DB MongoDB database

RestoreParameters: Parameters to indicate the information about the restore

Rid: A system generated property. A unique identifier.

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

CreateMode: Enum to indicate the mode of resource creation.

Id: Name of the Cosmos DB MongoDB database

RestoreParameters: Parameters to indicate the information about the restore

Key: Cosmos DB MongoDB collection index keys

Options: Cosmos DB MongoDB collection index key 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

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

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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

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 documentdb.azure.com/MongodbDatabaseCollection resource

Resource: The standard JSON format of a resource throughput

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.

Options: Cosmos DB options resource object

Type: The type of Azure resource.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a MongoDB collection

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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

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 documentdb.azure.com/MongodbDatabase resource

Resource: The standard JSON format of a resource throughput

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.

Options: Cosmos DB options resource object

Type: The type of Azure resource.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a MongoDB database

"AzureServices"

"None"

"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.

MigrationState: The object representing the state of the migration between the backup policies.

PeriodicModeProperties: Configuration values for periodic mode backup

Type: Describes the mode of backups.

MigrationState: The object representing the state of the migration between the backup policies.

PeriodicModeProperties: Configuration values for periodic mode backup

Type: Describes the mode of backups.

"Periodic"

"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

BackupStorageRedundancy: Enum to indicate type of backup residency

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

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

BackupStorageRedundancy: Enum to indicate type of backup residency

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

"Disabled"

"Enabled"

"SecuredByPerimeter"

"Disabled"

"Enabled"

"SecuredByPerimeter"

DatabasesToRestore: List of specific databases available for restore.

GremlinDatabasesToRestore: List of specific gremlin databases available for restore.

RestoreMode: Describes the mode of the restore.

RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: /​subscriptions/​{subscriptionId}/​providers/​Microsoft.DocumentDB/​locations/​{location}/​restorableDatabaseAccounts/​{restorableDatabaseAccountName}

RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).

TablesToRestore: List of specific tables available for restore.

RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: /​subscriptions/​{subscriptionId}/​providers/​Microsoft.DocumentDB/​locations/​{location}/​restorableDatabaseAccounts/​{restorableDatabaseAccountName}

RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).

RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: /​subscriptions/​{subscriptionId}/​providers/​Microsoft.DocumentDB/​locations/​{location}/​restorableDatabaseAccounts/​{restorableDatabaseAccountName}

RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).

"PointInTime"

"PointInTime"

DatabasesToRestore: List of specific databases available for restore.

GremlinDatabasesToRestore: List of specific gremlin databases available for restore.

RestoreMode: Describes the mode of the restore.

RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: /​subscriptions/​{subscriptionId}/​providers/​Microsoft.DocumentDB/​locations/​{location}/​restorableDatabaseAccounts/​{restorableDatabaseAccountName}

RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format).

TablesToRestore: List of specific tables available for restore.

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"

"LineString"

"MultiPolygon"

"Point"

"Polygon"

AnalyticalStorageTtl: Analytical TTL.

ClientEncryptionPolicy: The client encryption policy for the container.

ComputedProperties: List of computed properties

ConflictResolutionPolicy: The conflict resolution policy for the container.

CreateMode: Enum to indicate the mode of resource creation.

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

RestoreParameters: Parameters to indicate the information about the restore

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.

ClientEncryptionPolicy: The client encryption policy for the container.

ComputedProperties: List of computed properties

ConflictResolutionPolicy: The conflict resolution policy for the container.

CreateMode: Enum to indicate the mode of resource creation.

DefaultTtl: Default time to live

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

RestoreParameters: Parameters to indicate the information about the restore

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

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a storedProcedure

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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

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 documentdb.azure.com/SqlDatabaseContainer resource

Resource: The standard JSON format of a resource throughput

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a trigger

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a userDefinedFunction

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.

Options: Cosmos DB options resource object

Type: The type of Azure resource.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a container

Colls: A system generated property that specified the addressable path of the collections resource.

CreateMode: Enum to indicate the mode of resource creation.

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

Id: Name of the Cosmos DB SQL database

RestoreParameters: Parameters to indicate the information about the restore

Rid: A system generated property. A unique identifier.

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

Users: A system generated property that specifies the addressable path of the users resource.

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

CreateMode: Enum to indicate the mode of resource creation.

Id: Name of the Cosmos DB SQL database

RestoreParameters: Parameters to indicate the information about the restore

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

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.

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

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 documentdb.azure.com/SqlDatabase resource

Resource: The standard JSON format of a resource throughput

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.

Options: Cosmos DB options resource object

Type: The type of Azure resource.

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.

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

Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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: The standard JSON format of a SQL database

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

Conditions: The observed state of the resource

Id: The unique resource identifier of the database account.

Name: The name of the database account.

PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

RoleDefinitionId: The unique identifier for the associated Role Definition.

Scope: The data plane resource path for which access is being granted through this Role Assignment.

Type: The type of Azure resource.

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.

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 documentdb.azure.com/DatabaseAccount resource

PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

PrincipalIdFromConfig: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

RoleDefinitionId: The unique identifier for the associated Role Definition.

Scope: The data plane resource path for which access is being granted through this Role Assignment.

Body: Body of the Stored Procedure

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

Id: Name of the Cosmos DB SQL storedProcedure

Rid: A system generated property. A unique identifier.

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

Body: Body of the Stored Procedure