@azure/arm-mongodbatlas package

Classes

AtlasClient

Interfaces

AtlasClientOptionalParams	Paramètres facultatifs pour le client.
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é.
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
MarketplaceDetails	Détails de la Place de marché pour une organisation
OfferDetails	Détails de l’offre pour la Place de marché sélectionnée par l’utilisateur
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.
OrganizationProperties	Propriétés spécifiques à l’organisation
OrganizationResource	Définition du modèle de ressource d’une organisation Azure
OrganizationResourceUpdate	Type utilisé pour les opérations de mise à jour de l’OrganizationResource.
OrganizationResourceUpdateProperties	Propriétés pouvant être mises à jour de l’OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Paramètres facultatifs.
OrganizationsDeleteOptionalParams	Paramètres facultatifs.
OrganizationsGetOptionalParams	Paramètres facultatifs.
OrganizationsListByResourceGroupOptionalParams	Paramètres facultatifs.
OrganizationsListBySubscriptionOptionalParams	Paramètres facultatifs.
OrganizationsOperations	Interface représentant des opérations d’organisation.
OrganizationsUpdateOptionalParams	Paramètres facultatifs.
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.
PartnerProperties	Propriétés spécifiques à MongoDB
Resource	Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager
RestorePollerOptions
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 »
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
UserDetails	Détails de l’utilisateur pour une organisation

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.
ContinuablePage	Interface qui décrit une page de résultats.
CreatedByType	Type d’entité qui a créé la ressource. <xref:KnowncreatedByType> pouvez ê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é.
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.
MarketplaceSubscriptionStatus	État de l’abonnement de la Place de marché d’une ressource. KnownMarketplaceSubscriptionStatus peut être utilisé de manière interchangeable avec MarketplaceSubscriptionStatus, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service PendingFulfillmentStart: acheté mais pas encore activé abonnez-vous : l’abonnement place de marché est activé suspendu : cet état indique que le paiement d’un client pour le service Marketplace n’a pas été reçu désinscription : le client a annulé l’abonnement
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.
ResourceProvisioningState	État d’approvisionnement d’un type de ressource. KnownResourceProvisioningState peut être utilisé de manière interchangeable avec ResourceProvisioningState, 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.

Énumérations

KnownActionType	Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.
KnownCreatedByType	Type d’entité qui a créé la ressource.
KnownManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
KnownMarketplaceSubscriptionStatus	État de l’abonnement de la Place de marché d’une ressource.
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 »
KnownResourceProvisioningState	État d’approvisionnement d’un type de ressource.
KnownVersions	Versions prises en charge pour le modèle de ressource MongoDB.Atlas

Functions

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

Paramètres

client

AtlasClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retours

PollerLike<OperationState<TResult>, TResult>