MongoClusterProperties interface
The properties of a mongo cluster.
Properties
| administrator | The local administrator properties for the mongo cluster. |
| auth |
The authentication configuration for the cluster. |
| backup | The backup properties of the mongo cluster. |
| cluster |
The status of the mongo cluster. |
| compute | The compute properties of the mongo cluster. |
| connection |
The default mongo connection string for the cluster. |
| create |
The mode to create a mongo cluster. |
| data |
The Data API properties of the mongo cluster. |
| encryption | The encryption configuration for the cluster. Depends on identity being configured. |
| high |
The high availability properties of the mongo cluster. |
| infrastructure |
The infrastructure version the cluster is provisioned on. |
| preview |
List of private endpoint connections. |
| private |
List of private endpoint connections. |
| provisioning |
The provisioning state of the mongo cluster. |
| public |
Whether or not public endpoint access is allowed for this mongo cluster. |
| replica | The replication properties for the mongo cluster |
| replica |
The parameters to create a replica mongo cluster. |
| restore |
The parameters to create a point-in-time restore mongo cluster. |
| server |
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?: AdministratorPropertiesProperty Value
authConfig
The authentication configuration for the cluster.
authConfig?: AuthConfigPropertiesProperty Value
backup
The backup properties of the mongo cluster.
backup?: BackupPropertiesProperty Value
clusterStatus
The status of the mongo cluster.
clusterStatus?: stringProperty Value
string
compute
The compute properties of the mongo cluster.
compute?: ComputePropertiesProperty Value
connectionString
The default mongo connection string for the cluster.
connectionString?: stringProperty Value
string
createMode
The mode to create a mongo cluster.
createMode?: stringProperty Value
string
dataApi
The Data API properties of the mongo cluster.
dataApi?: DataApiPropertiesProperty Value
encryption
The encryption configuration for the cluster. Depends on identity being configured.
encryption?: EncryptionPropertiesProperty Value
highAvailability
The high availability properties of the mongo cluster.
highAvailability?: HighAvailabilityPropertiesProperty Value
infrastructureVersion
The infrastructure version the cluster is provisioned on.
infrastructureVersion?: stringProperty Value
string
previewFeatures
List of private endpoint connections.
previewFeatures?: string[]Property Value
string[]
privateEndpointConnections
List of private endpoint connections.
privateEndpointConnections?: PrivateEndpointConnection[]Property Value
provisioningState
The provisioning state of the mongo cluster.
provisioningState?: stringProperty Value
string
publicNetworkAccess
Whether or not public endpoint access is allowed for this mongo cluster.
publicNetworkAccess?: stringProperty Value
string
replica
The replication properties for the mongo cluster
replica?: ReplicationPropertiesProperty Value
replicaParameters
The parameters to create a replica mongo cluster.
replicaParameters?: MongoClusterReplicaParametersProperty Value
restoreParameters
The parameters to create a point-in-time restore mongo cluster.
restoreParameters?: MongoClusterRestoreParametersProperty Value
serverVersion
The Mongo DB server version. Defaults to the latest available version if not specified.
serverVersion?: stringProperty Value
string
sharding
The sharding properties of the mongo cluster.
sharding?: ShardingPropertiesProperty Value
storage
The storage properties of the mongo cluster.
storage?: StorageProperties