Package-level declarations

Types

Link copied to clipboard
data class AdministratorPropertiesResponse(val userName: String? = null)

The local administrator login properties.

Link copied to clipboard
data class BackupPropertiesResponse(val earliestRestoreTime: String)

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

Link copied to clipboard
data class ComputePropertiesResponse(val tier: String? = null)

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

Link copied to clipboard
data class ConnectionStringResponse(val connectionString: String, val description: String, val name: String)

Connection string for the mongo cluster

Link copied to clipboard
data class FirewallRulePropertiesResponse(val endIpAddress: String, val provisioningState: String, val startIpAddress: String)

The properties of a mongo cluster firewall rule.

Link copied to clipboard
data class GetFirewallRuleResult(val azureApiVersion: String, val id: String, val name: String, val properties: FirewallRulePropertiesResponse, val systemData: SystemDataResponse, val type: String)

Represents a mongo cluster firewall rule.

Link copied to clipboard
data class GetMongoClusterResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: MongoClusterPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a mongo cluster resource.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Link copied to clipboard
data class HighAvailabilityPropertiesResponse(val targetMode: String? = null)

The high availability properties of the cluster.

Link copied to clipboard

The connection strings for the given mongo cluster.

Link copied to clipboard
data class MongoClusterPropertiesResponse(val administrator: AdministratorPropertiesResponse? = null, val backup: BackupPropertiesResponse? = null, val clusterStatus: String, val compute: ComputePropertiesResponse? = null, val connectionString: String, val highAvailability: HighAvailabilityPropertiesResponse? = null, val infrastructureVersion: String, val previewFeatures: List<String>? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val replica: ReplicationPropertiesResponse, val serverVersion: String? = null, val sharding: ShardingPropertiesResponse? = null, val storage: StoragePropertiesResponse? = null)

The properties of a mongo cluster.

data class PrivateEndpointConnectionPropertiesResponse(val groupIds: List<String>, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String)

Properties of the private endpoint connection.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The private endpoint connection resource.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The private endpoint resource.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class ReplicationPropertiesResponse(val replicationState: String, val role: String, val sourceResourceId: String)

Replica properties of the mongo cluster.

Link copied to clipboard
data class ShardingPropertiesResponse(val shardCount: Int? = null)

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

Link copied to clipboard
data class StoragePropertiesResponse(val sizeGb: Double? = null)

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

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.