@azure/arm-mongocluster package

Właściwości logowania administratora lokalnego.

Konfiguracja uwierzytelniania dla klastra Mongo.

Właściwości kopii zapasowej klastra. Obejmuje to najwcześniejszy czas przywracania i ustawienia przechowywania.

Treść żądania sprawdzania dostępności.

Wynik sprawdzania dostępności.

Właściwości obliczeniowe klastra. Obejmuje to opcje rdzeni wirtualnych/pamięci i skalowania stosowane do serwerów w klastrze.

Parametry połączenia dla klastra mongo

Ustawienia szyfrowania kluczy zarządzane przez klienta.

Właściwości interfejsu API danych.

Definicja roli bazy danych przypisanej do użytkownika.

Konfiguracja szyfrowania dla klastra mongo.

Definiuje użytkownika Microsoft Entra ID Mongo.

Właściwości dostawcy identyfikatorów Microsoft Entra.

Dodatkowe informacje o błędzie zarządzania zasobami.

Szczegóły błędu.

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.

Reprezentuje regułę zapory klastra mongo.

Właściwości reguły zapory klastra mongo.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Interfejs reprezentujący operacje FirewallRules.

Właściwości wysokiej dostępności klastra.

Definiuje definicję dostawcy tożsamości użytkownika.

Tożsamość używana dla klucza szyfrowania klucza.

Parametry połączenia dla danego klastra mongo.

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)

Reprezentuje zasób klastra mongo.

Parametry opcjonalne dla klienta.

Właściwości klastra mongo.

Parametry używane do operacji repliki.

Parametry używane do operacji przywracania

Typ używany do operacji aktualizacji klastra MongoCluster.

Możliwe do zaktualizowania właściwości elementu MongoCluster.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Interfejs reprezentujący operacje MongoClusters.

Parametry opcjonalne.

Parametry opcjonalne.

Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów

Zlokalizowane informacje wyświetlane dla operacji.

Parametry opcjonalne.

Interfejs reprezentujący operacje.

Opcje dla metody byPage

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

Zasób prywatnego punktu końcowego.

Zasób połączenia prywatnego punktu końcowego

Właściwości połączenia prywatnego punktu końcowego.

Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Interfejs reprezentujący operacje PrivateEndpointConnections.

Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.

Właściwości zasobu łącza prywatnego.

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

Parametry opcjonalne.

Interfejs reprezentujący operacje PrivateLinks.

Podwyższ poziom właściwości żądania repliki.

Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji

Reprezentuje replikę klastra mongo.

Parametry opcjonalne.

Interfejs reprezentujący operacje replik.

Właściwości repliki klastra mongo.

Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager

Właściwości fragmentowania klastra. Obejmuje to opcje liczby fragmentów i skalowania klastra.

Właściwości magazynu klastra. Obejmuje to rozmiar magazynu danych i skalowanie zastosowane do serwerów w klastrze.

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację"

Reprezentuje użytkownika klastra Mongo.

Właściwości tożsamości przypisanej przez użytkownika

Definicja zasobu użytkownika Mongo w klastrze.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Parametry opcjonalne.

Interfejs reprezentujący operacje Użytkownika.

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ętrzne: akcje są przeznaczone dla interfejsów API tylko wewnętrznych.

Tryby uwierzytelniania obsługiwane w klastrze Mongo.
KnownAuthenticationMode może być używany zamiennie z AuthenticationMode, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NativeAuth: Natywny tryb uwierzytelniania mongo przy użyciu nazwy użytkownika i hasła z mechanizmem uwierzytelniania "SCRAM-SHA-256".
MicrosoftEntraID: tryb uwierzytelniania identyfikatora Microsoft Entra przy użyciu użytkowników Entra przypisanych do klastra i mechanizmu uwierzytelniania "MONGODB-OIDC".

Obsługiwane wartości ustawienia chmury jako typ literału ciągu

Możliwe przyczyny braku dostępności nazwy.
KnownCheckNameAvailabilityReason można używać zamiennie z checkNameAvailabilityReason, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nieprawidłowa: nazwa jest nieprawidłowa.
AlreadyExists: Nazwa już istnieje.

Interfejs opisujący stronę wyników.

Tryb, za pomocą którego jest tworzony klaster Mongo.
KnownCreateMode można używać zamiennie z trybem CreateMode, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Ustawienie domyślne: Utwórz nowy klaster mongo.
PointInTimeRestore: Utwórz klaster mongo na podstawie punktu przywracania w czasie.
GeoReplica: Utwórz klaster repliki w innym regionie geograficznym niż klaster źródłowy.
Replika: Utwórz klaster repliki w tym samym regionie geograficznym co klaster źródłowy.

Rodzaj jednostki, która utworzyła zasób.
KnownCreatedByType można używać zamiennie z parametrem 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.
Aplikacja: jednostka została utworzona przez aplikację.
ManagedIdentity: jednostka została utworzona przez tożsamość zarządzaną.
Klucz: jednostka została utworzona przez klucz.

Tryb, który ma być stosowany do interfejsu API danych Mongo.
KnownDataApiMode może być używany zamiennie z DataApiMode, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Włączone: interfejs API danych Mongo jest włączony dla klastra.
Wyłączone: interfejs API danych Mongo jest wyłączony dla klastra.

Typy podmiotów zabezpieczeń Microsoft Entra ID dostępne dla użytkownika Mongo.
KnownEntraPrincipalType może być używany zamiennie z EntraPrincipalType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

user: typ użytkownika Entra.
servicePrincipal: typ jednostki usługi Entra.

Tryby wysokiej dostępności klastra.
KnownHighAvailabilityMode można używać zamiennie z funkcją HighAvailabilityMode, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Wyłączone: tryb wysokiej dostępności jest wyłączony. Ten tryb może mieć wpływ na dostępność podczas usterek lub konserwacji i nie jest zalecany w środowisku produkcyjnym.
SameZone: włączony jest tryb wysokiej dostępności, w którym każdy serwer we fragmencie jest umieszczany w tej samej strefie dostępności.
ZoneRedundantPreferred: tryb wysokiej dostępności jest włączony i preferuje strefę nadmiarową, jeśli pojemność stref dostępności jest dostępna w regionie, w przeciwnym razie wraca do aprowizacji za pomocą SameZone.

Typy dostawców tożsamości, do których może należeć tożsamość użytkownika.
KnownIdentityProviderType może być używany zamiennie z IdentityProviderType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

MicrosoftEntraID: dostawca identyfikatorów Microsoft Entra.

Alias dla IdentityProviderUnion

Typ tożsamości klucza szyfrowania klucza.
KnownKeyEncryptionKeyIdentityType może być używany zamiennie z KeyEncryptionKeyIdentityType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

UserAssignedIdentity: tożsamość przypisana przez użytkownika.

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.
SystemAssigned: 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.

Stan zasobu klastra Mongo.
KnownMongoClusterStatus można używać zamiennie z mongoClusterStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Gotowy: zasób klastra mongo jest gotowy do użycia.
Aprowizacja: zasób klastra mongo jest aprowizowany.
Aktualizowanie: Zasób klastra mongo jest aktualizowany.
Uruchamianie: Zasób klastra mongo jest uruchamiany.
Zatrzymywanie: zasób klastra mongo jest zatrzymywany.
Zatrzymano: zasób klastra mongo został zatrzymany.
Upuszczanie: zasób klastra mongo jest porzucany.

Tryb obejścia sieci dla klastra Mongo.
KnownNetworkBypassMode może być używany zamiennie z NetworkBypassMode, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Brak: Nie ma włączonego obejścia sieci.
AzureCosmosDB: Pozwala usłudze Azure Cosmos DB omijać ograniczenia sieciowe.

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żytkownik: 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.

Funkcje w wersji zapoznawczej, które można włączyć w klastrze mongo.
KnownPreviewFeature można używać zamiennie z funkcją PreviewFeature, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

GeoReplicas: włącza funkcję podglądu replik geograficznych. Funkcja musi być ustawiona w czasie tworzenia nowego klastra, aby umożliwić połączenie z nim klastra repliki geograficznej.

Bieżący stan aprowizacji.
KnownPrivateEndpointConnectionProvisioningState można używać zamiennie z parametrem PrivateEndpointConnectionProvisioningState. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Powodzenie: połączenie zostało zainicjowane
Tworzenie: Połączenie jest tworzone
Usuwanie: Połączenie jest usuwane
Niepowodzenie: Inicjowanie obsługi połączenia nie powiodło się

Stan połączenia prywatnego punktu końcowego.
KnownPrivateEndpointServiceConnectionStatus można używać zamiennie z parametrem PrivateEndpointServiceConnectionStatus. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Oczekujące: połączenie oczekujące na zatwierdzenie lub odrzucenie
Zatwierdzone: Połączenie zatwierdzone
Odrzucone: Połączenie odrzucone

Tryb stosowania do operacji podwyższania poziomu.
KnownPromoteMode można używać zamiennie z funkcją PromoteMode, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Przełączanie: podwyższenie poziomu spowoduje przełączenie bieżącego klastra repliki na rolę podstawową, a oryginalny podstawowy zostanie przełączony do roli repliki, zachowując łącze replikacji.

Opcja stosowania do operacji podwyższania poziomu.
KnownPromoteOption można używać zamiennie z funkcją PromoteOption, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Wymuszone: Opcja Podwyższanie poziomu wymusza podwyższenie poziomu bez czekania, aż replika zostanie dogoniona do podstawowej. Może to spowodować utratę danych, dlatego powinno być używane tylko podczas scenariuszy odzyskiwania po awarii.

Stan aprowizacji ostatniej zaakceptowanej operacji.
KnownProvisioningState można używać zamiennie z parametrem ProvisioningState, 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.
W toku: operacja jest w toku na zasobie.
Aktualizowanie: Operacja aktualizacji jest w toku w zasobie.
Upuszczanie: Operacja upuszczania jest w toku dla zasobu.

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra Mongo. Wartość jest opcjonalna, a wartość domyślna to "Włączone"
ZnanePublicNetworkAccess można używać zamiennie z funkcją PublicNetworkAccess, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Włączone: Jeśli ta opcja jest ustawiona, dostęp do klastra mongo można uzyskać za pomocą metod prywatnych i publicznych.
Wyłączone: jeśli jest ustawiona, prywatne punkty końcowe są wyłączną metodą dostępu.

Rola replikacji klastra mongo.
KnownReplicationRole można używać zamiennie z elementem ReplicationRole, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Podstawowa: klaster jest repliką podstawową.
AsyncReplica: klaster jest lokalną repliką asynchroniczną.
GeoAsyncReplica: klaster jest repliką geograficznie asynchroniczną.

Stan połączenia replikacji między repliką a klastrem źródłowym.
KnownReplicationState można używać zamiennie z wartością ReplicationState. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Aktywne: łącze replikacji jest aktywne.
Nadrabianie zaległości: Replika dogania element podstawowy. Może się to zdarzyć po utworzeniu repliki lub po wyzwoleniu podwyższenia poziomu.
Aprowizacja: Replika i link replikacji do serwera podstawowego są tworzone.
Aktualizowanie: link replikacji jest aktualizowany z powodu zmiany repliki lub uaktualnienia.
Przerwana: link replikacji jest uszkodzony i może być konieczne ponowne utworzenie repliki.
Ponowna konfiguracja: link replikacji jest ponownie konfigurowany z powodu zdarzenia podwyższenia poziomu.

Typ magazynu, za pomocą którego można aprowizować klaster mongo.
KnownStorageType można używać zamiennie z parametrem StorageType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

PremiumSSD: Dysk SSD w warstwie Premium do obciążeń o wysokiej wydajności.
PremiumSSDv2: dysk SSD w warstwie Premium w wersji 2 dla obciążeń intensywnie korzystających z operacji we/wy. Jest to opcja w wersji zapoznawczej i ma dodatkowe ograniczenia.

Wbudowana rola bazy danych, którą można przypisać do użytkownika.
KnownUserRole może być używany zamiennie z UserRole, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

root: uprawnienia roli głównej w zakresie docelowym.

Wyliczenie opisujące środowiska chmury platformy Azure.

Rozszerzalne wyliczenie. Wskazuje typ akcji. "Wewnętrzny" odnosi się do akcji, które są przeznaczone tylko dla wewnętrznych interfejsów API.

Tryby uwierzytelniania obsługiwane w klastrze Mongo.

Możliwe przyczyny braku dostępności nazwy.

Tryb, za pomocą którego jest tworzony klaster Mongo.

Rodzaj jednostki, która utworzyła zasób.

Tryb, który ma być stosowany do interfejsu API danych Mongo.

Typy podmiotów zabezpieczeń Microsoft Entra ID dostępne dla użytkownika Mongo.

Tryby wysokiej dostępności klastra.

Typy dostawców tożsamości, do których może należeć tożsamość użytkownika.

Typ tożsamości klucza szyfrowania klucza.

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).

Stan zasobu klastra Mongo.

Tryb obejścia sieci dla klastra Mongo.

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"

Funkcje w wersji zapoznawczej, które można włączyć w klastrze mongo.

Bieżący stan aprowizacji.

Stan połączenia prywatnego punktu końcowego.

Tryb stosowania do operacji podwyższania poziomu.

Opcja stosowania do operacji podwyższania poziomu.

Stan aprowizacji ostatniej zaakceptowanej operacji.

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra Mongo. Wartość jest opcjonalna, a wartość domyślna to "Włączone"

Rola replikacji klastra mongo.

Stan połączenia replikacji między repliką a klastrem źródłowym.

Typ magazynu, za pomocą którego można aprowizować klaster mongo.

Wbudowana rola bazy danych, którą można przypisać do użytkownika.

Dostępne wersje interfejsu API.

Funkcja Typeguard dla błędu RestError

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.

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.