documentdb.azure.com/v1api20240701


APIVersion

Value Description
“2024-07-01”

FirewallRule

Generator information: - Generated from: /mongocluster/resource-manager/Microsoft.DocumentDB/stable/2024-07-01/mongoCluster.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​mongoClusters/​{mongoClusterName}/​firewallRules/​{firewallRuleName}

Used by: FirewallRuleList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec FirewallRule_Spec
Optional
status FirewallRule_STATUS
Optional

FirewallRule_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 FirewallRuleOperatorSpec
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/MongoCluster resource genruntime.KnownResourceReference
Required
properties The resource-specific properties for this resource. FirewallRuleProperties
Optional

FirewallRule_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
properties The resource-specific properties for this resource. FirewallRuleProperties_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

FirewallRuleList

Generator information: - Generated from: /mongocluster/resource-manager/Microsoft.DocumentDB/stable/2024-07-01/mongoCluster.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​mongoClusters/​{mongoClusterName}/​firewallRules/​{firewallRuleName}

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

MongoCluster

Generator information: - Generated from: /mongocluster/resource-manager/Microsoft.DocumentDB/stable/2024-07-01/mongoCluster.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​mongoClusters/​{mongoClusterName}

Used by: MongoClusterList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec MongoCluster_Spec
Optional
status MongoCluster_STATUS
Optional

MongoCluster_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 geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure MongoClusterOperatorSpec
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
properties The resource-specific properties for this resource. MongoClusterProperties
Optional
tags Resource tags. map[string]string
Optional

MongoCluster_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
properties The resource-specific properties for this resource. MongoClusterProperties_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

MongoClusterList

Generator information: - Generated from: /mongocluster/resource-manager/Microsoft.DocumentDB/stable/2024-07-01/mongoCluster.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​mongoClusters/​{mongoClusterName}

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

FirewallRule_Spec

Used by: FirewallRule.

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 FirewallRuleOperatorSpec
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/MongoCluster resource genruntime.KnownResourceReference
Required
properties The resource-specific properties for this resource. FirewallRuleProperties
Optional

FirewallRule_STATUS

Used by: FirewallRule.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
properties The resource-specific properties for this resource. FirewallRuleProperties_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

MongoCluster_Spec

Used by: MongoCluster.

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 geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure MongoClusterOperatorSpec
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
properties The resource-specific properties for this resource. MongoClusterProperties
Optional
tags Resource tags. map[string]string
Optional

MongoCluster_STATUS

Represents a mongo cluster resource.

Used by: MongoCluster.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
properties The resource-specific properties for this resource. MongoClusterProperties_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

FirewallRuleOperatorSpec

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

Used by: FirewallRule_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

FirewallRuleProperties

The properties of a mongo cluster firewall rule.

Used by: FirewallRule_Spec.

Property Description Type
endIpAddress The end IP address of the mongo cluster firewall rule. Must be IPv4 format. string
Required
startIpAddress The start IP address of the mongo cluster firewall rule. Must be IPv4 format. string
Required

FirewallRuleProperties_STATUS

The properties of a mongo cluster firewall rule.

Used by: FirewallRule_STATUS.

Property Description Type
endIpAddress The end IP address of the mongo cluster firewall rule. Must be IPv4 format. string
Optional
provisioningState The provisioning state of the firewall rule. ProvisioningState_STATUS
Optional
startIpAddress The start IP address of the mongo cluster firewall rule. Must be IPv4 format. string
Optional

MongoClusterOperatorSpec

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

Used by: MongoCluster_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

MongoClusterProperties

The properties of a mongo cluster.

Used by: MongoCluster_Spec.

Property Description Type
administrator The local administrator properties for the mongo cluster. AdministratorProperties
Optional
compute The compute properties of the mongo cluster. ComputeProperties
Optional
createMode The mode to create a mongo cluster. CreateMode
Optional
highAvailability The high availability properties of the mongo cluster. HighAvailabilityProperties
Optional
previewFeatures List of private endpoint connections. PreviewFeature[]
Optional
publicNetworkAccess Whether or not public endpoint access is allowed for this mongo cluster. PublicNetworkAccess
Optional
replicaParameters The parameters to create a replica mongo cluster. MongoClusterReplicaParameters
Optional
restoreParameters The parameters to create a point-in-time restore mongo cluster. MongoClusterRestoreParameters
Optional
serverVersion The Mongo DB server version. Defaults to the latest available version if not specified. string
Optional
sharding The sharding properties of the mongo cluster. ShardingProperties
Optional
storage The storage properties of the mongo cluster. StorageProperties
Optional

MongoClusterProperties_STATUS

The properties of a mongo cluster.

Used by: MongoCluster_STATUS.

Property Description Type
administrator The local administrator properties for the mongo cluster. AdministratorProperties_STATUS
Optional
backup The backup properties of the mongo cluster. BackupProperties_STATUS
Optional
clusterStatus The status of the mongo cluster. MongoClusterStatus_STATUS
Optional
compute The compute properties of the mongo cluster. ComputeProperties_STATUS
Optional
connectionString The default mongo connection string for the cluster. string
Optional
createMode The mode to create a mongo cluster. CreateMode_STATUS
Optional
highAvailability The high availability properties of the mongo cluster. HighAvailabilityProperties_STATUS
Optional
infrastructureVersion The infrastructure version the cluster is provisioned on. string
Optional
previewFeatures List of private endpoint connections. PreviewFeature_STATUS[]
Optional
privateEndpointConnections List of private endpoint connections. PrivateEndpointConnection_STATUS[]
Optional
provisioningState The provisioning state of the mongo cluster. ProvisioningState_STATUS
Optional
publicNetworkAccess Whether or not public endpoint access is allowed for this mongo cluster. PublicNetworkAccess_STATUS
Optional
replica The replication properties for the mongo cluster ReplicationProperties_STATUS
Optional
replicaParameters The parameters to create a replica mongo cluster. MongoClusterReplicaParameters_STATUS
Optional
restoreParameters The parameters to create a point-in-time restore mongo cluster. MongoClusterRestoreParameters_STATUS
Optional
serverVersion The Mongo DB server version. Defaults to the latest available version if not specified. string
Optional
sharding The sharding properties of the mongo cluster. ShardingProperties_STATUS
Optional
storage The storage properties of the mongo cluster. StorageProperties_STATUS
Optional

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: FirewallRule_STATUS, and MongoCluster_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

AdministratorProperties

The local administrator login properties.

Used by: MongoClusterProperties.

Property Description Type
password The administrator password. genruntime.SecretReference
Optional
userName The administrator user name. string
Optional

AdministratorProperties_STATUS

The local administrator login properties.

Used by: MongoClusterProperties_STATUS.

Property Description Type
userName The administrator user name. string
Optional

BackupProperties_STATUS

The backup properties of the cluster. This includes the earliest restore time and retention settings.

Used by: MongoClusterProperties_STATUS.

Property Description Type
earliestRestoreTime Earliest restore timestamp in UTC ISO8601 format. string
Optional

ComputeProperties

The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster.

Used by: MongoClusterProperties.

Property Description Type
tier The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: M30, M40. string
Optional

ComputeProperties_STATUS

The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster.

Used by: MongoClusterProperties_STATUS.

Property Description Type
tier The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: M30, M40. string
Optional

CreateMode

The mode that the Mongo Cluster is created with.

Used by: MongoClusterProperties.

Value Description
“Default”
“GeoReplica”
“PointInTimeRestore”
“Replica”

CreateMode_STATUS

The mode that the Mongo Cluster is created with.

Used by: MongoClusterProperties_STATUS.

Value Description
“Default”
“GeoReplica”
“PointInTimeRestore”
“Replica”

HighAvailabilityProperties

The high availability properties of the cluster.

Used by: MongoClusterProperties.

Property Description Type
targetMode The target high availability mode requested for the cluster. HighAvailabilityMode
Optional

HighAvailabilityProperties_STATUS

The high availability properties of the cluster.

Used by: MongoClusterProperties_STATUS.

Property Description Type
targetMode The target high availability mode requested for the cluster. HighAvailabilityMode_STATUS
Optional

MongoClusterReplicaParameters

Parameters used for replica operations.

Used by: MongoClusterProperties.

Property Description Type
sourceLocation The location of the source cluster string
Required
sourceResourceReference The id of the replication source cluster. genruntime.ResourceReference
Required

MongoClusterReplicaParameters_STATUS

Parameters used for replica operations.

Used by: MongoClusterProperties_STATUS.

Property Description Type
sourceLocation The location of the source cluster string
Optional
sourceResourceId The id of the replication source cluster. string
Optional

MongoClusterRestoreParameters

Parameters used for restore operations

Used by: MongoClusterProperties.

Property Description Type
pointInTimeUTC UTC point in time to restore a mongo cluster string
Optional
sourceResourceReference Resource ID to locate the source cluster to restore genruntime.ResourceReference
Optional

MongoClusterRestoreParameters_STATUS

Parameters used for restore operations

Used by: MongoClusterProperties_STATUS.

Property Description Type
pointInTimeUTC UTC point in time to restore a mongo cluster string
Optional
sourceResourceId Resource ID to locate the source cluster to restore string
Optional

MongoClusterStatus_STATUS

The status of the Mongo cluster resource.

Used by: MongoClusterProperties_STATUS.

Value Description
“Dropping”
“Provisioning”
“Ready”
“Starting”
“Stopped”
“Stopping”
“Updating”

PreviewFeature

Preview features that can be enabled on a mongo cluster.

Used by: MongoClusterProperties.

Value Description
“GeoReplicas”

PreviewFeature_STATUS

Preview features that can be enabled on a mongo cluster.

Used by: MongoClusterProperties_STATUS.

Value Description
“GeoReplicas”

PrivateEndpointConnection_STATUS

The private endpoint connection resource.

Used by: MongoClusterProperties_STATUS.

Property Description Type
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional

ProvisioningState_STATUS

The provisioning state of the last accepted operation.

Used by: FirewallRuleProperties_STATUS, and MongoClusterProperties_STATUS.

Value Description
“Canceled”
“Dropping”
“Failed”
“InProgress”
“Succeeded”
“Updating”

PublicNetworkAccess

Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is Enabled

Used by: MongoClusterProperties.

Value Description
“Disabled”
“Enabled”

PublicNetworkAccess_STATUS

Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is Enabled

Used by: MongoClusterProperties_STATUS.

Value Description
“Disabled”
“Enabled”

ReplicationProperties_STATUS

Replica properties of the mongo cluster.

Used by: MongoClusterProperties_STATUS.

Property Description Type
replicationState The replication link state of the replica cluster. ReplicationState_STATUS
Optional
role The replication role of the cluster ReplicationRole_STATUS
Optional
sourceResourceId The resource id the source cluster for the replica cluster. string
Optional

ShardingProperties

The sharding properties of the cluster. This includes the shard count and scaling options for the cluster.

Used by: MongoClusterProperties.

Property Description Type
shardCount Number of shards to provision on the cluster. int
Optional

ShardingProperties_STATUS

The sharding properties of the cluster. This includes the shard count and scaling options for the cluster.

Used by: MongoClusterProperties_STATUS.

Property Description Type
shardCount Number of shards to provision on the cluster. int
Optional

StorageProperties

The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster.

Used by: MongoClusterProperties.

Property Description Type
sizeGb The size of the data disk assigned to each server. int
Optional

StorageProperties_STATUS

The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster.

Used by: MongoClusterProperties_STATUS.

Property Description Type
sizeGb The size of the data disk assigned to each server. int
Optional

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”

HighAvailabilityMode

The high availability modes for a cluster.

Used by: HighAvailabilityProperties.

Value Description
“Disabled”
“SameZone”
“ZoneRedundantPreferred”

HighAvailabilityMode_STATUS

The high availability modes for a cluster.

Used by: HighAvailabilityProperties_STATUS.

Value Description
“Disabled”
“SameZone”
“ZoneRedundantPreferred”

ReplicationRole_STATUS

Replication role of the mongo cluster.

Used by: ReplicationProperties_STATUS.

Value Description
“AsyncReplica”
“GeoAsyncReplica”
“Primary”

ReplicationState_STATUS

The state of the replication link between the replica and source cluster.

Used by: ReplicationProperties_STATUS.

Value Description
“Active”
“Broken”
“Catchup”
“Provisioning”
“Reconfiguring”
“Updating”