@azure/arm-mongodbatlas package

Klassen

AtlasClient

Schnittstellen

AtlasClientOptionalParams	Optionale Parameter für den Client.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
MarketplaceDetails	Marketplace-Details für eine Organisation
OfferDetails	Angebotsdetails für den Marketplace, der vom Benutzer ausgewählt wird
Operation	Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird
OperationDisplay	Lokalisierte Anzeigeinformationen für und Den Betrieb.
OperationsListOptionalParams	Optionale Parameter.
OperationsOperations	Schnittstelle, die vorgänge darstellt.
OrganizationProperties	Spezifische Eigenschaften für Die Organisation
OrganizationResource	Die Definition des Ressourcenmodells für eine Azure-Organisation
OrganizationResourceUpdate	Der Typ, der für Aktualisierungsvorgänge der OrganizationResource verwendet wird.
OrganizationResourceUpdateProperties	Die aktualisierbaren Eigenschaften von OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Optionale Parameter.
OrganizationsDeleteOptionalParams	Optionale Parameter.
OrganizationsGetOptionalParams	Optionale Parameter.
OrganizationsListByResourceGroupOptionalParams	Optionale Parameter.
OrganizationsListBySubscriptionOptionalParams	Optionale Parameter.
OrganizationsOperations	Schnittstelle, die eine Organisationsoperation darstellt.
OrganizationsUpdateOptionalParams	Optionale Parameter.
PageSettings	Optionen für die byPage-Methode
PagedAsyncIterableIterator	Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.
PartnerProperties	MongoDB-spezifische Eigenschaften
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
RestorePollerOptions
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften
UserDetails	Benutzerdetails für eine Organisation

Typaliase

ActionType	Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten. KnownActionType- austauschbar mit ActionType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Interne: Aktionen gelten nur für interne APIs.
ContinuablePage	Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.
CreatedByType	Die Art der Entität, die die Ressource erstellt hat. <xref:KnowncreatedByType> austauschbar mit createdByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Benutzer-: Die Entität wurde von einem Benutzer erstellt. Application: Die Entität wurde von einer Anwendung erstellt. ManagedIdentity-: Die Entität wurde durch eine verwaltete Identität erstellt. Key: Die Entität wurde mit einem Schlüssel erstellt.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). KnownManagedServiceIdentityType austauschbar mit ManagedServiceIdentityType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Keine: Keine verwaltete Identität. SystemAssigned: Vom System zugewiesene verwaltete Identität. UserAssigned-: Vom Benutzer zugewiesene verwaltete Identität. SystemAssigned,UserAssigned: System und vom Benutzer zugewiesene verwaltete Identität.
MarketplaceSubscriptionStatus	Marketplace-Abonnementstatus einer Ressource. KnownMarketplaceSubscriptionStatus austauschbar mit MarketplaceSubscriptionStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden PendingFulfillmentStart: Gekauft, aber noch nicht aktiviert Abonnierte: Marketplace-Abonnement wird aktiviert Ausgesetzte: Dieser Zustand gibt an, dass die Zahlung eines Kunden für den Marketplace-Dienst nicht empfangen wurde. Abonnement kündigen: Der Kunde hat das Abonnement gekündigt.
Origin	Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System" KnownOrigin austauschbar mit Origin verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Benutzer-: Gibt an, dass der Vorgang von einem Benutzer initiiert wird. System-: Gibt an, dass der Vorgang von einem System initiiert wird. Benutzer,System: Gibt an, dass der Vorgang von einem Benutzer oder System initiiert wird.
ResourceProvisioningState	Der Bereitstellungsstatus eines Ressourcentyps. KnownResourceProvisioningState austauschbar mit ResourceProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Erfolgreich: Ressource wurde erstellt. Fehlgeschlagene: Fehler bei der Ressourcenerstellung. Abgebrochene: Die Ressourcenerstellung wurde abgebrochen.

Enumerationen

KnownActionType	Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.
KnownCreatedByType	Die Art der Entität, die die Ressource erstellt hat.
KnownManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
KnownMarketplaceSubscriptionStatus	Marketplace-Abonnementstatus einer Ressource.
KnownOrigin	Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"
KnownResourceProvisioningState	Der Bereitstellungsstatus eines Ressourcentyps.
KnownVersions	Unterstützte Versionen für das Ressourcenmodell MongoDB.Atlas

Functions

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

Details zur Funktion

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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

Parameter

client

AtlasClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Gibt zurück

PollerLike<OperationState<TResult>, TResult>