@azure/arm-mongodbatlas package

Klasy

AtlasClient

Interfejsy

AtlasClientOptionalParams	Parametry opcjonalne dla klienta.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.
ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)
MarketplaceDetails	Szczegóły witryny Marketplace dla organizacji
OfferDetails	Szczegóły oferty dla witryny Marketplace wybranej przez użytkownika
Operation	Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów
OperationDisplay	Zlokalizowane informacje o wyświetlaniu i operacji.
OperationsListOptionalParams	Parametry opcjonalne.
OperationsOperations	Interfejs reprezentujący operacje.
OrganizationProperties	Właściwości specyficzne dla organizacji
OrganizationResource	Definicja modelu zasobów dla organizacji platformy Azure
OrganizationResourceUpdate	Typ używany do operacji aktualizacji w organizacjiResource.
OrganizationResourceUpdateProperties	Możliwe do zaktualizowania właściwości OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Parametry opcjonalne.
OrganizationsDeleteOptionalParams	Parametry opcjonalne.
OrganizationsGetOptionalParams	Parametry opcjonalne.
OrganizationsListByResourceGroupOptionalParams	Parametry opcjonalne.
OrganizationsListBySubscriptionOptionalParams	Parametry opcjonalne.
OrganizationsOperations	Interfejs reprezentujący operacje organizacji.
OrganizationsUpdateOptionalParams	Parametry opcjonalne.
PageSettings	Opcje dla metody byPage
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.
PartnerProperties	Właściwości specyficzne dla bazy danych MongoDB
Resource	Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager
RestorePollerOptions
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TrackedResource	Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację"
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika
UserDetails	Szczegóły użytkownika dla organizacji

Aliasy typu

ActionType	Rozszerzalne wyliczenie. Wskazuje typ akcji. "Wewnętrzny" odnosi się do akcji, które są przeznaczone tylko dla wewnętrznych interfejsów API. KnownActionType można używać zamiennie z właściwością ActionType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę wewnętrzny: akcje dotyczą interfejsów API tylko do użytku wewnętrznego.
ContinuablePage	Interfejs opisujący stronę wyników.
CreatedByType	Rodzaj jednostki, która utworzyła zasób. <xref:KnowncreatedByType> można używać zamiennie z elementem createdByType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę użytkownik: jednostka została utworzona przez użytkownika. Application: jednostka została utworzona przez aplikację. managedIdentity: jednostka została utworzona przez tożsamość zarządzaną. klucz: jednostka została utworzona przez klucz.
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). KnownManagedServiceIdentityType można używać zamiennie z wartościami ManagedServiceIdentityType. Wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Brak: brak tożsamości zarządzanej. SystemPrzypisane: tożsamość zarządzana przypisana przez system. UserAssigned: tożsamość zarządzana przypisana przez użytkownika. SystemAssigned,UserAssigned: tożsamość zarządzana przypisana przez system i użytkownika.
MarketplaceSubscriptionStatus	Stan subskrypcji witryny Marketplace zasobu. KnownMarketplaceSubscriptionStatus można używać zamiennie z witryną MarketplaceSubscriptionStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę PendingFulfillmentStart: Zakupione, ale jeszcze nie aktywowane subskrybowane: subskrypcja witryny Marketplace jest aktywowana zawieszone: ten stan wskazuje, że nie odebrano płatności klienta za usługę Marketplace anulowane: Klient anulował subskrypcję
Origin	Zamierzony wykonawca operacji; podobnie jak w przypadku kontroli dostępu opartej na zasobach (RBAC) i dzienników inspekcji środowiska użytkownika. Wartość domyślna to "użytkownik,system" ZnaneOrigin można używać zamiennie z usługą Origin, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę użytkownika: wskazuje, że operacja jest inicjowana przez użytkownika. system: wskazuje, że operacja jest inicjowana przez system. użytkownik,system: wskazuje, że operacja jest inicjowana przez użytkownika lub system.
ResourceProvisioningState	Stan aprowizacji typu zasobu. KnownResourceProvisioningState można używać zamiennie z parametrem ResourceProvisioningState, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę pomyślnie: utworzono zasób. Niepowodzenie: tworzenie zasobu nie powiodło się. Anulowano: tworzenie zasobów zostało anulowane.

Wyliczenia

KnownActionType	Rozszerzalne wyliczenie. Wskazuje typ akcji. "Wewnętrzny" odnosi się do akcji, które są przeznaczone tylko dla wewnętrznych interfejsów API.
KnownCreatedByType	Rodzaj jednostki, która utworzyła zasób.
KnownManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
KnownMarketplaceSubscriptionStatus	Stan subskrypcji witryny Marketplace zasobu.
KnownOrigin	Zamierzony wykonawca operacji; podobnie jak w przypadku kontroli dostępu opartej na zasobach (RBAC) i dzienników inspekcji środowiska użytkownika. Wartość domyślna to "użytkownik,system"
KnownResourceProvisioningState	Stan aprowizacji typu zasobu.
KnownVersions	Obsługiwane wersje modelu zasobów MongoDB.Atlas

Funkcje

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

Szczegóły funkcji

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

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>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Zwraca

PollerLike<OperationState<TResult>, TResult>