MongoClusterUpdate interface

Package:

@azure/arm-cosmosdb

Represents a mongo cluster resource for updates.

Properties

administratorLogin	The administrator's login for the mongo cluster.
administratorLoginPassword	The password of the administrator login. This value contains a credential. Consider obscuring before showing to users
clusterStatus	A status of the mongo cluster. NOTE: This property will not be serialized. It can only be populated by the server.
connectionString	The default mongo connection string for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
createMode	The mode to create a mongo cluster.
earliestRestoreTime	Earliest restore timestamp in UTC ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
nodeGroupSpecs	The list of node group specs in the cluster.
provisioningState	A provisioning state of the mongo cluster. NOTE: This property will not be serialized. It can only be populated by the server.
restoreParameters	Parameters used for restore operations
serverVersion	The Mongo DB server version. Defaults to the latest available version if not specified.
tags	Application-specific metadata in the form of key-value pairs.

Property Details

administratorLogin

The administrator's login for the mongo cluster.

administratorLogin?: string

Property Value

string

administratorLoginPassword

The password of the administrator login. This value contains a credential. Consider obscuring before showing to users

administratorLoginPassword?: string

Property Value

string

clusterStatus

A status of the mongo cluster. NOTE: This property will not be serialized. It can only be populated by the server.

clusterStatus?: string

Property Value

string

connectionString

The default mongo connection string for the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

earliestRestoreTime?: string

Property Value

string

nodeGroupSpecs

The list of node group specs in the cluster.

nodeGroupSpecs?: NodeGroupSpec[]

Property Value

NodeGroupSpec[]

provisioningState

A provisioning state of the mongo cluster. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

restoreParameters

Parameters used for restore operations

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

tags

Application-specific metadata in the form of key-value pairs.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}