@azure/arm-mongodbatlas package

Třídy

AtlasClient

Rozhraní

AtlasClientOptionalParams

Volitelné parametry pro klienta.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace

ManagedServiceIdentity

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

MarketplaceDetails

Podrobnosti o Marketplace pro organizaci

OfferDetails

Podrobnosti o nabídce pro marketplace vybrané uživatelem

Operation

Podrobnosti o operaci ROZHRANÍ REST API vrácené z rozhraní API pro operace poskytovatele prostředků

OperationDisplay

Lokalizované informace o zobrazení a operaci

OperationsListOptionalParams

Volitelné parametry.

OperationsOperations

Rozhraní představující operace operací

OrganizationProperties

Vlastnosti specifické pro organizaci

OrganizationResource

Definice modelu prostředků pro organizaci Azure

OrganizationResourceUpdate

Typ použitý pro operace aktualizace organizace Nasourc.

OrganizationResourceUpdateProperties

Aktualizovatelné vlastnosti OrganizationResource.

OrganizationsCreateOrUpdateOptionalParams

Volitelné parametry.

OrganizationsDeleteOptionalParams

Volitelné parametry.

OrganizationsGetOptionalParams

Volitelné parametry.

OrganizationsListByResourceGroupOptionalParams

Volitelné parametry.

OrganizationsListBySubscriptionOptionalParams

Volitelné parametry.

OrganizationsOperations

Rozhraní představující operace organizace

OrganizationsUpdateOptionalParams

Volitelné parametry.

PageSettings

Možnosti pro metodu byPage

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

PartnerProperties

Vlastnosti specifické pro MongoDB

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru

RestorePollerOptions
SystemData

Metadata týkající se vytvoření a poslední změny prostředku.

TrackedResource

Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

UserDetails

Podrobnosti o uživateli pro organizaci

Aliasy typu

ActionType

Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.
PoleActionType lze použít zaměnitelně s ActionType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Interní: Akce jsou určené pouze pro interní rozhraní API.

ContinuablePage

Rozhraní, které popisuje stránku výsledků.

CreatedByType

Druh entity, která prostředek vytvořila.
<xref:KnowncreatedByType> lze použít zaměnitelně s createdByType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

user: Entita byla vytvořena uživatelem.
Application: Entita byla vytvořena aplikací.
ManagedIdentity: Entita byla vytvořena spravovanou identitou.
Klíč: Entita byla vytvořena klíčem.

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
PoleManagedServiceIdentityType lze použít zaměnitelně s ManagedServiceIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Žádná: Žádná spravovaná identita.
systemAssigned: Spravovaná identita přiřazená systémem
přiřazené uživatelem: Spravovaná identita přiřazená uživatelem
SystemAssigned, UserAssigned: Spravovaná identita přiřazená systémem a uživatelem.

MarketplaceSubscriptionStatus

Stav předplatného Marketplace prostředku
PoleMarketplaceSubscriptionStatus lze použít zaměnitelně s MarketplaceSubscriptionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

PendingFulfillmentStart: Zakoupeno, ale ještě není aktivované
přihlášení k odběru: Předplatné Marketplace je aktivované
pozastavené: Tento stav označuje, že nebyla přijata platba zákazníka za službu Marketplace.
odhlášený: Zákazník zrušil předplatné

Origin

Zamýšlený exekutor operace; jako v řízení přístupu na základě prostředků (RBAC) a protokoly auditu uživatelského rozhraní. Výchozí hodnota je user, system.
PoleOrigin lze použít zaměnitelně s Origin, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

uživatel: Označuje, že operace je inicializována uživatelem.
systémová: Označuje, že operace je inicializována systémem.
uživatel, systémová: Označuje, že operace je inicializována uživatelem nebo systémem.

ResourceProvisioningState

Stav zřizování typu prostředku.
PoleResourceProvisioningState lze použít zaměnitelně s ResourceProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Úspěšné: Prostředek byl vytvořen.
selhalo: Vytvoření prostředku se nezdařilo.
Zrušeno: Vytvoření prostředku bylo zrušeno.

Výčty

KnownActionType

Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.

KnownCreatedByType

Druh entity, která prostředek vytvořila.

KnownManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

KnownMarketplaceSubscriptionStatus

Stav předplatného Marketplace prostředku

KnownOrigin

Zamýšlený exekutor operace; jako v řízení přístupu na základě prostředků (RBAC) a protokoly auditu uživatelského rozhraní. Výchozí hodnota je user, system.

KnownResourceProvisioningState

Stav zřizování typu prostředku.

KnownVersions

Podporované verze modelu prostředků MongoDB.Atlas

Funkce

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

Podrobnosti funkce

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

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

Parametry

client
AtlasClient
serializedState

string

sourceOperation

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

Návraty

PollerLike<OperationState<TResult>, TResult>