@azure/arm-mongodbatlas package

Clases

AtlasClient

Interfaces

AtlasClientOptionalParams	Parámetros opcionales para el cliente.
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.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
MarketplaceDetails	Detalles de Marketplace para una organización
OfferDetails	Detalles de la oferta del marketplace seleccionado por el usuario
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.
OrganizationProperties	Propiedades específicas de la organización
OrganizationResource	Definición del modelo de recursos para una organización de Azure
OrganizationResourceUpdate	Tipo usado para las operaciones de actualización de OrganizationResource.
OrganizationResourceUpdateProperties	Las propiedades actualizables de OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Parámetros opcionales.
OrganizationsDeleteOptionalParams	Parámetros opcionales.
OrganizationsGetOptionalParams	Parámetros opcionales.
OrganizationsListByResourceGroupOptionalParams	Parámetros opcionales.
OrganizationsListBySubscriptionOptionalParams	Parámetros opcionales.
OrganizationsOperations	Interfaz que representa las operaciones de las organizaciones.
OrganizationsUpdateOptionalParams	Parámetros opcionales.
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.
PartnerProperties	Propiedades específicas de MongoDB
Resource	Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager
RestorePollerOptions
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".
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
UserDetails	Detalles del usuario de una organización

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.
ContinuablePage	Interfaz que describe una página de resultados.
CreatedByType	Tipo de entidad que creó el recurso. <xref: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.
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.
MarketplaceSubscriptionStatus	Estado de la suscripción de Marketplace de un recurso. KnownMarketplaceSubscriptionStatus se puede usar indistintamente con MarketplaceSubscriptionStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio PendingFulfillmentStart: Comprado pero aún no activado suscrito: se activa la suscripción de Marketplace suspendido: este estado indica que no se recibió el pago del cliente para el servicio marketplace. cancelada la suscripción: el cliente ha cancelado la suscripción
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.
ResourceProvisioningState	Estado de aprovisionamiento de un tipo de recurso. KnownResourceProvisioningState se puede usar indistintamente con ResourceProvisioningState, 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.

Enumeraciones

KnownActionType	Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.
KnownCreatedByType	Tipo de entidad que creó el recurso.
KnownManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
KnownMarketplaceSubscriptionStatus	Estado de la suscripción de Marketplace de un recurso.
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"
KnownResourceProvisioningState	Estado de aprovisionamiento de un tipo de recurso.
KnownVersions	Versiones compatibles con el modelo de recursos MongoDB.Atlas

Funciones

restorePoller<TResponse, TResult>(AtlasClient, 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>(AtlasClient, 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: AtlasClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parámetros

client

AtlasClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Devoluciones

PollerLike<OperationState<TResult>, TResult>