@azure/arm-mongocluster package

Clases

MongoClusterManagementClient

Interfaces

AdministratorProperties	Propiedades de inicio de sesión del administrador local.
AuthConfigProperties	La configuración de autenticación para el clúster de Mongo.
BackupProperties	Propiedades de copia de seguridad del clúster. Esto incluye la configuración más antigua de tiempo de restauración y retención.
CheckNameAvailabilityRequest	Cuerpo de la solicitud de comprobación de disponibilidad.
CheckNameAvailabilityResponse	Resultado de la comprobación de disponibilidad.
ComputeProperties	Propiedades de proceso del clúster. Esto incluye las opciones de escalado y núcleos virtuales aplicados a los servidores del clúster.
ConnectionString	Cadena de conexión para el clúster de mongo
CustomerManagedKeyEncryptionProperties	Configuración de cifrado de claves administradas por el cliente.
DataApiProperties	Propiedades de la API de datos.
DatabaseRole	Definición de rol de base de datos asignada a un usuario.
EncryptionProperties	La configuración de cifrado para el clúster de mongo.
EntraIdentityProvider	Define un usuario de Mongo de ID de Microsoft Entra.
EntraIdentityProviderProperties	Propiedades del proveedor de identificadores de Microsoft Entra.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores.
FirewallRule	Representa una regla de firewall de clúster de Mongo.
FirewallRuleProperties	Las propiedades de una regla de firewall de clúster de Mongo.
FirewallRulesCreateOrUpdateOptionalParams	Parámetros opcionales.
FirewallRulesDeleteOptionalParams	Parámetros opcionales.
FirewallRulesGetOptionalParams	Parámetros opcionales.
FirewallRulesListByMongoClusterOptionalParams	Parámetros opcionales.
FirewallRulesOperations	Interfaz que representa una operación FirewallRules.
HighAvailabilityProperties	Propiedades de alta disponibilidad del clúster.
IdentityProvider	Define la definición del proveedor de identidades de un usuario.
KeyEncryptionKeyIdentity	La identidad utilizada para la clave de cifrado de claves.
ListConnectionStringsResult	Cadenas de conexión para el clúster de mongo especificado.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
MongoCluster	Representa un recurso de clúster de Mongo.
MongoClusterManagementClientOptionalParams	Parámetros opcionales para el cliente.
MongoClusterProperties	Propiedades de un clúster de Mongo.
MongoClusterReplicaParameters	Parámetros usados para las operaciones de réplica.
MongoClusterRestoreParameters	Parámetros usados para las operaciones de restauración
MongoClusterUpdate	Tipo usado para las operaciones de actualización de MongoCluster.
MongoClusterUpdateProperties	Las propiedades actualizables de MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Parámetros opcionales.
MongoClustersCreateOrUpdateOptionalParams	Parámetros opcionales.
MongoClustersDeleteOptionalParams	Parámetros opcionales.
MongoClustersGetOptionalParams	Parámetros opcionales.
MongoClustersListByResourceGroupOptionalParams	Parámetros opcionales.
MongoClustersListConnectionStringsOptionalParams	Parámetros opcionales.
MongoClustersListOptionalParams	Parámetros opcionales.
MongoClustersOperations	Interfaz que representa las operaciones de MongoClusters.
MongoClustersPromoteOptionalParams	Parámetros opcionales.
MongoClustersUpdateOptionalParams	Parámetros opcionales.
Operation	Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos
OperationDisplay	Información de visualización localizada para y operación.
OperationsListOptionalParams	Parámetros opcionales.
OperationsOperations	Interfaz que representa una operación de operaciones.
PageSettings	Opciones para el método byPage
PagedAsyncIterableIterator	Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.
PrivateEndpoint	Recurso de punto de conexión privado.
PrivateEndpointConnection	El recurso de conexión del punto de conexión privado
PrivateEndpointConnectionProperties	Propiedades de la conexión de punto de conexión privado.
PrivateEndpointConnectionResource	Los tipos de recursos de proxy concretos se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico.
PrivateEndpointConnectionsCreateOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsDeleteOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsGetOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsOperations	Interfaz que representa una operación PrivateEndpointConnections.
PrivateLinkResource	Los tipos de recursos de proxy concretos se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico.
PrivateLinkResourceProperties	Propiedades de un recurso de vínculo privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
PrivateLinksListByMongoClusterOptionalParams	Parámetros opcionales.
PrivateLinksOperations	Interfaz que representa las operaciones de PrivateLinks.
PromoteReplicaRequest	Promover las propiedades de la solicitud de réplica.
ProxyResource	Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación
Replica	Representa una réplica de clúster de Mongo.
ReplicasListByParentOptionalParams	Parámetros opcionales.
ReplicasOperations	Interfaz que representa las operaciones de réplicas.
ReplicationProperties	Propiedades de réplica del clúster de mongo.
Resource	Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager
RestorePollerOptions
ShardingProperties	Propiedades de particionamiento del clúster. Esto incluye las opciones de recuento de particiones y escalado del clúster.
StorageProperties	Propiedades de almacenamiento del clúster. Esto incluye el tamaño de almacenamiento de datos y el escalado aplicados a los servidores del clúster.
SystemData	Metadatos relativos a la creación y última modificación del recurso.
TrackedResource	La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación".
User	Representa a un usuario del clúster de Mongo.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
UserProperties	Definición del recurso de usuario de Mongo en un clúster.
UsersCreateOrUpdateOptionalParams	Parámetros opcionales.
UsersDeleteOptionalParams	Parámetros opcionales.
UsersGetOptionalParams	Parámetros opcionales.
UsersListByMongoClusterOptionalParams	Parámetros opcionales.
UsersOperations	Interfaz que representa las operaciones de los usuarios.

Alias de tipos

ActionType	Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas. KnownActionType se puede usar indistintamente con ActionType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio interno: las acciones son para las API solo internas.
AuthenticationMode	Los modos de autenticación compatibles con el clúster de Mongo. knownAuthenticationMode se puede usar indistintamente con AuthenticationMode, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio NativeAuth: Modo de autenticación nativo de mongo usando nombre de usuario y contraseña con mecanismo de autenticación 'SCRAM-SHA-256'. MicrosoftEntraID: modo de autenticación de ID de Microsoft Entra mediante usuarios de Entra asignados al clúster y al mecanismo de autenticación 'MONGODB-OIDC'.
AzureSupportedClouds	Los valores admitidos para la configuración de nube como un tipo literal de cadena
CheckNameAvailabilityReason	Posibles motivos para que un nombre no esté disponible. knownCheckNameAvailabilityReason se puede usar indistintamente con CheckNameAvailabilityReason, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio no válido: el nombre no es válido. YaExists: el nombre ya existe.
ContinuablePage	Interfaz que describe una página de resultados.
CreateMode	Modo con el que se crea el clúster de Mongo. KnownCreateMode se puede usar indistintamente con CreateMode, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Predeterminado: Crear un nuevo clúster de mongo. PointInTimeRestore: cree un clúster de mongo a partir de un punto de restauración en el tiempo. GeoReplica: cree un clúster de réplica en una región geográfica distinta del clúster de origen. Réplica: cree un clúster de réplica en la misma región geográfica que el clúster de origen.
CreatedByType	Tipo de entidad que creó el recurso. KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Usuario: un usuario creó la entidad. Application: la entidad la creó una aplicación. ManagedIdentity: la entidad se creó mediante una identidad administrada. Key: la entidad se creó mediante una clave.
DataApiMode	El modo que se aplicará a la API de datos de Mongo. KnownDataApiMode se puede usar indistintamente con DataApiMode, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Habilitado: Mongo Data API está habilitado para el clúster. Deshabilitado: la API de datos de Mongo está deshabilitada para el clúster.
EntraPrincipalType	Tipos de entidad de seguridad de Microsoft Entra ID disponibles para un usuario de Mongo. KnownEntraPrincipalType se puede usar indistintamente con EntraPrincipalType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio user: Tipo de usuario Entra. servicePrincipal: tipo de entidad de servicio de Entra.
HighAvailabilityMode	Modos de alta disponibilidad para un clúster. KnownHighAvailabilityMode se puede usar indistintamente con HighAvailabilityMode, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Deshabilitado: el modo de alta disponibilidad está deshabilitado. Este modo puede ver el impacto en la disponibilidad durante los errores o el mantenimiento y no se recomienda para producción. SameZone: se habilita el modo de alta disponibilidad, donde cada servidor de una partición se coloca en la misma zona de disponibilidad. ZoneRedundantPreferred: el modo de alta disponibilidad está habilitado y prefiere ZoneRedundant si la capacidad de las zonas de disponibilidad está disponible en la región, de lo contrario, se recurre al aprovisionamiento con SameZone.
IdentityProviderType	Tipos de proveedores de identidades a los que puede pertenecer una identidad de usuario. KnownIdentityProviderType se puede usar indistintamente con IdentityProviderType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio MicrosoftEntraID: proveedor de ID de Microsoft Entra.
IdentityProviderUnion	Alias de IdentityProviderUnion
KeyEncryptionKeyIdentityType	El tipo de identidad para la clave de cifrado de claves. KnownKeyEncryptionKeyIdentityType se puede usar indistintamente con KeyEncryptionKeyIdentityType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio UserAssignedIdentity: Identidad asignada por el usuario.
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned). KnownManagedServiceIdentityType se puede usar indistintamente con ManagedServiceIdentityType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Ninguno: ninguna identidad administrada. SystemAssigned: identidad administrada asignada por el sistema. userAssigned: identidad administrada asignada por el usuario. SystemAssigned,UserAssigned: identidad administrada asignada por el sistema y el usuario.
MongoClusterStatus	Estado del recurso de clúster de Mongo. KnownMongoClusterStatus se puede usar indistintamente con MongoClusterStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Listo: el recurso del clúster mongo está listo para su uso. Aprovisionamiento: se está aprovisionando el recurso de clúster mongo. Actualización: se está actualizando el recurso del clúster mongo. Iniciando: se está iniciando el recurso de clúster mongo. Deteniéndose: se está deteniendo el recurso del clúster mongo. Detenido: el recurso del clúster mongo está detenido. Descartar: se está quitando el recurso del clúster mongo.
Origin	Ejecutor previsto de la operación; como en control de acceso basado en recursos (RBAC) y la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema" KnownOrigin se puede usar indistintamente con Origin, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio usuario: indica que un usuario inicia la operación. del sistema: indica que un sistema inicia la operación. usuario,del sistema: indica que un usuario o sistema inicia la operación.
PreviewFeature	Características en versión preliminar que se pueden habilitar en un clúster de Mongo. KnownPreviewFeature se puede usar indistintamente con PreviewFeature, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio GeoReplicas: habilita la función de vista previa de réplicas geográficas. La característica debe establecerse en el momento de la creación en el nuevo clúster para permitir la vinculación de un clúster de réplica geográfica a él.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual. KnownPrivateEndpointConnectionProvisioningState se puede usar indistintamente con PrivateEndpointConnectionProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio correcto: se ha aprovisionado la conexión Crear: se está creando la conexión eliminar: se está eliminando la conexión Error: Error en el aprovisionamiento de conexiones
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado. knownPrivateEndpointServiceConnectionStatus se puede usar indistintamente con PrivateEndpointServiceConnectionStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Pendiente: Conexión en espera de aprobación o rechazo aprobado: conexión aprobada rechazado: conexión rechazada
PromoteMode	Modo que se va a aplicar a una operación de promoción. KnownPromoteMode se puede usar indistintamente con PromoteMode, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Cambio: la promoción cambiará el clúster de réplica actual al rol principal y el principal original se cambiará a un rol de réplica, manteniendo el vínculo de replicación.
PromoteOption	Opción para aplicar a una operación de promoción. KnownPromoteOption se puede usar indistintamente con PromoteOption, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Forzado: la opción Promover fuerza la promoción sin esperar a que la réplica se ponga al día con la principal. Esto puede provocar la pérdida de datos, por lo que solo debe usarse durante escenarios de recuperación ante desastres.
ProvisioningState	Estado de aprovisionamiento de la última operación aceptada. KnownProvisioningState se puede usar indistintamente con ProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Correcto: se ha creado el recurso. Error: Error en la creación de recursos. cancelada: se canceló la creación de recursos. InProgress: hay una operación en curso en el recurso. Actualización: hay una operación de actualización en curso en el recurso. Descarte: hay una operación de colocación en curso en el recurso.
PublicNetworkAccess	Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo. El valor es opcional y el valor predeterminado es "Enabled" KnownPublicNetworkAccess se puede usar indistintamente con PublicNetworkAccess, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Habilitado: Si se establece, se puede acceder al clúster de mongo a través de métodos privados y públicos. Deshabilitado: si se establece, los puntos de conexión privados son el método de acceso exclusivo.
ReplicationRole	Rol de replicación del clúster de mongo. knownReplicationRole se puede usar indistintamente con ReplicationRole, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Principal: el clúster es una réplica principal. AsyncReplica: el clúster es una réplica asincrónica local. GeoAsyncReplica: el clúster es una réplica asincrónica geográfica.
ReplicationState	Estado del vínculo de replicación entre la réplica y el clúster de origen. KnownReplicationState se puede usar indistintamente con ReplicationState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Activo: el vínculo de replicación está activo. Ponerse al día: la réplica se está poniendo al día con la principal. Esto puede ocurrir después de crear la réplica o después de desencadenar una promoción. Aprovisionamiento: se está creando un vínculo de réplica y replicación al principal. Actualización: el vínculo de replicación se está actualizando debido a un cambio en la réplica o una actualización. Roto: el vínculo de replicación está roto y es posible que sea necesario volver a crear la réplica. Reconfiguración: el vínculo de replicación se está reconfigurando debido a un evento de promoción.
StorageType	El tipo de almacenamiento con el que se puede aprovisionar un clúster de mongo. KnownStorageType se puede usar indistintamente con StorageType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio PremiumSSD: SSD premium para cargas de trabajo de alto rendimiento. PremiumSSDv2: SSD premium v2 para cargas de trabajo muy intensivas en E/S. Esta es una opción de vista previa y tiene limitaciones adicionales.
UserRole	Rol de base de datos integrado que se puede asignar a un usuario. KnownUserRole se puede usar indistintamente con UserRole, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio root: permisos de rol raíz en el ámbito de destino.

Enumeraciones

AzureClouds	Una enumeración para describir los entornos de la nube de Azure.
KnownActionType	Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.
KnownAuthenticationMode	Los modos de autenticación compatibles con el clúster de Mongo.
KnownCheckNameAvailabilityReason	Posibles motivos para que un nombre no esté disponible.
KnownCreateMode	Modo con el que se crea el clúster de Mongo.
KnownCreatedByType	Tipo de entidad que creó el recurso.
KnownDataApiMode	El modo que se aplicará a la API de datos de Mongo.
KnownEntraPrincipalType	Tipos de entidad de seguridad de Microsoft Entra ID disponibles para un usuario de Mongo.
KnownHighAvailabilityMode	Modos de alta disponibilidad para un clúster.
KnownIdentityProviderType	Tipos de proveedores de identidades a los que puede pertenecer una identidad de usuario.
KnownKeyEncryptionKeyIdentityType	El tipo de identidad para la clave de cifrado de claves.
KnownManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
KnownMongoClusterStatus	Estado del recurso de clúster de Mongo.
KnownOrigin	Ejecutor previsto de la operación; como en control de acceso basado en recursos (RBAC) y la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"
KnownPreviewFeature	Características en versión preliminar que se pueden habilitar en un clúster de Mongo.
KnownPrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
KnownPrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
KnownPromoteMode	Modo que se va a aplicar a una operación de promoción.
KnownPromoteOption	Opción para aplicar a una operación de promoción.
KnownProvisioningState	Estado de aprovisionamiento de la última operación aceptada.
KnownPublicNetworkAccess	Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo. El valor es opcional y el valor predeterminado es 'Habilitado'
KnownReplicationRole	Rol de replicación del clúster de mongo.
KnownReplicationState	Estado del vínculo de replicación entre la réplica y el clúster de origen.
KnownStorageType	El tipo de almacenamiento con el que se puede aprovisionar un clúster de mongo.
KnownUserRole	Rol de base de datos integrado que se puede asignar a un usuario.
KnownVersions	Las versiones de API disponibles.

Funciones

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

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

Detalles de la función

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

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

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

Parámetros

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Devoluciones

PollerLike<OperationState<TResult>, TResult>