documentdb.azure.com/v1api20240815

APIVersion

Value	Description
“2024-08-15”

DatabaseAccount

Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}

Used by: DatabaseAccountList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		DatabaseAccount_Spec Optional
status		DatabaseAccount_STATUS Optional

DatabaseAccount_Spec

Property	Description	Type
analyticalStorageConfiguration	Analytical storage specific properties.	AnalyticalStorageConfiguration Optional
apiProperties	API specific properties. Currently, supported only for MongoDB API.	ApiProperties Optional
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.	string Optional
backupPolicy	The object representing the policy for taking backups on an account.	BackupPolicy Optional
capabilities	List of Cosmos DB capabilities for the account	Capability[] Optional
capacity	The object that represents all properties related to capacity enforcement on an account.	Capacity Optional
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.	ConnectorOffer Optional
consistencyPolicy	The consistency policy for the Cosmos DB account.	ConsistencyPolicy Optional
cors	The CORS policy for the Cosmos DB database account.	CorsPolicy[] Optional
createMode	Enum to indicate the mode of account creation.	CreateMode Optional
customerManagedKeyStatus	Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.	string Optional
databaseAccountOfferType	The offer type for the database	DatabaseAccountOfferType Required
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.	string Optional
disableKeyBasedMetadataWriteAccess	Disable write operations on metadata resources (databases, containers, throughput) via account keys	bool Optional
disableLocalAuth	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.	bool Optional
enableAnalyticalStorage	Flag to indicate whether to enable storage analytics.	bool Optional
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.	bool Optional
enableBurstCapacity	Flag to indicate enabling/disabling of Burst Capacity feature on the account	bool Optional
enableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account	bool Optional
enableFreeTier	Flag to indicate whether Free Tier is enabled.	bool Optional
enableMultipleWriteLocations	Enables the account to write in multiple locations	bool Optional
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account	bool Optional
identity	Identity for the resource.	ManagedServiceIdentity Optional
ipRules	List of IpRules.	IpAddressOrRange[] Optional
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.	bool Optional
keyVaultKeyUri	The URI of the key vault	string Optional
kind	Indicates the type of database account. This can only be set at database account creation.	DatabaseAccount_Kind_Spec Optional
location	The location of the resource group to which the resource belongs.	string Optional
locations	An array that contains the georeplication locations enabled for the Cosmos DB account.	Location[] Required
minimalTlsVersion	Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.	MinimalTlsVersion Optional
networkAclBypass	Indicates what services are allowed to bypass firewall checks.	NetworkAclBypass Optional
networkAclBypassResourceReferences	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.	genruntime.ResourceReference[] Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	DatabaseAccountOperatorSpec Optional
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	genruntime.KnownResourceReference Required
publicNetworkAccess	Whether requests from Public Network are allowed	PublicNetworkAccess Optional
restoreParameters	Parameters to indicate the information about the restore.	RestoreParameters Optional
tags		map[string]string Optional
virtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.	VirtualNetworkRule[] Optional

DatabaseAccount_STATUS

Property	Description	Type
analyticalStorageConfiguration	Analytical storage specific properties.	AnalyticalStorageConfiguration_STATUS Optional
apiProperties	API specific properties.	ApiProperties_STATUS Optional
backupPolicy	The object representing the policy for taking backups on an account.	BackupPolicy_STATUS Optional
capabilities	List of Cosmos DB capabilities for the account	Capability_STATUS[] Optional
capacity	The object that represents all properties related to capacity enforcement on an account.	Capacity_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.	ConnectorOffer_STATUS Optional
consistencyPolicy	The consistency policy for the Cosmos DB database account.	ConsistencyPolicy_STATUS Optional
cors	The CORS policy for the Cosmos DB database account.	CorsPolicy_STATUS[] Optional
createMode	Enum to indicate the mode of account creation.	CreateMode_STATUS Optional
customerManagedKeyStatus	Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.	string Optional
databaseAccountOfferType	The offer type for the Cosmos DB database account. Default value: Standard.	DatabaseAccountOfferType_STATUS Optional
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.	string Optional
disableKeyBasedMetadataWriteAccess	Disable write operations on metadata resources (databases, containers, throughput) via account keys	bool Optional
disableLocalAuth	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.	bool Optional
documentEndpoint	The connection endpoint for the Cosmos DB database account.	string Optional
enableAnalyticalStorage	Flag to indicate whether to enable storage analytics.	bool Optional
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.	bool Optional
enableBurstCapacity	Flag to indicate enabling/disabling of Burst Capacity feature on the account	bool Optional
enableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account	bool Optional
enableFreeTier	Flag to indicate whether Free Tier is enabled.	bool Optional
enableMultipleWriteLocations	Enables the account to write in multiple locations	bool Optional
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account	bool Optional
failoverPolicies	An array that contains the regions ordered by their failover priorities.	FailoverPolicy_STATUS[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
identity	Identity for the resource.	ManagedServiceIdentity_STATUS Optional
instanceId	A unique identifier assigned to the database account	string Optional
ipRules	List of IpRules.	IpAddressOrRange_STATUS[] Optional
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.	bool Optional
keysMetadata	The object that represents the metadata for the Account Keys of the Cosmos DB account.	DatabaseAccountKeysMetadata_STATUS Optional
keyVaultKeyUri	The URI of the key vault	string Optional
kind	Indicates the type of database account. This can only be set at database account creation.	DatabaseAccount_Kind_STATUS Optional
location	The location of the resource group to which the resource belongs.	string Optional
locations	An array that contains all of the locations enabled for the Cosmos DB account.	Location_STATUS[] Optional
minimalTlsVersion	Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.	MinimalTlsVersion_STATUS Optional
name	The name of the ARM resource.	string Optional
networkAclBypass	Indicates what services are allowed to bypass firewall checks.	NetworkAclBypass_STATUS Optional
networkAclBypassResourceIds	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.	string[] Optional
privateEndpointConnections	List of Private Endpoint Connections configured for the Cosmos DB account.	PrivateEndpointConnection_STATUS[] Optional
provisioningState		string Optional
publicNetworkAccess	Whether requests from Public Network are allowed	PublicNetworkAccess_STATUS Optional
readLocations	An array that contains of the read locations enabled for the Cosmos DB account.	Location_STATUS[] Optional
restoreParameters	Parameters to indicate the information about the restore.	RestoreParameters_STATUS Optional
systemData	The system meta data relating to this resource.	SystemData_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional
virtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.	VirtualNetworkRule_STATUS[] Optional
writeLocations	An array that contains the write location for the Cosmos DB account.	Location_STATUS[] Optional

DatabaseAccountList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		DatabaseAccount[] Optional

MongodbDatabase

Used by: MongodbDatabaseList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		MongodbDatabase_Spec Optional
status		MongodbDatabase_STATUS Optional

MongodbDatabase_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a MongoDB database	MongoDBDatabaseResource Required
tags		map[string]string Optional

MongodbDatabase_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		MongoDBDatabaseGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseCollection

Used by: MongodbDatabaseCollectionList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		MongodbDatabaseCollection_Spec Optional
status		MongodbDatabaseCollection_STATUS Optional

MongodbDatabaseCollection_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseCollectionOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a MongoDB collection	MongoDBCollectionResource Required
tags		map[string]string Optional

MongodbDatabaseCollection_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		MongoDBCollectionGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseCollectionList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		MongodbDatabaseCollection[] Optional

MongodbDatabaseCollectionThroughputSetting

Used by: MongodbDatabaseCollectionThroughputSettingList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		MongodbDatabaseCollectionThroughputSetting_Spec Optional
status		MongodbDatabaseCollectionThroughputSetting_STATUS Optional

MongodbDatabaseCollectionThroughputSetting_Spec

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseCollectionThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

MongodbDatabaseCollectionThroughputSetting_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseCollectionThroughputSettingList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		MongodbDatabaseCollectionThroughputSetting[] Optional

MongodbDatabaseList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		MongodbDatabase[] Optional

MongodbDatabaseThroughputSetting

Used by: MongodbDatabaseThroughputSettingList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		MongodbDatabaseThroughputSetting_Spec Optional
status		MongodbDatabaseThroughputSetting_STATUS Optional

MongodbDatabaseThroughputSetting_Spec

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

MongodbDatabaseThroughputSetting_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseThroughputSettingList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		MongodbDatabaseThroughputSetting[] Optional

MongodbUserDefinition

Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/mongorbac.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}

Used by: MongodbUserDefinitionList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		MongodbUserDefinition_Spec Optional
status		MongodbUserDefinition_STATUS Optional

MongodbUserDefinition_Spec

Property	Description	Type
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.	string Optional
customData	A custom definition for the USer Definition.	string Optional
databaseName	The database name for which access is being granted for this User Definition.	string Optional
mechanisms	The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbUserDefinitionOperatorSpec Optional
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	genruntime.KnownResourceReference Required
password	The password for User Definition. Response does not contain user password.	genruntime.SecretReference Optional
roles	The set of roles inherited by the User Definition.	Role[] Optional
userName	The user name for User Definition.	string Optional

MongodbUserDefinition_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
customData	A custom definition for the USer Definition.	string Optional
databaseName	The database name for which access is being granted for this User Definition.	string Optional
id	The unique resource identifier of the database account.	string Optional
mechanisms	The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.	string Optional
name	The name of the database account.	string Optional
roles	The set of roles inherited by the User Definition.	Role_STATUS[] Optional
type	The type of Azure resource.	string Optional
userName	The user name for User Definition.	string Optional

MongodbUserDefinitionList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		MongodbUserDefinition[] Optional

SqlDatabase

Used by: SqlDatabaseList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabase_Spec Optional
status		SqlDatabase_STATUS Optional

SqlDatabase_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a SQL database	SqlDatabaseResource Required
tags		map[string]string Optional

SqlDatabase_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		SqlDatabaseGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainer

Used by: SqlDatabaseContainerList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabaseContainer_Spec Optional
status		SqlDatabaseContainer_STATUS Optional

SqlDatabaseContainer_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a container	SqlContainerResource Required
tags		map[string]string Optional

SqlDatabaseContainer_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		SqlContainerGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabaseContainer[] Optional

SqlDatabaseContainerStoredProcedure

Used by: SqlDatabaseContainerStoredProcedureList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabaseContainerStoredProcedure_Spec Optional
status		SqlDatabaseContainerStoredProcedure_STATUS Optional

SqlDatabaseContainerStoredProcedure_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerStoredProcedureOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a storedProcedure	SqlStoredProcedureResource Required
tags		map[string]string Optional

SqlDatabaseContainerStoredProcedure_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		SqlStoredProcedureGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerStoredProcedureList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabaseContainerStoredProcedure[] Optional

SqlDatabaseContainerThroughputSetting

Used by: SqlDatabaseContainerThroughputSettingList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabaseContainerThroughputSetting_Spec Optional
status		SqlDatabaseContainerThroughputSetting_STATUS Optional

SqlDatabaseContainerThroughputSetting_Spec

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

SqlDatabaseContainerThroughputSetting_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerThroughputSettingList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabaseContainerThroughputSetting[] Optional

SqlDatabaseContainerTrigger

Used by: SqlDatabaseContainerTriggerList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabaseContainerTrigger_Spec Optional
status		SqlDatabaseContainerTrigger_STATUS Optional

SqlDatabaseContainerTrigger_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerTriggerOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a trigger	SqlTriggerResource Required
tags		map[string]string Optional

SqlDatabaseContainerTrigger_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		SqlTriggerGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerTriggerList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabaseContainerTrigger[] Optional

SqlDatabaseContainerUserDefinedFunction

Used by: SqlDatabaseContainerUserDefinedFunctionList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabaseContainerUserDefinedFunction_Spec Optional
status		SqlDatabaseContainerUserDefinedFunction_STATUS Optional

SqlDatabaseContainerUserDefinedFunction_Spec

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerUserDefinedFunctionOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a userDefinedFunction	SqlUserDefinedFunctionResource Required
tags		map[string]string Optional

SqlDatabaseContainerUserDefinedFunction_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		SqlUserDefinedFunctionGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerUserDefinedFunctionList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabaseContainerUserDefinedFunction[] Optional

SqlDatabaseList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabase[] Optional

SqlDatabaseThroughputSetting

Used by: SqlDatabaseThroughputSettingList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlDatabaseThroughputSetting_Spec Optional
status		SqlDatabaseThroughputSetting_STATUS Optional

SqlDatabaseThroughputSetting_Spec

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

SqlDatabaseThroughputSetting_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseThroughputSettingList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlDatabaseThroughputSetting[] Optional

SqlRoleAssignment

Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/rbac.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}

Used by: SqlRoleAssignmentList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		SqlRoleAssignment_Spec Optional
status		SqlRoleAssignment_STATUS Optional

SqlRoleAssignment_Spec

Property	Description	Type
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.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlRoleAssignmentOperatorSpec Optional
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	genruntime.KnownResourceReference Required
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.	string Optional
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.	genruntime.ConfigMapReference Optional
roleDefinitionId	The unique identifier for the associated Role Definition.	string Optional
scope	The data plane resource path for which access is being granted through this Role Assignment.	string Optional

SqlRoleAssignment_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the database account.	string Optional
name	The name of the database account.	string Optional
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.	string Optional
roleDefinitionId	The unique identifier for the associated Role Definition.	string Optional
scope	The data plane resource path for which access is being granted through this Role Assignment.	string Optional
type	The type of Azure resource.	string Optional

SqlRoleAssignmentList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		SqlRoleAssignment[] Optional

DatabaseAccount_Spec

Used by: DatabaseAccount.

Property	Description	Type
analyticalStorageConfiguration	Analytical storage specific properties.	AnalyticalStorageConfiguration Optional
apiProperties	API specific properties. Currently, supported only for MongoDB API.	ApiProperties Optional
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.	string Optional
backupPolicy	The object representing the policy for taking backups on an account.	BackupPolicy Optional
capabilities	List of Cosmos DB capabilities for the account	Capability[] Optional
capacity	The object that represents all properties related to capacity enforcement on an account.	Capacity Optional
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.	ConnectorOffer Optional
consistencyPolicy	The consistency policy for the Cosmos DB account.	ConsistencyPolicy Optional
cors	The CORS policy for the Cosmos DB database account.	CorsPolicy[] Optional
createMode	Enum to indicate the mode of account creation.	CreateMode Optional
customerManagedKeyStatus	Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.	string Optional
databaseAccountOfferType	The offer type for the database	DatabaseAccountOfferType Required
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.	string Optional
disableKeyBasedMetadataWriteAccess	Disable write operations on metadata resources (databases, containers, throughput) via account keys	bool Optional
disableLocalAuth	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.	bool Optional
enableAnalyticalStorage	Flag to indicate whether to enable storage analytics.	bool Optional
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.	bool Optional
enableBurstCapacity	Flag to indicate enabling/disabling of Burst Capacity feature on the account	bool Optional
enableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account	bool Optional
enableFreeTier	Flag to indicate whether Free Tier is enabled.	bool Optional
enableMultipleWriteLocations	Enables the account to write in multiple locations	bool Optional
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account	bool Optional
identity	Identity for the resource.	ManagedServiceIdentity Optional
ipRules	List of IpRules.	IpAddressOrRange[] Optional
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.	bool Optional
keyVaultKeyUri	The URI of the key vault	string Optional
kind	Indicates the type of database account. This can only be set at database account creation.	DatabaseAccount_Kind_Spec Optional
location	The location of the resource group to which the resource belongs.	string Optional
locations	An array that contains the georeplication locations enabled for the Cosmos DB account.	Location[] Required
minimalTlsVersion	Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.	MinimalTlsVersion Optional
networkAclBypass	Indicates what services are allowed to bypass firewall checks.	NetworkAclBypass Optional
networkAclBypassResourceReferences	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.	genruntime.ResourceReference[] Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	DatabaseAccountOperatorSpec Optional
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	genruntime.KnownResourceReference Required
publicNetworkAccess	Whether requests from Public Network are allowed	PublicNetworkAccess Optional
restoreParameters	Parameters to indicate the information about the restore.	RestoreParameters Optional
tags		map[string]string Optional
virtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.	VirtualNetworkRule[] Optional

DatabaseAccount_STATUS

Used by: DatabaseAccount.

Property	Description	Type
analyticalStorageConfiguration	Analytical storage specific properties.	AnalyticalStorageConfiguration_STATUS Optional
apiProperties	API specific properties.	ApiProperties_STATUS Optional
backupPolicy	The object representing the policy for taking backups on an account.	BackupPolicy_STATUS Optional
capabilities	List of Cosmos DB capabilities for the account	Capability_STATUS[] Optional
capacity	The object that represents all properties related to capacity enforcement on an account.	Capacity_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.	ConnectorOffer_STATUS Optional
consistencyPolicy	The consistency policy for the Cosmos DB database account.	ConsistencyPolicy_STATUS Optional
cors	The CORS policy for the Cosmos DB database account.	CorsPolicy_STATUS[] Optional
createMode	Enum to indicate the mode of account creation.	CreateMode_STATUS Optional
customerManagedKeyStatus	Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.	string Optional
databaseAccountOfferType	The offer type for the Cosmos DB database account. Default value: Standard.	DatabaseAccountOfferType_STATUS Optional
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.	string Optional
disableKeyBasedMetadataWriteAccess	Disable write operations on metadata resources (databases, containers, throughput) via account keys	bool Optional
disableLocalAuth	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.	bool Optional
documentEndpoint	The connection endpoint for the Cosmos DB database account.	string Optional
enableAnalyticalStorage	Flag to indicate whether to enable storage analytics.	bool Optional
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.	bool Optional
enableBurstCapacity	Flag to indicate enabling/disabling of Burst Capacity feature on the account	bool Optional
enableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account	bool Optional
enableFreeTier	Flag to indicate whether Free Tier is enabled.	bool Optional
enableMultipleWriteLocations	Enables the account to write in multiple locations	bool Optional
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account	bool Optional
failoverPolicies	An array that contains the regions ordered by their failover priorities.	FailoverPolicy_STATUS[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
identity	Identity for the resource.	ManagedServiceIdentity_STATUS Optional
instanceId	A unique identifier assigned to the database account	string Optional
ipRules	List of IpRules.	IpAddressOrRange_STATUS[] Optional
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.	bool Optional
keysMetadata	The object that represents the metadata for the Account Keys of the Cosmos DB account.	DatabaseAccountKeysMetadata_STATUS Optional
keyVaultKeyUri	The URI of the key vault	string Optional
kind	Indicates the type of database account. This can only be set at database account creation.	DatabaseAccount_Kind_STATUS Optional
location	The location of the resource group to which the resource belongs.	string Optional
locations	An array that contains all of the locations enabled for the Cosmos DB account.	Location_STATUS[] Optional
minimalTlsVersion	Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.	MinimalTlsVersion_STATUS Optional
name	The name of the ARM resource.	string Optional
networkAclBypass	Indicates what services are allowed to bypass firewall checks.	NetworkAclBypass_STATUS Optional
networkAclBypassResourceIds	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.	string[] Optional
privateEndpointConnections	List of Private Endpoint Connections configured for the Cosmos DB account.	PrivateEndpointConnection_STATUS[] Optional
provisioningState		string Optional
publicNetworkAccess	Whether requests from Public Network are allowed	PublicNetworkAccess_STATUS Optional
readLocations	An array that contains of the read locations enabled for the Cosmos DB account.	Location_STATUS[] Optional
restoreParameters	Parameters to indicate the information about the restore.	RestoreParameters_STATUS Optional
systemData	The system meta data relating to this resource.	SystemData_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional
virtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.	VirtualNetworkRule_STATUS[] Optional
writeLocations	An array that contains the write location for the Cosmos DB account.	Location_STATUS[] Optional

MongodbDatabase_Spec

Used by: MongodbDatabase.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a MongoDB database	MongoDBDatabaseResource Required
tags		map[string]string Optional

MongodbDatabase_STATUS

Used by: MongodbDatabase.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		MongoDBDatabaseGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseCollection_Spec

Used by: MongodbDatabaseCollection.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseCollectionOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a MongoDB collection	MongoDBCollectionResource Required
tags		map[string]string Optional

MongodbDatabaseCollection_STATUS

Used by: MongodbDatabaseCollection.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		MongoDBCollectionGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseCollectionThroughputSetting_Spec

Used by: MongodbDatabaseCollectionThroughputSetting.

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseCollectionThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

MongodbDatabaseCollectionThroughputSetting_STATUS

Used by: MongodbDatabaseCollectionThroughputSetting.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbDatabaseThroughputSetting_Spec

Used by: MongodbDatabaseThroughputSetting.

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbDatabaseThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

MongodbDatabaseThroughputSetting_STATUS

Used by: MongodbDatabaseThroughputSetting.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

MongodbUserDefinition_Spec

Used by: MongodbUserDefinition.

Property	Description	Type
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.	string Optional
customData	A custom definition for the USer Definition.	string Optional
databaseName	The database name for which access is being granted for this User Definition.	string Optional
mechanisms	The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	MongodbUserDefinitionOperatorSpec Optional
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	genruntime.KnownResourceReference Required
password	The password for User Definition. Response does not contain user password.	genruntime.SecretReference Optional
roles	The set of roles inherited by the User Definition.	Role[] Optional
userName	The user name for User Definition.	string Optional

MongodbUserDefinition_STATUS

Used by: MongodbUserDefinition.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
customData	A custom definition for the USer Definition.	string Optional
databaseName	The database name for which access is being granted for this User Definition.	string Optional
id	The unique resource identifier of the database account.	string Optional
mechanisms	The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.	string Optional
name	The name of the database account.	string Optional
roles	The set of roles inherited by the User Definition.	Role_STATUS[] Optional
type	The type of Azure resource.	string Optional
userName	The user name for User Definition.	string Optional

SqlDatabase_Spec

Used by: SqlDatabase.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a SQL database	SqlDatabaseResource Required
tags		map[string]string Optional

SqlDatabase_STATUS

Used by: SqlDatabase.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		SqlDatabaseGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainer_Spec

Used by: SqlDatabaseContainer.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a container	SqlContainerResource Required
tags		map[string]string Optional

SqlDatabaseContainer_STATUS

Used by: SqlDatabaseContainer.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
options	Cosmos DB options resource object	OptionsResource_STATUS Optional
resource		SqlContainerGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerStoredProcedure_Spec

Used by: SqlDatabaseContainerStoredProcedure.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerStoredProcedureOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a storedProcedure	SqlStoredProcedureResource Required
tags		map[string]string Optional

SqlDatabaseContainerStoredProcedure_STATUS

Used by: SqlDatabaseContainerStoredProcedure.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		SqlStoredProcedureGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerThroughputSetting_Spec

Used by: SqlDatabaseContainerThroughputSetting.

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

SqlDatabaseContainerThroughputSetting_STATUS

Used by: SqlDatabaseContainerThroughputSetting.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerTrigger_Spec

Used by: SqlDatabaseContainerTrigger.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerTriggerOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a trigger	SqlTriggerResource Required
tags		map[string]string Optional

SqlDatabaseContainerTrigger_STATUS

Used by: SqlDatabaseContainerTrigger.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		SqlTriggerGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseContainerUserDefinedFunction_Spec

Used by: SqlDatabaseContainerUserDefinedFunction.

Property	Description	Type
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.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseContainerUserDefinedFunctionOperatorSpec Optional
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptions Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a userDefinedFunction	SqlUserDefinedFunctionResource Required
tags		map[string]string Optional

SqlDatabaseContainerUserDefinedFunction_STATUS

Used by: SqlDatabaseContainerUserDefinedFunction.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		SqlUserDefinedFunctionGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlDatabaseThroughputSetting_Spec

Used by: SqlDatabaseThroughputSetting.

Property	Description	Type
location	The location of the resource group to which the resource belongs.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlDatabaseThroughputSettingOperatorSpec Optional
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	genruntime.KnownResourceReference Required
resource	The standard JSON format of a resource throughput	ThroughputSettingsResource Required
tags		map[string]string Optional

SqlDatabaseThroughputSetting_STATUS

Used by: SqlDatabaseThroughputSetting.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the ARM resource.	string Optional
location	The location of the resource group to which the resource belongs.	string Optional
name	The name of the ARM resource.	string Optional
resource		ThroughputSettingsGetProperties_Resource_STATUS Optional
tags		map[string]string Optional
type	The type of Azure resource.	string Optional

SqlRoleAssignment_Spec

Used by: SqlRoleAssignment.

Property	Description	Type
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.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SqlRoleAssignmentOperatorSpec Optional
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	genruntime.KnownResourceReference Required
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.	string Optional
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.	genruntime.ConfigMapReference Optional
roleDefinitionId	The unique identifier for the associated Role Definition.	string Optional
scope	The data plane resource path for which access is being granted through this Role Assignment.	string Optional

SqlRoleAssignment_STATUS

Used by: SqlRoleAssignment.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	The unique resource identifier of the database account.	string Optional
name	The name of the database account.	string Optional
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.	string Optional
roleDefinitionId	The unique identifier for the associated Role Definition.	string Optional
scope	The data plane resource path for which access is being granted through this Role Assignment.	string Optional
type	The type of Azure resource.	string Optional

AnalyticalStorageConfiguration

Analytical storage specific properties.

Used by: DatabaseAccount_Spec.

Property	Description	Type
schemaType	Describes the types of schema for analytical storage.	AnalyticalStorageSchemaType Optional

AnalyticalStorageConfiguration_STATUS

Analytical storage specific properties.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
schemaType	Describes the types of schema for analytical storage.	AnalyticalStorageSchemaType_STATUS Optional

ApiProperties

Used by: DatabaseAccount_Spec.

Property	Description	Type
serverVersion	Describes the version of the MongoDB account.	ApiProperties_ServerVersion Optional

ApiProperties_STATUS

Used by: DatabaseAccount_STATUS.

Property	Description	Type
serverVersion	Describes the version of the MongoDB account.	ApiProperties_ServerVersion_STATUS Optional

BackupPolicy

Used by: DatabaseAccount_Spec.

Property	Description	Type
continuous	Mutually exclusive with all other properties	ContinuousModeBackupPolicy Optional
periodic	Mutually exclusive with all other properties	PeriodicModeBackupPolicy Optional

BackupPolicy_STATUS

Used by: DatabaseAccount_STATUS.

Property	Description	Type
continuous	Mutually exclusive with all other properties	ContinuousModeBackupPolicy_STATUS Optional
periodic	Mutually exclusive with all other properties	PeriodicModeBackupPolicy_STATUS Optional

Capability

Cosmos DB capability object

Used by: DatabaseAccount_Spec.

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

Capability_STATUS

Cosmos DB capability object

Used by: DatabaseAccount_STATUS.

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

Capacity

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

Used by: DatabaseAccount_Spec.

Property	Description	Type
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.	int Optional

Capacity_STATUS

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

Used by: DatabaseAccount_STATUS.

Property	Description	Type
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.	int Optional

ConnectorOffer

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

Used by: DatabaseAccount_Spec.

Value	Description
“Small”

ConnectorOffer_STATUS

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

Used by: DatabaseAccount_STATUS.

Value	Description
“Small”

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.

Used by: DatabaseAccount_Spec.

Property	Description	Type
defaultConsistencyLevel	The default consistency level and configuration settings of the Cosmos DB account.	ConsistencyPolicy_DefaultConsistencyLevel Required
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’.	int Optional
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’.	int Optional

ConsistencyPolicy_STATUS

The consistency policy for the Cosmos DB database account.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
defaultConsistencyLevel	The default consistency level and configuration settings of the Cosmos DB account.	ConsistencyPolicy_DefaultConsistencyLevel_STATUS Optional
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’.	int Optional
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’.	int Optional

CorsPolicy

The CORS policy for the Cosmos DB database account.

Used by: DatabaseAccount_Spec.

Property	Description	Type
allowedHeaders	The request headers that the origin domain may specify on the CORS request.	string Optional
allowedMethods	The methods (HTTP request verbs) that the origin domain may use for a CORS request.	string Optional
allowedOrigins	The origin domains that are permitted to make a request against the service via CORS.	string Required
exposedHeaders	The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.	string Optional
maxAgeInSeconds	The maximum amount time that a browser should cache the preflight OPTIONS request.	int Optional

CorsPolicy_STATUS

The CORS policy for the Cosmos DB database account.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
allowedHeaders	The request headers that the origin domain may specify on the CORS request.	string Optional
allowedMethods	The methods (HTTP request verbs) that the origin domain may use for a CORS request.	string Optional
allowedOrigins	The origin domains that are permitted to make a request against the service via CORS.	string Optional
exposedHeaders	The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.	string Optional
maxAgeInSeconds	The maximum amount time that a browser should cache the preflight OPTIONS request.	int Optional

CreateMode

Enum to indicate the mode of account creation.

Used by: DatabaseAccount_Spec, MongoDBCollectionResource, MongoDBDatabaseResource, SqlContainerResource, and SqlDatabaseResource.

Value	Description
“Default”
“Restore”

CreateMode_STATUS

Enum to indicate the mode of account creation.

Used by: DatabaseAccount_STATUS, MongoDBCollectionGetProperties_Resource_STATUS, MongoDBDatabaseGetProperties_Resource_STATUS, SqlContainerGetProperties_Resource_STATUS, and SqlDatabaseGetProperties_Resource_STATUS.

Value	Description
“Default”
“Restore”

CreateUpdateOptions

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

Used by: MongodbDatabase_Spec, MongodbDatabaseCollection_Spec, SqlDatabase_Spec, SqlDatabaseContainer_Spec, SqlDatabaseContainerStoredProcedure_Spec, SqlDatabaseContainerTrigger_Spec, and SqlDatabaseContainerUserDefinedFunction_Spec.

Property	Description	Type
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings Optional
throughput	Request Units per second. For example, “throughput”: 10000.	int Optional

DatabaseAccount_Kind_Spec

Used by: DatabaseAccount_Spec.

Value	Description
“GlobalDocumentDB”
“MongoDB”
“Parse”

DatabaseAccount_Kind_STATUS

Used by: DatabaseAccount_STATUS.

Value	Description
“GlobalDocumentDB”
“MongoDB”
“Parse”

DatabaseAccountKeysMetadata_STATUS

The metadata related to each access key for the given Cosmos DB database account.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
primaryMasterKey	The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.	AccountKeyMetadata_STATUS Optional
primaryReadonlyMasterKey	The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.	AccountKeyMetadata_STATUS Optional
secondaryMasterKey	The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.	AccountKeyMetadata_STATUS Optional
secondaryReadonlyMasterKey	The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.	AccountKeyMetadata_STATUS Optional

DatabaseAccountOfferType

The offer type for the Cosmos DB database account.

Used by: DatabaseAccount_Spec.

Value	Description
“Standard”

DatabaseAccountOfferType_STATUS

The offer type for the Cosmos DB database account.

Used by: DatabaseAccount_STATUS.

Value	Description
“Standard”

DatabaseAccountOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: DatabaseAccount_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional
secrets	configures where to place Azure generated secrets.	DatabaseAccountOperatorSecrets Optional

FailoverPolicy_STATUS

The failover policy for a given region of a database account.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
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.	int Optional
id	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.	string Optional
locationName	The name of the region in which the database account exists.	string Optional

IpAddressOrRange

IpAddressOrRange object

Used by: DatabaseAccount_Spec.

Property	Description	Type
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”.	string Optional

IpAddressOrRange_STATUS

IpAddressOrRange object

Used by: DatabaseAccount_STATUS.

Property	Description	Type
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”.	string Optional

Location

A region in which the Azure Cosmos DB database account is deployed.

Used by: DatabaseAccount_Spec.

Property	Description	Type
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.	int Optional
isZoneRedundant	Flag to indicate whether or not this region is an AvailabilityZone region	bool Optional
locationName	The name of the region.	string Optional

Location_STATUS

A region in which the Azure Cosmos DB database account is deployed.

Used by: DatabaseAccount_STATUS, DatabaseAccount_STATUS, and DatabaseAccount_STATUS.

Property	Description	Type
documentEndpoint	The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/	string Optional
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.	int Optional
id	The unique identifier of the region within the database account. Example: <accountName>-<locationName>.	string Optional
isZoneRedundant	Flag to indicate whether or not this region is an AvailabilityZone region	bool Optional
locationName	The name of the region.	string Optional
provisioningState		string Optional

ManagedServiceIdentity

Identity for the resource.

Used by: DatabaseAccount_Spec.

Property	Description	Type
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.	ManagedServiceIdentity_Type Optional
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}’.	UserAssignedIdentityDetails[] Optional

ManagedServiceIdentity_STATUS

Identity for the resource.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
principalId	The principal id of the system assigned identity. This property will only be provided for a system assigned identity.	string Optional
tenantId	The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.	string Optional
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.	ManagedServiceIdentity_Type_STATUS Optional
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}’.	map[string]ManagedServiceIdentity_UserAssignedIdentities_STATUS Optional

MinimalTlsVersion

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

Used by: DatabaseAccount_Spec.

Value	Description
“Tls”
“Tls11”
“Tls12”

MinimalTlsVersion_STATUS

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

Used by: DatabaseAccount_STATUS.

Value	Description
“Tls”
“Tls11”
“Tls12”

MongoDBCollectionGetProperties_Resource_STATUS

Used by: MongodbDatabaseCollection_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
analyticalStorageTtl	Analytical TTL.	int Optional
createMode	Enum to indicate the mode of resource creation.	CreateMode_STATUS Optional
id	Name of the Cosmos DB MongoDB collection	string Optional
indexes	List of index keys	MongoIndex_STATUS[] Optional
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase_STATUS Optional
shardKey	A key-value pair of shard keys to be applied for the request.	map[string]string Optional

MongoDBCollectionResource

Cosmos DB MongoDB collection resource object

Used by: MongodbDatabaseCollection_Spec.

Property	Description	Type
analyticalStorageTtl	Analytical TTL.	int Optional
createMode	Enum to indicate the mode of resource creation.	CreateMode Optional
id	Name of the Cosmos DB MongoDB collection	string Required
indexes	List of index keys	MongoIndex[] Optional
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase Optional
shardKey	A key-value pair of shard keys to be applied for the request.	map[string]string Optional

MongodbDatabaseCollectionOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: MongodbDatabaseCollection_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

MongodbDatabaseCollectionThroughputSettingOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: MongodbDatabaseCollectionThroughputSetting_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

MongoDBDatabaseGetProperties_Resource_STATUS

Used by: MongodbDatabase_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
createMode	Enum to indicate the mode of resource creation.	CreateMode_STATUS Optional
id	Name of the Cosmos DB MongoDB database	string Optional
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase_STATUS Optional

MongodbDatabaseOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: MongodbDatabase_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

MongoDBDatabaseResource

Cosmos DB MongoDB database resource object

Used by: MongodbDatabase_Spec.

Property	Description	Type
createMode	Enum to indicate the mode of resource creation.	CreateMode Optional
id	Name of the Cosmos DB MongoDB database	string Required
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase Optional

MongodbDatabaseThroughputSettingOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: MongodbDatabaseThroughputSetting_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

MongodbUserDefinitionOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: MongodbUserDefinition_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

NetworkAclBypass

Indicates what services are allowed to bypass firewall checks.

Used by: DatabaseAccount_Spec.

Value	Description
“AzureServices”
“None”

NetworkAclBypass_STATUS

Indicates what services are allowed to bypass firewall checks.

Used by: DatabaseAccount_STATUS.

Value	Description
“AzureServices”
“None”

OptionsResource_STATUS

Cosmos DB options resource object

Used by: MongodbDatabase_STATUS, MongodbDatabaseCollection_STATUS, SqlDatabase_STATUS, and SqlDatabaseContainer_STATUS.

Property	Description	Type
autoscaleSettings	Specifies the Autoscale settings.	AutoscaleSettings_STATUS Optional
throughput	Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.	int Optional

PrivateEndpointConnection_STATUS

A private endpoint connection

Used by: DatabaseAccount_STATUS.

Property	Description	Type
id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}	string Optional

PublicNetworkAccess

Whether requests from Public Network are allowed

Used by: DatabaseAccount_Spec.

Value	Description
“Disabled”
“Enabled”
“SecuredByPerimeter”

PublicNetworkAccess_STATUS

Whether requests from Public Network are allowed

Used by: DatabaseAccount_STATUS.

Value	Description
“Disabled”
“Enabled”
“SecuredByPerimeter”

RestoreParameters

Parameters to indicate the information about the restore.

Used by: DatabaseAccount_Spec.

Property	Description	Type
databasesToRestore	List of specific databases available for restore.	DatabaseRestoreResource[] Optional
gremlinDatabasesToRestore	List of specific gremlin databases available for restore.	GremlinDatabaseRestoreResource[] Optional
restoreMode	Describes the mode of the restore.	RestoreParameters_RestoreMode Optional
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}	string Optional
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string Optional
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool Optional
tablesToRestore	List of specific tables available for restore.	string[] Optional

RestoreParameters_STATUS

Parameters to indicate the information about the restore.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
databasesToRestore	List of specific databases available for restore.	DatabaseRestoreResource_STATUS[] Optional
gremlinDatabasesToRestore	List of specific gremlin databases available for restore.	GremlinDatabaseRestoreResource_STATUS[] Optional
restoreMode	Describes the mode of the restore.	RestoreParameters_RestoreMode_STATUS Optional
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}	string Optional
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string Optional
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool Optional
tablesToRestore	List of specific tables available for restore.	string[] Optional

Role

The set of roles permitted through this Role Definition.

Used by: MongodbUserDefinition_Spec.

Property	Description	Type
db	The database name the role is applied.	string Optional
role	The role name.	string Optional

Role_STATUS

The set of roles permitted through this Role Definition.

Used by: MongodbUserDefinition_STATUS.

Property	Description	Type
db	The database name the role is applied.	string Optional
role	The role name.	string Optional

SqlContainerGetProperties_Resource_STATUS

Used by: SqlDatabaseContainer_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
analyticalStorageTtl	Analytical TTL.	int Optional
clientEncryptionPolicy	The client encryption policy for the container.	ClientEncryptionPolicy_STATUS Optional
computedProperties	List of computed properties	ComputedProperty_STATUS[] Optional
conflictResolutionPolicy	The conflict resolution policy for the container.	ConflictResolutionPolicy_STATUS Optional
createMode	Enum to indicate the mode of resource creation.	CreateMode_STATUS Optional
defaultTtl	Default time to live	int Optional
id	Name of the Cosmos DB SQL container	string Optional
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container	IndexingPolicy_STATUS Optional
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey_STATUS Optional
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase_STATUS Optional
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy_STATUS Optional

SqlContainerResource

Cosmos DB SQL container resource object

Used by: SqlDatabaseContainer_Spec.

Property	Description	Type
analyticalStorageTtl	Analytical TTL.	int Optional
clientEncryptionPolicy	The client encryption policy for the container.	ClientEncryptionPolicy Optional
computedProperties	List of computed properties	ComputedProperty[] Optional
conflictResolutionPolicy	The conflict resolution policy for the container.	ConflictResolutionPolicy Optional
createMode	Enum to indicate the mode of resource creation.	CreateMode Optional
defaultTtl	Default time to live	int Optional
id	Name of the Cosmos DB SQL container	string Required
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container	IndexingPolicy Optional
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey Optional
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase Optional
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy Optional

SqlDatabaseContainerOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabaseContainer_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlDatabaseContainerStoredProcedureOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabaseContainerStoredProcedure_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlDatabaseContainerThroughputSettingOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabaseContainerThroughputSetting_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlDatabaseContainerTriggerOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabaseContainerTrigger_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlDatabaseContainerUserDefinedFunctionOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabaseContainerUserDefinedFunction_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlDatabaseGetProperties_Resource_STATUS

Used by: SqlDatabase_STATUS.

Property	Description	Type
_colls	A system generated property that specified the addressable path of the collections resource.	string Optional
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
_users	A system generated property that specifies the addressable path of the users resource.	string Optional
createMode	Enum to indicate the mode of resource creation.	CreateMode_STATUS Optional
id	Name of the Cosmos DB SQL database	string Optional
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase_STATUS Optional

SqlDatabaseOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabase_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlDatabaseResource

Cosmos DB SQL database resource object

Used by: SqlDatabase_Spec.

Property	Description	Type
createMode	Enum to indicate the mode of resource creation.	CreateMode Optional
id	Name of the Cosmos DB SQL database	string Required
restoreParameters	Parameters to indicate the information about the restore	RestoreParametersBase Optional

SqlDatabaseThroughputSettingOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlDatabaseThroughputSetting_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlRoleAssignmentOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: SqlRoleAssignment_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

SqlStoredProcedureGetProperties_Resource_STATUS

Used by: SqlDatabaseContainerStoredProcedure_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
body	Body of the Stored Procedure	string Optional
id	Name of the Cosmos DB SQL storedProcedure	string Optional

SqlStoredProcedureResource

Cosmos DB SQL storedProcedure resource object

Used by: SqlDatabaseContainerStoredProcedure_Spec.

Property	Description	Type
body	Body of the Stored Procedure	string Optional
id	Name of the Cosmos DB SQL storedProcedure	string Required

SqlTriggerGetProperties_Resource_STATUS

Used by: SqlDatabaseContainerTrigger_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
body	Body of the Trigger	string Optional
id	Name of the Cosmos DB SQL trigger	string Optional
triggerOperation	The operation the trigger is associated with	SqlTriggerGetProperties_Resource_TriggerOperation_STATUS Optional
triggerType	Type of the Trigger	SqlTriggerGetProperties_Resource_TriggerType_STATUS Optional

SqlTriggerResource

Cosmos DB SQL trigger resource object

Used by: SqlDatabaseContainerTrigger_Spec.

Property	Description	Type
body	Body of the Trigger	string Optional
id	Name of the Cosmos DB SQL trigger	string Required
triggerOperation	The operation the trigger is associated with	SqlTriggerResource_TriggerOperation Optional
triggerType	Type of the Trigger	SqlTriggerResource_TriggerType Optional

SqlUserDefinedFunctionGetProperties_Resource_STATUS

Used by: SqlDatabaseContainerUserDefinedFunction_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
body	Body of the User Defined Function	string Optional
id	Name of the Cosmos DB SQL userDefinedFunction	string Optional

SqlUserDefinedFunctionResource

Cosmos DB SQL userDefinedFunction resource object

Used by: SqlDatabaseContainerUserDefinedFunction_Spec.

Property	Description	Type
body	Body of the User Defined Function	string Optional
id	Name of the Cosmos DB SQL userDefinedFunction	string Required

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: DatabaseAccount_STATUS.

Property	Description	Type
createdAt	The timestamp of resource creation (UTC).	string Optional
createdBy	The identity that created the resource.	string Optional
createdByType	The type of identity that created the resource.	SystemData_CreatedByType_STATUS Optional
lastModifiedAt	The timestamp of resource last modification (UTC)	string Optional
lastModifiedBy	The identity that last modified the resource.	string Optional
lastModifiedByType	The type of identity that last modified the resource.	SystemData_LastModifiedByType_STATUS Optional

ThroughputSettingsGetProperties_Resource_STATUS

Used by: MongodbDatabaseCollectionThroughputSetting_STATUS, MongodbDatabaseThroughputSetting_STATUS, SqlDatabaseContainerThroughputSetting_STATUS, and SqlDatabaseThroughputSetting_STATUS.

Property	Description	Type
_etag	A system generated property representing the resource etag required for optimistic concurrency control.	string Optional
_rid	A system generated property. A unique identifier.	string Optional
_ts	A system generated property that denotes the last updated timestamp of the resource.	float64 Optional
autoscaleSettings	Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.	AutoscaleSettingsResource_STATUS Optional
instantMaximumThroughput	The offer throughput value to instantly scale up without triggering splits	string Optional
minimumThroughput	The minimum throughput of the resource	string Optional
offerReplacePending	The throughput replace is pending	string Optional
softAllowedMaximumThroughput	The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified	string Optional
throughput	Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.	int Optional

ThroughputSettingsResource

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

Used by: MongodbDatabaseCollectionThroughputSetting_Spec, MongodbDatabaseThroughputSetting_Spec, SqlDatabaseContainerThroughputSetting_Spec, and SqlDatabaseThroughputSetting_Spec.

Property	Description	Type
autoscaleSettings	Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.	AutoscaleSettingsResource Optional
throughput	Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.	int Optional

VirtualNetworkRule

Virtual Network ACL Rule object

Used by: DatabaseAccount_Spec.

Property	Description	Type
ignoreMissingVNetServiceEndpoint	Create firewall rule before the virtual network has vnet service endpoint enabled.	bool Optional
reference	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.	genruntime.ResourceReference Optional

VirtualNetworkRule_STATUS

Virtual Network ACL Rule object

Used by: DatabaseAccount_STATUS.

Property	Description	Type
id	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.	string Optional
ignoreMissingVNetServiceEndpoint	Create firewall rule before the virtual network has vnet service endpoint enabled.	bool Optional

AccountKeyMetadata_STATUS

The metadata related to an access key for a given database account.

Used by: DatabaseAccountKeysMetadata_STATUS, DatabaseAccountKeysMetadata_STATUS, DatabaseAccountKeysMetadata_STATUS, and DatabaseAccountKeysMetadata_STATUS.

Property	Description	Type
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.	string Optional

AnalyticalStorageSchemaType

Describes the types of schema for analytical storage.

Used by: AnalyticalStorageConfiguration.

Value	Description
“FullFidelity”
“WellDefined”

AnalyticalStorageSchemaType_STATUS

Describes the types of schema for analytical storage.

Used by: AnalyticalStorageConfiguration_STATUS.

Value	Description
“FullFidelity”
“WellDefined”

ApiProperties_ServerVersion

Used by: ApiProperties.

Value	Description
“3.2”
“3.6”
“4.0”
“4.2”
“5.0”
“6.0”
“7.0”

ApiProperties_ServerVersion_STATUS

Used by: ApiProperties_STATUS.

Value	Description
“3.2”
“3.6”
“4.0”
“4.2”
“5.0”
“6.0”
“7.0”

AutoscaleSettings

Used by: CreateUpdateOptions.

Property	Description	Type
maxThroughput	Represents maximum throughput, the resource can scale up to.	int Optional

AutoscaleSettings_STATUS

Used by: OptionsResource_STATUS.

Property	Description	Type
maxThroughput	Represents maximum throughput, the resource can scale up to.	int Optional

AutoscaleSettingsResource

Cosmos DB provisioned throughput settings object

Used by: ThroughputSettingsResource.

Property	Description	Type
autoUpgradePolicy	Cosmos DB resource auto-upgrade policy	AutoUpgradePolicyResource Optional
maxThroughput	Represents maximum throughput container can scale up to.	int Required

AutoscaleSettingsResource_STATUS

Cosmos DB provisioned throughput settings object

Used by: ThroughputSettingsGetProperties_Resource_STATUS.

Property	Description	Type
autoUpgradePolicy	Cosmos DB resource auto-upgrade policy	AutoUpgradePolicyResource_STATUS Optional
maxThroughput	Represents maximum throughput container can scale up to.	int Optional
targetMaxThroughput	Represents target maximum throughput container can scale up to once offer is no longer in pending state.	int Optional

ClientEncryptionPolicy

Cosmos DB client encryption policy.

Used by: SqlContainerResource.

Property	Description	Type
includedPaths	Paths of the item that need encryption along with path-specific settings.	ClientEncryptionIncludedPath[] Required
policyFormatVersion	Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.	int Required

ClientEncryptionPolicy_STATUS

Cosmos DB client encryption policy.

Used by: SqlContainerGetProperties_Resource_STATUS.

Property	Description	Type
includedPaths	Paths of the item that need encryption along with path-specific settings.	ClientEncryptionIncludedPath_STATUS[] Optional
policyFormatVersion	Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.	int Optional

ComputedProperty

The definition of a computed property

Used by: SqlContainerResource.

Property	Description	Type
name	The name of a computed property, for example - “cp_lowerName”	string Optional
query	The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c”	string Optional

ComputedProperty_STATUS

The definition of a computed property

Used by: SqlContainerGetProperties_Resource_STATUS.

Property	Description	Type
name	The name of a computed property, for example - “cp_lowerName”	string Optional
query	The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c”	string Optional

ConflictResolutionPolicy

The conflict resolution policy for the container.

Used by: SqlContainerResource.

Property	Description	Type
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string Optional
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string Optional
mode	Indicates the conflict resolution mode.	ConflictResolutionPolicy_Mode Optional

ConflictResolutionPolicy_STATUS

The conflict resolution policy for the container.

Used by: SqlContainerGetProperties_Resource_STATUS.

Property	Description	Type
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string Optional
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string Optional
mode	Indicates the conflict resolution mode.	ConflictResolutionPolicy_Mode_STATUS Optional

ConsistencyPolicy_DefaultConsistencyLevel

Used by: ConsistencyPolicy.

Value	Description
“BoundedStaleness”
“ConsistentPrefix”
“Eventual”
“Session”
“Strong”

ConsistencyPolicy_DefaultConsistencyLevel_STATUS

Used by: ConsistencyPolicy_STATUS.

Value	Description
“BoundedStaleness”
“ConsistentPrefix”
“Eventual”
“Session”
“Strong”

ContainerPartitionKey

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

Used by: SqlContainerResource.

Property	Description	Type
kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create	ContainerPartitionKey_Kind Optional
paths	List of paths using which data within the container can be partitioned	string[] Optional
version	Indicates the version of the partition key definition	int Optional

ContainerPartitionKey_STATUS

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

Used by: SqlContainerGetProperties_Resource_STATUS.

Property	Description	Type
kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create	ContainerPartitionKey_Kind_STATUS Optional
paths	List of paths using which data within the container can be partitioned	string[] Optional
systemKey	Indicates if the container is using a system generated partition key	bool Optional
version	Indicates the version of the partition key definition	int Optional

ContinuousModeBackupPolicy

Used by: BackupPolicy.

Property	Description	Type
continuousModeProperties	Configuration values for continuous mode backup	ContinuousModeProperties Optional
migrationState	The object representing the state of the migration between the backup policies.	BackupPolicyMigrationState Optional
type	Describes the mode of backups.	ContinuousModeBackupPolicy_Type Required

ContinuousModeBackupPolicy_STATUS

Used by: BackupPolicy_STATUS.

Property	Description	Type
continuousModeProperties	Configuration values for continuous mode backup	ContinuousModeProperties_STATUS Optional
migrationState	The object representing the state of the migration between the backup policies.	BackupPolicyMigrationState_STATUS Optional
type	Describes the mode of backups.	ContinuousModeBackupPolicy_Type_STATUS Optional

DatabaseAccountOperatorSecrets

Used by: DatabaseAccountOperatorSpec.

Property	Description	Type
documentEndpoint	indicates where the DocumentEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
primaryMasterKey	indicates where the PrimaryMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
primaryReadonlyMasterKey	indicates where the PrimaryReadonlyMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
secondaryMasterKey	indicates where the SecondaryMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
secondaryReadonlyMasterKey	indicates where the SecondaryReadonlyMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional

DatabaseRestoreResource

Specific Databases to restore.

Used by: RestoreParameters.

Property	Description	Type
collectionNames	The names of the collections available for restore.	string[] Optional
databaseName	The name of the database available for restore.	string Optional

DatabaseRestoreResource_STATUS

Specific Databases to restore.

Used by: RestoreParameters_STATUS.

Property	Description	Type
collectionNames	The names of the collections available for restore.	string[] Optional
databaseName	The name of the database available for restore.	string Optional

GremlinDatabaseRestoreResource

Specific Gremlin Databases to restore.

Used by: RestoreParameters.

Property	Description	Type
databaseName	The name of the gremlin database available for restore.	string Optional
graphNames	The names of the graphs available for restore.	string[] Optional

GremlinDatabaseRestoreResource_STATUS

Specific Gremlin Databases to restore.

Used by: RestoreParameters_STATUS.

Property	Description	Type
databaseName	The name of the gremlin database available for restore.	string Optional
graphNames	The names of the graphs available for restore.	string[] Optional

IndexingPolicy

Cosmos DB indexing policy

Used by: SqlContainerResource.

Property	Description	Type
automatic	Indicates if the indexing policy is automatic	bool Optional
compositeIndexes	List of composite path list	CompositePath[][] Optional
excludedPaths	List of paths to exclude from indexing	ExcludedPath[] Optional
includedPaths	List of paths to include in the indexing	IncludedPath[] Optional
indexingMode	Indicates the indexing mode.	IndexingPolicy_IndexingMode Optional
spatialIndexes	List of spatial specifics	SpatialSpec[] Optional

IndexingPolicy_STATUS

Cosmos DB indexing policy

Used by: SqlContainerGetProperties_Resource_STATUS.

Property	Description	Type
automatic	Indicates if the indexing policy is automatic	bool Optional
compositeIndexes	List of composite path list	CompositePath_STATUS[][] Optional
excludedPaths	List of paths to exclude from indexing	ExcludedPath_STATUS[] Optional
includedPaths	List of paths to include in the indexing	IncludedPath_STATUS[] Optional
indexingMode	Indicates the indexing mode.	IndexingPolicy_IndexingMode_STATUS Optional
spatialIndexes	List of spatial specifics	SpatialSpec_STATUS[] Optional

ManagedServiceIdentity_Type

Used by: ManagedServiceIdentity.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”

ManagedServiceIdentity_Type_STATUS

Used by: ManagedServiceIdentity_STATUS.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”

ManagedServiceIdentity_UserAssignedIdentities_STATUS

Used by: ManagedServiceIdentity_STATUS.

Property	Description	Type
clientId	The client id of user assigned identity.	string Optional
principalId	The principal id of user assigned identity.	string Optional

MongoIndex

Cosmos DB MongoDB collection index key

Used by: MongoDBCollectionResource.

Property	Description	Type
key	Cosmos DB MongoDB collection index keys	MongoIndexKeys Optional
options	Cosmos DB MongoDB collection index key options	MongoIndexOptions Optional

MongoIndex_STATUS

Cosmos DB MongoDB collection index key

Used by: MongoDBCollectionGetProperties_Resource_STATUS.

Property	Description	Type
key	Cosmos DB MongoDB collection index keys	MongoIndexKeys_STATUS Optional
options	Cosmos DB MongoDB collection index key options	MongoIndexOptions_STATUS Optional

PeriodicModeBackupPolicy

Used by: BackupPolicy.

Property	Description	Type
migrationState	The object representing the state of the migration between the backup policies.	BackupPolicyMigrationState Optional
periodicModeProperties	Configuration values for periodic mode backup	PeriodicModeProperties Optional
type	Describes the mode of backups.	PeriodicModeBackupPolicy_Type Required

PeriodicModeBackupPolicy_STATUS

Used by: BackupPolicy_STATUS.

Property	Description	Type
migrationState	The object representing the state of the migration between the backup policies.	BackupPolicyMigrationState_STATUS Optional
periodicModeProperties	Configuration values for periodic mode backup	PeriodicModeProperties_STATUS Optional
type	Describes the mode of backups.	PeriodicModeBackupPolicy_Type_STATUS Optional

RestoreParameters_RestoreMode

Used by: RestoreParameters.

Value	Description
“PointInTime”

RestoreParameters_RestoreMode_STATUS

Used by: RestoreParameters_STATUS.

Value	Description
“PointInTime”

RestoreParametersBase

Parameters to indicate the information about the restore.

Used by: MongoDBCollectionResource, MongoDBDatabaseResource, SqlContainerResource, and SqlDatabaseResource.

Property	Description	Type
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}	string Optional
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string Optional
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool Optional

RestoreParametersBase_STATUS

Parameters to indicate the information about the restore.

Used by: MongoDBCollectionGetProperties_Resource_STATUS, MongoDBDatabaseGetProperties_Resource_STATUS, SqlContainerGetProperties_Resource_STATUS, and SqlDatabaseGetProperties_Resource_STATUS.

Property	Description	Type
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}	string Optional
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string Optional
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool Optional

SqlTriggerGetProperties_Resource_TriggerOperation_STATUS

Used by: SqlTriggerGetProperties_Resource_STATUS.

Value	Description
“All”
“Create”
“Delete”
“Replace”
“Update”

SqlTriggerGetProperties_Resource_TriggerType_STATUS

Used by: SqlTriggerGetProperties_Resource_STATUS.

Value	Description
“Post”
“Pre”

SqlTriggerResource_TriggerOperation

Used by: SqlTriggerResource.

Value	Description
“All”
“Create”
“Delete”
“Replace”
“Update”

SqlTriggerResource_TriggerType

Used by: SqlTriggerResource.

Value	Description
“Post”
“Pre”

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value	Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value	Description
“Application”
“Key”
“ManagedIdentity”
“User”

UniqueKeyPolicy

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

Used by: SqlContainerResource.

Property	Description	Type
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[] Optional

UniqueKeyPolicy_STATUS

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

Used by: SqlContainerGetProperties_Resource_STATUS.

Property	Description	Type
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey_STATUS[] Optional

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: ManagedServiceIdentity.

Property	Description	Type
reference		genruntime.ResourceReference Optional

AutoUpgradePolicyResource

Cosmos DB resource auto-upgrade policy

Used by: AutoscaleSettingsResource.

Property	Description	Type
throughputPolicy	Represents throughput policy which service must adhere to for auto-upgrade	ThroughputPolicyResource Optional

AutoUpgradePolicyResource_STATUS

Cosmos DB resource auto-upgrade policy

Used by: AutoscaleSettingsResource_STATUS.

Property	Description	Type
throughputPolicy	Represents throughput policy which service must adhere to for auto-upgrade	ThroughputPolicyResource_STATUS Optional

BackupPolicyMigrationState

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

Used by: ContinuousModeBackupPolicy, and PeriodicModeBackupPolicy.

Property	Description	Type
startTime	Time at which the backup policy migration started (ISO-8601 format).	string Optional
status	Describes the status of migration between backup policy types.	BackupPolicyMigrationStatus Optional
targetType	Describes the target backup policy type of the backup policy migration.	BackupPolicyType Optional

BackupPolicyMigrationState_STATUS

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

Used by: ContinuousModeBackupPolicy_STATUS, and PeriodicModeBackupPolicy_STATUS.

Property	Description	Type
startTime	Time at which the backup policy migration started (ISO-8601 format).	string Optional
status	Describes the status of migration between backup policy types.	BackupPolicyMigrationStatus_STATUS Optional
targetType	Describes the target backup policy type of the backup policy migration.	BackupPolicyType_STATUS Optional

ClientEncryptionIncludedPath

Used by: ClientEncryptionPolicy.

Property	Description	Type
clientEncryptionKeyId	The identifier of the Client Encryption Key to be used to encrypt the path.	string Required
encryptionAlgorithm	The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.	string Required
encryptionType	The type of encryption to be performed. Eg - Deterministic, Randomized.	string Required
path	Path that needs to be encrypted.	string Required

ClientEncryptionIncludedPath_STATUS

Used by: ClientEncryptionPolicy_STATUS.

Property	Description	Type
clientEncryptionKeyId	The identifier of the Client Encryption Key to be used to encrypt the path.	string Optional
encryptionAlgorithm	The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.	string Optional
encryptionType	The type of encryption to be performed. Eg - Deterministic, Randomized.	string Optional
path	Path that needs to be encrypted.	string Optional

CompositePath

Used by: IndexingPolicy.

Property	Description	Type
order	Sort order for composite paths.	CompositePath_Order Optional
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional

CompositePath_STATUS

Used by: IndexingPolicy_STATUS.

Property	Description	Type
order	Sort order for composite paths.	CompositePath_Order_STATUS Optional
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional

ConflictResolutionPolicy_Mode

Used by: ConflictResolutionPolicy.

Value	Description
“Custom”
“LastWriterWins”

ConflictResolutionPolicy_Mode_STATUS

Used by: ConflictResolutionPolicy_STATUS.

Value	Description
“Custom”
“LastWriterWins”

ContainerPartitionKey_Kind

Used by: ContainerPartitionKey.

Value	Description
“Hash”
“MultiHash”
“Range”

ContainerPartitionKey_Kind_STATUS

Used by: ContainerPartitionKey_STATUS.

Value	Description
“Hash”
“MultiHash”
“Range”

ContinuousModeBackupPolicy_Type

Used by: ContinuousModeBackupPolicy.

Value	Description
“Continuous”

ContinuousModeBackupPolicy_Type_STATUS

Used by: ContinuousModeBackupPolicy_STATUS.

Value	Description
“Continuous”

ContinuousModeProperties

Configuration values for periodic mode backup

Used by: ContinuousModeBackupPolicy.

Property	Description	Type
tier	Enum to indicate type of Continuous backup mode	ContinuousTier Optional

ContinuousModeProperties_STATUS

Configuration values for periodic mode backup

Used by: ContinuousModeBackupPolicy_STATUS.

Property	Description	Type
tier	Enum to indicate type of Continuous backup mode	ContinuousTier_STATUS Optional

ExcludedPath

Used by: IndexingPolicy.

Property	Description	Type
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional

ExcludedPath_STATUS

Used by: IndexingPolicy_STATUS.

Property	Description	Type
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional

IncludedPath

The paths that are included in indexing

Used by: IndexingPolicy.

Property	Description	Type
indexes	List of indexes for this path	Indexes[] Optional
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional

IncludedPath_STATUS

The paths that are included in indexing

Used by: IndexingPolicy_STATUS.

Property	Description	Type
indexes	List of indexes for this path	Indexes_STATUS[] Optional
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional

IndexingPolicy_IndexingMode

Used by: IndexingPolicy.

Value	Description
“consistent”
“lazy”
“none”

IndexingPolicy_IndexingMode_STATUS

Used by: IndexingPolicy_STATUS.

Value	Description
“consistent”
“lazy”
“none”

MongoIndexKeys

Cosmos DB MongoDB collection resource object

Used by: MongoIndex.

Property	Description	Type
keys	List of keys for each MongoDB collection in the Azure Cosmos DB service	string[] Optional

MongoIndexKeys_STATUS

Cosmos DB MongoDB collection resource object

Used by: MongoIndex_STATUS.

Property	Description	Type
keys	List of keys for each MongoDB collection in the Azure Cosmos DB service	string[] Optional

MongoIndexOptions

Cosmos DB MongoDB collection index options

Used by: MongoIndex.

Property	Description	Type
expireAfterSeconds	Expire after seconds	int Optional
unique	Is unique or not	bool Optional

MongoIndexOptions_STATUS

Cosmos DB MongoDB collection index options

Used by: MongoIndex_STATUS.

Property	Description	Type
expireAfterSeconds	Expire after seconds	int Optional
unique	Is unique or not	bool Optional

PeriodicModeBackupPolicy_Type

Used by: PeriodicModeBackupPolicy.

Value	Description
“Periodic”

PeriodicModeBackupPolicy_Type_STATUS

Used by: PeriodicModeBackupPolicy_STATUS.

Value	Description
“Periodic”

PeriodicModeProperties

Configuration values for periodic mode backup

Used by: PeriodicModeBackupPolicy.

Property	Description	Type
backupIntervalInMinutes	An integer representing the interval in minutes between two backups	int Optional
backupRetentionIntervalInHours	An integer representing the time (in hours) that each backup is retained	int Optional
backupStorageRedundancy	Enum to indicate type of backup residency	BackupStorageRedundancy Optional

PeriodicModeProperties_STATUS

Configuration values for periodic mode backup

Used by: PeriodicModeBackupPolicy_STATUS.

Property	Description	Type
backupIntervalInMinutes	An integer representing the interval in minutes between two backups	int Optional
backupRetentionIntervalInHours	An integer representing the time (in hours) that each backup is retained	int Optional
backupStorageRedundancy	Enum to indicate type of backup residency	BackupStorageRedundancy_STATUS Optional

SpatialSpec

Used by: IndexingPolicy.

Property	Description	Type
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional
types	List of path’s spatial type	SpatialType[] Optional

SpatialSpec_STATUS

Used by: IndexingPolicy_STATUS.

Property	Description	Type
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string Optional
types	List of path’s spatial type	SpatialType_STATUS[] Optional

UniqueKey

The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

Used by: UniqueKeyPolicy.

Property	Description	Type
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[] Optional

UniqueKey_STATUS

The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

Used by: UniqueKeyPolicy_STATUS.

Property	Description	Type
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[] Optional

BackupPolicyMigrationStatus

Describes the status of migration between backup policy types.

Used by: BackupPolicyMigrationState.

Value	Description
“Completed”
“Failed”
“InProgress”
“Invalid”

BackupPolicyMigrationStatus_STATUS

Describes the status of migration between backup policy types.

Used by: BackupPolicyMigrationState_STATUS.

Value	Description
“Completed”
“Failed”
“InProgress”
“Invalid”

BackupPolicyType

Describes the mode of backups.

Used by: BackupPolicyMigrationState.

Value	Description
“Continuous”
“Periodic”

BackupPolicyType_STATUS

Describes the mode of backups.

Used by: BackupPolicyMigrationState_STATUS.

Value	Description
“Continuous”
“Periodic”

BackupStorageRedundancy

Enum to indicate type of backup storage redundancy.

Used by: PeriodicModeProperties.

Value	Description
“Geo”
“Local”
“Zone”

BackupStorageRedundancy_STATUS

Enum to indicate type of backup storage redundancy.

Used by: PeriodicModeProperties_STATUS.

Value	Description
“Geo”
“Local”
“Zone”

CompositePath_Order

Used by: CompositePath.

Value	Description
“ascending”
“descending”

CompositePath_Order_STATUS

Used by: CompositePath_STATUS.

Value	Description
“ascending”
“descending”

ContinuousTier

Enum to indicate type of Continuous backup tier.

Used by: ContinuousModeProperties.

Value	Description
“Continuous30Days”
“Continuous7Days”

ContinuousTier_STATUS

Enum to indicate type of Continuous backup tier.

Used by: ContinuousModeProperties_STATUS.

Value	Description
“Continuous30Days”
“Continuous7Days”

Indexes

The indexes for the path.

Used by: IncludedPath.

Property	Description	Type
dataType	The datatype for which the indexing behavior is applied to.	Indexes_DataType Optional
kind	Indicates the type of index.	Indexes_Kind Optional
precision	The precision of the index. -1 is maximum precision.	int Optional

Indexes_STATUS

The indexes for the path.

Used by: IncludedPath_STATUS.

Property	Description	Type
dataType	The datatype for which the indexing behavior is applied to.	Indexes_DataType_STATUS Optional
kind	Indicates the type of index.	Indexes_Kind_STATUS Optional
precision	The precision of the index. -1 is maximum precision.	int Optional

SpatialType

Indicates the spatial type of index.

Used by: SpatialSpec.

Value	Description
“LineString”
“MultiPolygon”
“Point”
“Polygon”

SpatialType_STATUS

Indicates the spatial type of index.

Used by: SpatialSpec_STATUS.

Value	Description
“LineString”
“MultiPolygon”
“Point”
“Polygon”

ThroughputPolicyResource

Cosmos DB resource throughput policy

Used by: AutoUpgradePolicyResource.

Property	Description	Type
incrementPercent	Represents the percentage by which throughput can increase every time throughput policy kicks in.	int Optional
isEnabled	Determines whether the ThroughputPolicy is active or not	bool Optional

ThroughputPolicyResource_STATUS

Cosmos DB resource throughput policy

Used by: AutoUpgradePolicyResource_STATUS.

Property	Description	Type
incrementPercent	Represents the percentage by which throughput can increase every time throughput policy kicks in.	int Optional
isEnabled	Determines whether the ThroughputPolicy is active or not	bool Optional

Indexes_DataType

Used by: Indexes.

Value	Description
“LineString”
“MultiPolygon”
“Number”
“Point”
“Polygon”
“String”

Indexes_DataType_STATUS

Used by: Indexes_STATUS.

Value	Description
“LineString”
“MultiPolygon”
“Number”
“Point”
“Polygon”
“String”

Indexes_Kind

Used by: Indexes.

Value	Description
“Hash”
“Range”
“Spatial”

Indexes_Kind_STATUS

Used by: Indexes_STATUS.

Value	Description
“Hash”
“Range”
“Spatial”