@azure/arm-mongocluster package

Classes

MongoClusterManagementClient

Interfaces

AdministratorProperties	Propriétés de connexion de l’administrateur local.
AuthConfigProperties	Configuration de l’authentification pour le cluster Mongo.
BackupProperties	Propriétés de sauvegarde du cluster. Cela inclut les paramètres de durée de restauration et de rétention les plus anciens.
CheckNameAvailabilityRequest	Corps de la demande de disponibilité de vérification.
CheckNameAvailabilityResponse	Résultat de la vérification de la disponibilité.
ComputeProperties	Propriétés de calcul du cluster. Cela inclut les options de mémoire/cœurs virtuels et de mise à l’échelle appliquées aux serveurs du cluster.
ConnectionString	Chaîne de connexion pour le cluster mongo
CustomerManagedKeyEncryptionProperties	Paramètres de chiffrement de clé gérée par le client.
DataApiProperties	Propriétés de l’API de données.
DatabaseRole	Définition du rôle de base de données attribué à un utilisateur.
EncryptionProperties	Configuration du chiffrement pour le cluster mongo.
EntraIdentityProvider	Définit un utilisateur Microsoft Entra ID Mongo.
EntraIdentityProviderProperties	Propriétés du fournisseur Microsoft Entra ID.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué.
FirewallRule	Représente une règle de pare-feu de cluster mongo.
FirewallRuleProperties	Propriétés d’une règle de pare-feu de cluster mongo.
FirewallRulesCreateOrUpdateOptionalParams	Paramètres facultatifs.
FirewallRulesDeleteOptionalParams	Paramètres facultatifs.
FirewallRulesGetOptionalParams	Paramètres facultatifs.
FirewallRulesListByMongoClusterOptionalParams	Paramètres facultatifs.
FirewallRulesOperations	Interface représentant des opérations FirewallRules.
HighAvailabilityProperties	Propriétés de haute disponibilité du cluster.
IdentityProvider	Définit la définition du fournisseur d’identité d’un utilisateur.
KeyEncryptionKeyIdentity	Identité utilisée pour la clé de chiffrement de clé.
ListConnectionStringsResult	Chaînes de connexion pour le cluster mongo donné.
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
MongoCluster	Représente une ressource de cluster mongo.
MongoClusterManagementClientOptionalParams	Paramètres facultatifs pour le client.
MongoClusterProperties	Propriétés d’un cluster mongo.
MongoClusterReplicaParameters	Paramètres utilisés pour les opérations de réplica.
MongoClusterRestoreParameters	Paramètres utilisés pour les opérations de restauration
MongoClusterUpdate	Type utilisé pour les opérations de mise à jour du MongoCluster.
MongoClusterUpdateProperties	Propriétés pouvant être mises à jour du MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Paramètres facultatifs.
MongoClustersCreateOrUpdateOptionalParams	Paramètres facultatifs.
MongoClustersDeleteOptionalParams	Paramètres facultatifs.
MongoClustersGetOptionalParams	Paramètres facultatifs.
MongoClustersListByResourceGroupOptionalParams	Paramètres facultatifs.
MongoClustersListConnectionStringsOptionalParams	Paramètres facultatifs.
MongoClustersListOptionalParams	Paramètres facultatifs.
MongoClustersOperations	Interface représentant des opérations MongoClusters.
MongoClustersPromoteOptionalParams	Paramètres facultatifs.
MongoClustersUpdateOptionalParams	Paramètres facultatifs.
Operation	Détails d’une opération d’API REST, retournée par l’API d’opérations du fournisseur de ressources
OperationDisplay	Informations d’affichage localisées pour et opération.
OperationsListOptionalParams	Paramètres facultatifs.
OperationsOperations	Interface représentant des opérations.
PageSettings	Options de la méthode byPage
PagedAsyncIterableIterator	Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.
PrivateEndpoint	Ressource de point de terminaison privé.
PrivateEndpointConnection	Ressource de connexion de point de terminaison privé
PrivateEndpointConnectionProperties	Propriétés de la connexion de point de terminaison privé.
PrivateEndpointConnectionResource	Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.
PrivateEndpointConnectionsCreateOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsDeleteOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsGetOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsOperations	Interface représentant des opérations PrivateEndpointConnections.
PrivateLinkResource	Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.
PrivateLinkResourceProperties	Propriétés d’une ressource de liaison privée.
PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
PrivateLinksListByMongoClusterOptionalParams	Paramètres facultatifs.
PrivateLinksOperations	Interface représentant des opérations PrivateLinks.
PromoteReplicaRequest	Promouvoir les propriétés de la demande de réplica.
ProxyResource	Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement
Replica	Représente un réplica de cluster mongo.
ReplicasListByParentOptionalParams	Paramètres facultatifs.
ReplicasOperations	Interface représentant des opérations de réplicas.
ReplicationProperties	Propriétés du réplica du cluster mongo.
Resource	Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager
RestorePollerOptions
ShardingProperties	Propriétés de partitionnement du cluster. Cela inclut le nombre de partitions et les options de mise à l’échelle pour le cluster.
StorageProperties	Propriétés de stockage du cluster. Cela inclut la taille de stockage des données et la mise à l’échelle appliquées aux serveurs du cluster.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TrackedResource	Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »
User	Représente un utilisateur du cluster Mongo.
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
UserProperties	Définition de la ressource utilisateur Mongo sur un cluster.
UsersCreateOrUpdateOptionalParams	Paramètres facultatifs.
UsersDeleteOptionalParams	Paramètres facultatifs.
UsersGetOptionalParams	Paramètres facultatifs.
UsersListByMongoClusterOptionalParams	Paramètres facultatifs.
UsersOperations	Interface représentant une opération d’utilisateurs.

Alias de type

ActionType	Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement. KnownActionType peut être utilisé de manière interchangeable avec ActionType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service interne : les actions sont destinées aux API internes uniquement.
AuthenticationMode	Les modes d’authentification pris en charge sur le cluster Mongo. KnownAuthenticationMode pouvez être utilisé de manière interchangeable avec AuthenticationMode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service NativeAuth : Mode d’authentification mongo natif utilisant le nom d’utilisateur et le mot de passe avec le mécanisme d’authentification 'SCRAM-SHA-256'. MicrosoftEntraID : mode d’authentification Microsoft Entra ID utilisant les utilisateurs Entra affectés au cluster et au mécanisme d’authentification « MONGODB-OIDC ».
AzureSupportedClouds	Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne
CheckNameAvailabilityReason	Raisons possibles d’un nom non disponible. KnownCheckNameAvailabilityReason pouvez être utilisé de manière interchangeable avec CheckNameAvailabilityReason, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service non valide : le nom n’est pas valide. AlreadyExists: le nom existe déjà.
ContinuablePage	Interface qui décrit une page de résultats.
CreateMode	Mode avec lequel le cluster Mongo est créé. KnownCreateMode peut être utilisé de manière interchangeable avec CreateMode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Par défaut : Créez un cluster mongo. PointInTimeRestore : créez un cluster mongo à partir d’une restauration à un point dans le temps. GeoReplica : créez un cluster de réplica dans une région géographique distincte du cluster source. Réplica : créez un cluster de réplica dans la même région géographique que le cluster source.
CreatedByType	Type d’entité qui a créé la ressource. KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service 'utilisateur: l’entité a été créée par un utilisateur. Application: l’entité a été créée par une application. ManagedIdentity: l’entité a été créée par une identité managée. Key: l’entité a été créée par une clé.
DataApiMode	Mode à appliquer à l’API Mongo Data. KnownDataApiMode peut être utilisé de manière interchangeable avec DataApiMode, cette énumération contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service Activé : l’API de données Mongo est activée pour le cluster. Désactivé : l’API de données Mongo est désactivée pour le cluster.
EntraPrincipalType	Types principaux d’ID Microsoft Entra disponibles pour un utilisateur Mongo. KnownEntraPrincipalType peut être utilisé de manière interchangeable avec EntraPrincipalType, cette énumération contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service user : type d’utilisateur Entra. servicePrincipal : type de principal de service Entra.
HighAvailabilityMode	Modes de haute disponibilité d’un cluster. KnownHighAvailabilityMode peut être utilisé de manière interchangeable avec HighAvailabilityMode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Désactivé : le mode haute disponibilité est désactivé. Ce mode peut voir l’impact de la disponibilité en cas de panne ou de maintenance et n’est pas recommandé pour la production. SameZone : le mode haute disponibilité est activé, où chaque serveur d’une partition est placé dans la même zone de disponibilité. ZoneRedundantPreferred : le mode haute disponibilité est activé et les préférences ZoneRedundant si la capacité des zones de disponibilité est disponible dans la région, sinon le provisionnement avec SameZone est effectué.
IdentityProviderType	Types de fournisseur d’identité auxquels l’identité d’un utilisateur peut appartenir. KnownIdentityProviderType pouvez être utilisé de manière interchangeable avec IdentityProviderType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service MicrosoftEntraID : fournisseur d’ID Microsoft Entra.
IdentityProviderUnion	Alias pour IdentityProviderUnion
KeyEncryptionKeyIdentityType	Type d’identité de la clé de chiffrement de clé. KnownKeyEncryptionKeyIdentityType peut être utilisé de manière interchangeable avec KeyEncryptionKeyIdentityType, cette énumération contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service UserAssignedIdentity : identité affectée par l’utilisateur.
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). KnownManagedServiceIdentityType pouvez être utilisé de manière interchangeable avec ManagedServiceIdentityType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Aucun: aucune identité managée. SystemAssigned: identité managée affectée par le système. UserAssigned : identité managée affectée par l’utilisateur. SystemAssigned,UserAssigned: identité managée affectée par le système et l’utilisateur.
MongoClusterStatus	État de la ressource de cluster Mongo. KnownMongoClusterStatus peut être utilisé de manière interchangeable avec MongoClusterStatus, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Prêt : la ressource de cluster mongo est prête à l’emploi. Provisionnement : la ressource de cluster mongo est en cours d’approvisionnement. Mise à jour : la ressource de cluster mongo est en cours de mise à jour. Démarrage : la ressource de cluster mongo est en cours de démarrage. Arrêt : la ressource de cluster mongo est en cours d’arrêt. Arrêté : la ressource de cluster mongo est arrêtée. Suppression : la ressource de cluster mongo est supprimée.
Origin	Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système » KnownOrigin peut être utilisé de manière interchangeable avec Origin, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service 'utilisateur: indique que l’opération est lancée par un utilisateur. système: indique que l’opération est lancée par un système. utilisateur,système: indique que l’opération est lancée par un utilisateur ou un système.
PreviewFeature	Fonctionnalités en préversion qui peuvent être activées sur un cluster mongo. KnownPreviewFeature peut être utilisé de manière interchangeable avec PreviewFeature, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service GeoReplicas : active la fonction de prévisualisation des réplicas géographiques. La fonctionnalité doit être définie au moment de la création sur un nouveau cluster pour permettre la liaison d’un cluster de géoréplica à celui-ci.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement actuel. KnownPrivateEndpointConnectionProvisioningState peut être utilisé de manière interchangeable avec PrivateEndpointConnectionProvisioningState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service réussi: la connexion a été provisionnée Création de: la connexion est en cours de création suppression de: la connexion est supprimée échec: le provisionnement de connexions a échoué
PrivateEndpointServiceConnectionStatus	État de la connexion de point de terminaison privé. KnownPrivateEndpointServiceConnectionStatus peut être utilisé de manière interchangeable avec PrivateEndpointServiceConnectionStatus, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service En attente : Connexion en attente d’approbation ou de rejet approuvé : connexion approuvée rejeté : connexion rejetée
PromoteMode	Mode à appliquer à une opération de promotion. KnownPromoteMode peut être utilisé de manière interchangeable avec PromoteMode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Basculement : la promotion bascule le cluster de réplica actuel vers le rôle principal et le cluster principal d’origine est basculé vers un rôle de réplication, en conservant le lien de réplication.
PromoteOption	Option à appliquer à une opération de promotion. KnownPromoteOption pouvez être utilisé de manière interchangeable avec PromoteOption, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Forcé : l’option Promouvoir force la promotion sans attendre que la réplique soit rattrapée par la réplique principale. Cela peut entraîner une perte de données et ne doit être utilisé que lors de scénarios de récupération d’urgence.
ProvisioningState	État d’approvisionnement de la dernière opération acceptée. KnownProvisioningState peut être utilisé de manière interchangeable avec ProvisioningState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service réussi: la ressource a été créée. échec: échec de la création de ressources. annulé : la création de ressources a été annulée. InProgress : une opération est en cours sur la ressource. Mise à jour : une opération de mise à jour est en cours sur la ressource. Suppression : une opération de suppression est en cours sur la ressource.
PublicNetworkAccess	Indique si l’accès au point de terminaison public est autorisé pour ce cluster Mongo. La valeur est facultative et la valeur par défaut est « Enabled » KnownPublicNetworkAccess peuvent être utilisés de manière interchangeable avec PublicNetworkAccess, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Activé : si cette option est définie, le cluster mongo est accessible via des méthodes privées et publiques. Désactivé : si cette option est définie, les points de terminaison privés sont la méthode d’accès exclusif.
ReplicationRole	Rôle de réplication du cluster mongo. KnownReplicationRole peut être utilisé de manière interchangeable avec ReplicationRole, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Principal : le cluster est un réplica principal. AsyncReplica : le cluster est un réplica asynchrone local. GeoAsyncReplica : le cluster est un réplica géo-asynchrone.
ReplicationState	État du lien de réplication entre le réplica et le cluster source. KnownReplicationState peut être utilisé de manière interchangeable avec ReplicationState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Actif : le lien de réplication est actif. Rattrapage : la réplique rattrape le principal. Cela peut se produire après la création de la réplique ou après le déclenchement d’une promotion. Provisionnement : le lien de réplication et de réplication vers le serveur principal est en cours de création. Mise à jour : le lien de réplication est mis à jour en raison d’une modification apportée au réplica ou d’une mise à niveau. Rompu : le lien de réplication est rompu et il peut être nécessaire de recréer le réplica. Reconfiguration : le lien de réplication est en cours de reconfiguration en raison d’un événement de promotion.
StorageType	Type de stockage avec lequel un cluster mongo peut être provisionné. KnownStorageType peut être utilisé de manière interchangeable avec StorageType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service PremiumSSD : SSD haut de gamme pour les charges de travail hautes performances. PremiumSSDv2 : SSD premium v2 pour les charges de travail très gourmandes en E/S. Il s’agit d’une option d’aperçu qui présente des limitations supplémentaires.
UserRole	Rôle de base de données intégré qui peut être attribué à un utilisateur. KnownUserRole peut être utilisé de manière interchangeable avec UserRole, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service root : autorisations de rôle racine sur l’étendue cible.

Énumérations

AzureClouds	Une énumération pour décrire les environnements Cloud Azure.
KnownActionType	Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.
KnownAuthenticationMode	Les modes d’authentification pris en charge sur le cluster Mongo.
KnownCheckNameAvailabilityReason	Raisons possibles d’un nom non disponible.
KnownCreateMode	Mode avec lequel le cluster Mongo est créé.
KnownCreatedByType	Type d’entité qui a créé la ressource.
KnownDataApiMode	Mode à appliquer à l’API Mongo Data.
KnownEntraPrincipalType	Types principaux d’ID Microsoft Entra disponibles pour un utilisateur Mongo.
KnownHighAvailabilityMode	Modes de haute disponibilité d’un cluster.
KnownIdentityProviderType	Types de fournisseur d’identité auxquels l’identité d’un utilisateur peut appartenir.
KnownKeyEncryptionKeyIdentityType	Type d’identité de la clé de chiffrement de clé.
KnownManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
KnownMongoClusterStatus	État de la ressource de cluster Mongo.
KnownOrigin	Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système »
KnownPreviewFeature	Fonctionnalités en préversion qui peuvent être activées sur un cluster mongo.
KnownPrivateEndpointConnectionProvisioningState	État d’approvisionnement actuel.
KnownPrivateEndpointServiceConnectionStatus	État de la connexion de point de terminaison privé.
KnownPromoteMode	Mode à appliquer à une opération de promotion.
KnownPromoteOption	Option à appliquer à une opération de promotion.
KnownProvisioningState	État d’approvisionnement de la dernière opération acceptée.
KnownPublicNetworkAccess	Indique si l’accès au point de terminaison public est autorisé pour ce cluster Mongo. La valeur est facultative et la valeur par défaut est « Activé »
KnownReplicationRole	Rôle de réplication du cluster mongo.
KnownReplicationState	État du lien de réplication entre le réplica et le cluster source.
KnownStorageType	Type de stockage avec lequel un cluster mongo peut être provisionné.
KnownUserRole	Rôle de base de données intégré qui peut être attribué à un utilisateur.
KnownVersions	Versions d’API disponibles.

Functions

restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

Informations relatives à la fonction

restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Paramètres

client

MongoClusterManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retours

PollerLike<OperationState<TResult>, TResult>