ArmMongoClusterModelFactory.MongoClusterProperties Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public static Azure.ResourceManager.MongoCluster.Models.MongoClusterProperties MongoClusterProperties(Azure.ResourceManager.MongoCluster.Models.MongoClusterCreateMode? createMode = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterRestoreContent restoreParameters = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterReplicaContent replicaParameters = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterAdministratorProperties administrator = default, string serverVersion = default, string connectionString = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterProvisioningState? provisioningState = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterStatus? clusterStatus = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterPublicNetworkAccess? publicNetworkAccess = default, Azure.ResourceManager.MongoCluster.Models.HighAvailabilityMode? highAvailabilityTargetMode = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterStorageProperties storage = default, int? shardingShardCount = default, string computeTier = default, string backupEarliestRestoreTime = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterDataApiMode? dataApiMode = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.MongoCluster.Models.MongoClusterPrivateEndpointConnection> privateEndpointConnections = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.MongoCluster.Models.MongoClusterPreviewFeature> previewFeatures = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterReplicationProperties replica = default, string infrastructureVersion = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.MongoCluster.Models.MongoClusterAuthenticationMode> authConfigAllowedModes = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterCmkEncryptionProperties customerManagedKeyEncryption = default, Azure.ResourceManager.MongoCluster.Models.MongoClusterNetworkBypassMode? networkBypassMode = default);
static member MongoClusterProperties : Nullable<Azure.ResourceManager.MongoCluster.Models.MongoClusterCreateMode> * Azure.ResourceManager.MongoCluster.Models.MongoClusterRestoreContent * Azure.ResourceManager.MongoCluster.Models.MongoClusterReplicaContent * Azure.ResourceManager.MongoCluster.Models.MongoClusterAdministratorProperties * string * string * Nullable<Azure.ResourceManager.MongoCluster.Models.MongoClusterProvisioningState> * Nullable<Azure.ResourceManager.MongoCluster.Models.MongoClusterStatus> * Nullable<Azure.ResourceManager.MongoCluster.Models.MongoClusterPublicNetworkAccess> * Nullable<Azure.ResourceManager.MongoCluster.Models.HighAvailabilityMode> * Azure.ResourceManager.MongoCluster.Models.MongoClusterStorageProperties * Nullable<int> * string * string * Nullable<Azure.ResourceManager.MongoCluster.Models.MongoClusterDataApiMode> * seq<Azure.ResourceManager.MongoCluster.Models.MongoClusterPrivateEndpointConnection> * seq<Azure.ResourceManager.MongoCluster.Models.MongoClusterPreviewFeature> * Azure.ResourceManager.MongoCluster.Models.MongoClusterReplicationProperties * string * seq<Azure.ResourceManager.MongoCluster.Models.MongoClusterAuthenticationMode> * Azure.ResourceManager.MongoCluster.Models.MongoClusterCmkEncryptionProperties * Nullable<Azure.ResourceManager.MongoCluster.Models.MongoClusterNetworkBypassMode> -> Azure.ResourceManager.MongoCluster.Models.MongoClusterProperties
Public Shared Function MongoClusterProperties (Optional createMode As Nullable(Of MongoClusterCreateMode) = Nothing, Optional restoreParameters As MongoClusterRestoreContent = Nothing, Optional replicaParameters As MongoClusterReplicaContent = Nothing, Optional administrator As MongoClusterAdministratorProperties = Nothing, Optional serverVersion As String = Nothing, Optional connectionString As String = Nothing, Optional provisioningState As Nullable(Of MongoClusterProvisioningState) = Nothing, Optional clusterStatus As Nullable(Of MongoClusterStatus) = Nothing, Optional publicNetworkAccess As Nullable(Of MongoClusterPublicNetworkAccess) = Nothing, Optional highAvailabilityTargetMode As Nullable(Of HighAvailabilityMode) = Nothing, Optional storage As MongoClusterStorageProperties = Nothing, Optional shardingShardCount As Nullable(Of Integer) = Nothing, Optional computeTier As String = Nothing, Optional backupEarliestRestoreTime As String = Nothing, Optional dataApiMode As Nullable(Of MongoClusterDataApiMode) = Nothing, Optional privateEndpointConnections As IEnumerable(Of MongoClusterPrivateEndpointConnection) = Nothing, Optional previewFeatures As IEnumerable(Of MongoClusterPreviewFeature) = Nothing, Optional replica As MongoClusterReplicationProperties = Nothing, Optional infrastructureVersion As String = Nothing, Optional authConfigAllowedModes As IEnumerable(Of MongoClusterAuthenticationMode) = Nothing, Optional customerManagedKeyEncryption As MongoClusterCmkEncryptionProperties = Nothing, Optional networkBypassMode As Nullable(Of MongoClusterNetworkBypassMode) = Nothing) As MongoClusterProperties
Parameters
- createMode
- Nullable<MongoClusterCreateMode>
The mode to create a mongo cluster.
- restoreParameters
- MongoClusterRestoreContent
The parameters to create a point-in-time restore mongo cluster.
- replicaParameters
- MongoClusterReplicaContent
The parameters to create a replica mongo cluster.
- administrator
- MongoClusterAdministratorProperties
The local administrator properties for the mongo cluster.
- serverVersion
- String
The Mongo DB server version. Defaults to the latest available version if not specified.
- connectionString
- String
The default mongo connection string for the cluster.
- provisioningState
- Nullable<MongoClusterProvisioningState>
The provisioning state of the mongo cluster.
- clusterStatus
- Nullable<MongoClusterStatus>
The status of the mongo cluster.
- publicNetworkAccess
- Nullable<MongoClusterPublicNetworkAccess>
Whether or not public endpoint access is allowed for this mongo cluster.
- highAvailabilityTargetMode
- Nullable<HighAvailabilityMode>
The target high availability mode requested for the cluster.
- storage
- MongoClusterStorageProperties
The storage properties of the mongo cluster.
- computeTier
- String
The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'.
- backupEarliestRestoreTime
- String
Earliest restore timestamp in UTC ISO8601 format.
- dataApiMode
- Nullable<MongoClusterDataApiMode>
The mode to indicate whether the Mongo Data API is enabled for a cluster.
- privateEndpointConnections
- IEnumerable<MongoClusterPrivateEndpointConnection>
List of private endpoint connections.
- previewFeatures
- IEnumerable<MongoClusterPreviewFeature>
List of private endpoint connections.
The replication properties for the mongo cluster.
- infrastructureVersion
- String
The infrastructure version the cluster is provisioned on.
- authConfigAllowedModes
- IEnumerable<MongoClusterAuthenticationMode>
Allowed authentication modes for data access on the cluster.
- customerManagedKeyEncryption
- MongoClusterCmkEncryptionProperties
Customer managed key encryption settings.
- networkBypassMode
- Nullable<MongoClusterNetworkBypassMode>
The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows Azure Cosmos DB service to bypass network restrictions.
Returns
A new MongoClusterProperties instance for mocking.