@azure/arm-mongodbatlas package

Classes

Interfaces

AtlasClientOptionalParams	Optional parameters for the client.
Cluster	The MongoDB Atlas Cluster resource type. A cluster is a managed database deployment within a project.
ClusterProperties	Properties specific to a MongoDB Atlas Cluster.
ClustersCreateOrUpdateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MarketplaceDetails	Marketplace details for an organization
OfferDetails	Offer details for the marketplace that is selected by the user
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OrganizationProperties	Properties specific to Organization
OrganizationResource	The resource model definition for an Azure Organization
OrganizationResourceUpdate	The type used for update operations of the OrganizationResource.
OrganizationResourceUpdateProperties	The updatable properties of the OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Optional parameters.
OrganizationsDeleteOptionalParams	Optional parameters.
OrganizationsGetOptionalParams	Optional parameters.
OrganizationsListByResourceGroupOptionalParams	Optional parameters.
OrganizationsListBySubscriptionOptionalParams	Optional parameters.
OrganizationsOperations	Interface representing a Organizations operations.
OrganizationsUpdateOptionalParams	Optional parameters.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PartnerProperties	MongoDB specific Properties
Project	The MongoDB Atlas Project resource type. A project is a logical grouping of clusters within an organization.
ProjectLimitStatus	Usage and limit status for a resource quota in a MongoDB Atlas project.
ProjectProperties	Properties specific to a MongoDB Atlas Project.
ProjectsCreateOrUpdateOptionalParams	Optional parameters.
ProjectsDeleteOptionalParams	Optional parameters.
ProjectsGetOptionalParams	Optional parameters.
ProjectsListClusterTierRegionsOptionalParams	Optional parameters.
ProjectsListOptionalParams	Optional parameters.
ProjectsOperations	Interface representing a Projects operations.
ProjectsTierLimitReachedOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegionsByTierResponse	Response for regions by cluster tier.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SystemData	Metadata pertaining to creation and last modification of the resource.
TierLimitReachedResponse	Response for tier limit check.
TierRegions	Cluster tier and its supported regions.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
UserDetails	User details for an organization

Type Aliases

ActionType	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.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ClusterTier	Cluster tier options for MongoDB Atlas. KnownClusterTier can be used interchangeably with ClusterTier, this enum contains the known values that the service supports. Known values supported by the service FREE: Free tier cluster. FLEX: Flex tier cluster. M10: M10 tier cluster. M30: M30 tier cluster.
ContinuablePage	An interface that describes a page of results.
CreatedByType	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.
ManagedServiceIdentityType	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.
MarketplaceSubscriptionStatus	Marketplace subscription status of a resource. KnownMarketplaceSubscriptionStatus can be used interchangeably with MarketplaceSubscriptionStatus, this enum contains the known values that the service supports. Known values supported by the service PendingFulfillmentStart: Purchased but not yet activated Subscribed: Marketplace subscription is activated Suspended: This state indicates that a customer's payment for the Marketplace service was not received Unsubscribed: Customer has cancelled the subscription
Origin	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.
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, 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.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownClusterTier	Cluster tier options for MongoDB Atlas.
KnownCreatedByType	The kind of entity that created the resource.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMarketplaceSubscriptionStatus	Marketplace subscription status of a resource.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownVersions	Supported versions for the MongoDB.Atlas resource model

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AtlasClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	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.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

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

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.

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

Parameters

client: AtlasClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-mongodbatlas package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

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

Parameters

Returns

Variable Details

RestError

Type

Feedback