@azure/arm-mongocluster package

The local administrator login properties.

The authentication configuration for the Mongo cluster.

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

The check availability request body.

The check availability result.

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

Connection string for the mongo cluster

Customer managed key encryption settings.

Data API properties.

Database role definition that is assigned to a user.

The encryption configuration for the mongo cluster.

Defines a Microsoft Entra ID Mongo user.

Microsoft Entra ID provider properties.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Represents a mongo cluster firewall rule.

The properties of a mongo cluster firewall rule.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a FirewallRules operations.

The high availability properties of the cluster.

Defines a user's identity provider definition.

The identity used for key encryption key.

The connection strings for the given mongo cluster.

Managed service identity (system assigned and/or user assigned identities)

Represents a mongo cluster resource.

Optional parameters for the client.

The properties of a mongo cluster.

Parameters used for replica operations.

Parameters used for restore operations

The type used for update operations of the MongoCluster.

The updatable properties of the MongoCluster.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a MongoClusters operations.

Optional parameters.

Optional parameters.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for and operation.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

The private endpoint resource.

The private endpoint connection resource

Properties of the private endpoint connection.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateEndpointConnections operations.

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

Properties of a private link resource.

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

Optional parameters.

Interface representing a PrivateLinks operations.

Promote replica request properties.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Represents a mongo cluster replica.

Optional parameters.

Interface representing a Replicas operations.

Replica properties of the mongo cluster.

Common fields that are returned in the response for all Azure Resource Manager resources

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

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

Metadata pertaining to creation and last modification of the resource.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Represents a Mongo cluster user.

User assigned identity properties

Definition of Mongo user resource on a cluster.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Users operations.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

The authentication modes supporting on the Mongo cluster.
KnownAuthenticationMode can be used interchangeably with AuthenticationMode, this enum contains the known values that the service supports.

Known values supported by the service

NativeAuth: Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'.
MicrosoftEntraID: Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'.

The supported values for cloud setting as a string literal type

Possible reasons for a name not being available.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Name is invalid.
AlreadyExists: Name already exists.

An interface that describes a page of results.

The mode that the Mongo Cluster is created with.
KnownCreateMode can be used interchangeably with CreateMode, this enum contains the known values that the service supports.

Known values supported by the service

Default: Create a new mongo cluster.
PointInTimeRestore: Create a mongo cluster from a restore point-in-time.
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster.
Replica: Create a replica cluster in the same geographic region as the source cluster.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

The mode to apply to the Mongo Data API.
KnownDataApiMode can be used interchangeably with DataApiMode, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Mongo Data API is enabled for the cluster.
Disabled: Mongo Data API is disabled for the cluster.

Microsoft Entra ID principal types available for a Mongo user.
KnownEntraPrincipalType can be used interchangeably with EntraPrincipalType, this enum contains the known values that the service supports.

Known values supported by the service

user: Entra user type.
servicePrincipal: Entra service principal type.

The high availability modes for a cluster.
KnownHighAvailabilityMode can be used interchangeably with HighAvailabilityMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production.
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone.
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone.

Identity provider types that a a user identity can belong to.
KnownIdentityProviderType can be used interchangeably with IdentityProviderType, this enum contains the known values that the service supports.

Known values supported by the service

MicrosoftEntraID: Microsoft Entra ID provider.

Alias for IdentityProviderUnion

The type of identity for key encryption key.
KnownKeyEncryptionKeyIdentityType can be used interchangeably with KeyEncryptionKeyIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

UserAssignedIdentity: User assigned identity.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

The status of the Mongo cluster resource.
KnownMongoClusterStatus can be used interchangeably with MongoClusterStatus, this enum contains the known values that the service supports.

Known values supported by the service

Ready: The mongo cluster resource is ready for use.
Provisioning: The mongo cluster resource is being provisioned.
Updating: The mongo cluster resource is being updated.
Starting: The mongo cluster resource is being started.
Stopping: The mongo cluster resource is being stopped.
Stopped: The mongo cluster resource is stopped.
Dropping: The mongo cluster resource is being dropped.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

Preview features that can be enabled on a mongo cluster.
KnownPreviewFeature can be used interchangeably with PreviewFeature, this enum contains the known values that the service supports.

Known values supported by the service

GeoReplicas: Enables geo replicas preview feature. The feature must be set at create-time on new cluster to enable linking a geo-replica cluster to it.

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Connection has been provisioned
Creating: Connection is being created
Deleting: Connection is being deleted
Failed: Connection provisioning has failed

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

The mode to apply to a promote operation.
KnownPromoteMode can be used interchangeably with PromoteMode, this enum contains the known values that the service supports.

Known values supported by the service

Switchover: Promotion will switch the current replica cluster to the primary role and the original primary will be switched to a replica role, maintaining the replication link.

The option to apply to a promote operation.
KnownPromoteOption can be used interchangeably with PromoteOption, this enum contains the known values that the service supports.

Known values supported by the service

Forced: Promote option forces the promotion without waiting for the replica to be caught up to the primary. This can result in data-loss so should only be used during disaster recovery scenarios.

The provisioning state of the last accepted operation.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
InProgress: An operation is in-progress on the resource.
Updating: An update operation is in-progress on the resource.
Dropping: A drop operation is in-progress on the resource.

Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is 'Enabled'
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: If set, mongo cluster can be accessed through private and public methods.
Disabled: If set, the private endpoints are the exclusive access method.

Replication role of the mongo cluster.
KnownReplicationRole can be used interchangeably with ReplicationRole, this enum contains the known values that the service supports.

Known values supported by the service

Primary: The cluster is a primary replica.
AsyncReplica: The cluster is a local asynchronous replica.
GeoAsyncReplica: The cluster is a geo-asynchronous replica.

The state of the replication link between the replica and source cluster.
KnownReplicationState can be used interchangeably with ReplicationState, this enum contains the known values that the service supports.

Known values supported by the service

Active: Replication link is active.
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered.
Provisioning: Replica and replication link to the primary is being created.
Updating: Replication link is being updated due to a change on the replica or an upgrade.
Broken: Replication link is broken and the replica may need to be recreated.
Reconfiguring: Replication link is re-configuring due to a promotion event.

The type of storage that a mongo cluster can be provisioned with.
KnownStorageType can be used interchangeably with StorageType, this enum contains the known values that the service supports.

Known values supported by the service

PremiumSSD: Premium SSD for high performance workloads.
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations.

Built-in database role that can be assigned to a user.
KnownUserRole can be used interchangeably with UserRole, this enum contains the known values that the service supports.

Known values supported by the service

root: Root role permissions on the target scope.

An enum to describe Azure Cloud environments.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

The authentication modes supporting on the Mongo cluster.

Possible reasons for a name not being available.

The mode that the Mongo Cluster is created with.

The kind of entity that created the resource.

The mode to apply to the Mongo Data API.

Microsoft Entra ID principal types available for a Mongo user.

The high availability modes for a cluster.

Identity provider types that a a user identity can belong to.

The type of identity for key encryption key.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

The status of the Mongo cluster resource.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Preview features that can be enabled on a mongo cluster.

The current provisioning state.

The private endpoint connection status.

The mode to apply to a promote operation.

The option to apply to a promote operation.

The provisioning state of the last accepted operation.

Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is 'Enabled'

Replication role of the mongo cluster.

The state of the replication link between the replica and source cluster.

The type of storage that a mongo cluster can be provisioned with.

Built-in database role that can be assigned to a user.

The available API versions.

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.