MongoClusterProperties interface

Package:

@azure/arm-mongocluster

The properties of a mongo cluster.

Properties

administrator	The local administrator properties for the mongo cluster.
backup	The backup properties of the mongo cluster.
clusterStatus	The status of the mongo cluster.
compute	The compute properties of the mongo cluster.
connectionString	The default mongo connection string for the cluster.
createMode	The mode to create a mongo cluster.
highAvailability	The high availability properties of the mongo cluster.
infrastructureVersion	The infrastructure version the cluster is provisioned on.
previewFeatures	List of private endpoint connections.
privateEndpointConnections	List of private endpoint connections.
provisioningState	The provisioning state of the mongo cluster.
publicNetworkAccess	Whether or not public endpoint access is allowed for this mongo cluster.
replica	The replication properties for the mongo cluster
replicaParameters	The parameters to create a replica mongo cluster.
restoreParameters	The parameters to create a point-in-time restore mongo cluster.
serverVersion	The Mongo DB server version. Defaults to the latest available version if not specified.
sharding	The sharding properties of the mongo cluster.
storage	The storage properties of the mongo cluster.

Property Details

administrator

The local administrator properties for the mongo cluster.

administrator?: AdministratorProperties

Property Value

AdministratorProperties

backup

The backup properties of the mongo cluster.

backup?: BackupProperties

Property Value

BackupProperties

clusterStatus

The status of the mongo cluster.

clusterStatus?: string

Property Value

string

compute

The compute properties of the mongo cluster.

compute?: ComputeProperties

Property Value

ComputeProperties

connectionString

The default mongo connection string for the cluster.

connectionString?: string

Property Value

string

createMode

The mode to create a mongo cluster.

createMode?: string

Property Value

string

highAvailability

The high availability properties of the mongo cluster.

highAvailability?: HighAvailabilityProperties

Property Value

HighAvailabilityProperties

infrastructureVersion

The infrastructure version the cluster is provisioned on.

infrastructureVersion?: string

Property Value

string

previewFeatures

List of private endpoint connections.

previewFeatures?: string[]

Property Value

string[]

privateEndpointConnections

List of private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioning state of the mongo cluster.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether or not public endpoint access is allowed for this mongo cluster.

publicNetworkAccess?: string

Property Value

string

replica

The replication properties for the mongo cluster

replica?: ReplicationProperties

Property Value

ReplicationProperties

replicaParameters

The parameters to create a replica mongo cluster.

replicaParameters?: MongoClusterReplicaParameters

Property Value

MongoClusterReplicaParameters

restoreParameters

The parameters to create a point-in-time restore mongo cluster.

restoreParameters?: MongoClusterRestoreParameters

Property Value

MongoClusterRestoreParameters

serverVersion

The Mongo DB server version. Defaults to the latest available version if not specified.

serverVersion?: string

Property Value

string

sharding

The sharding properties of the mongo cluster.

sharding?: ShardingProperties

Property Value

ShardingProperties

storage

The storage properties of the mongo cluster.

storage?: StorageProperties

Property Value

StorageProperties