MongoClusterProperties interface

Package:

@azure/arm-mongocluster

The properties of a mongo cluster.

Properties

administratorLogin	The administrator's login for the mongo cluster.
administratorLoginPassword	The password of the administrator login.
clusterStatus	The status of the mongo cluster.
connectionString	The default mongo connection string for the cluster.
createMode	The mode to create a mongo cluster.
earliestRestoreTime	Earliest restore timestamp in UTC ISO8601 format.
infrastructureVersion	The infrastructure version the cluster is provisioned on.
nodeGroupSpecs	The list of node group specs in the cluster.
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.

Property Details

administratorLogin

The administrator's login for the mongo cluster.

administratorLogin?: string

Property Value

string

administratorLoginPassword

The password of the administrator login.

administratorLoginPassword?: string

Property Value

string

clusterStatus

The status of the mongo cluster.

clusterStatus?: string

Property Value

string

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

earliestRestoreTime

Earliest restore timestamp in UTC ISO8601 format.

earliestRestoreTime?: string

Property Value

string

infrastructureVersion

The infrastructure version the cluster is provisioned on.

infrastructureVersion?: string

Property Value

string

nodeGroupSpecs

The list of node group specs in the cluster.

nodeGroupSpecs?: NodeGroupSpec[]

Property Value

NodeGroupSpec[]

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