@azure/arm-mongocluster package

Vlastnosti přihlášení místního správce.

Konfigurace ověřování pro cluster Mongo.

Vlastnosti zálohování clusteru. To zahrnuje nejstarší nastavení doby obnovení a uchovávání informací.

Text žádosti o dostupnost kontroly.

Výsledek kontroly dostupnosti.

Vlastnosti výpočetních prostředků clusteru. To zahrnuje možnosti virtuálních jader/paměti a škálování použitých na servery v clusteru.

Připojovací řetězec pro cluster Mongo

Nastavení šifrování klíče spravovaného zákazníkem.

Vlastnosti datového rozhraní API.

Definice databázové role, která je přiřazena uživateli.

Konfigurace šifrování pro cluster mongo.

Definuje uživatele Microsoft Entra ID Mongo.

Vlastnosti poskytovatele Microsoft Entra ID.

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

Podrobnosti o chybě.

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

Představuje pravidlo brány firewall clusteru Mongo.

Vlastnosti pravidla brány firewall clusteru Mongo

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Rozhraní představující operace brány firewall

Vlastnosti vysoké dostupnosti clusteru.

Definuje definici poskytovatele identity uživatele.

Identita použitá pro šifrovací klíč klíče.

Připojovací řetězce pro daný cluster Mongo.

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

Představuje prostředek clusteru Mongo.

Volitelné parametry pro klienta.

Vlastnosti clusteru Mongo.

Parametry používané pro operace repliky.

Parametry používané pro operace obnovení

Typ použitý pro operace aktualizace MongoCluster.

Aktualizovatelné vlastnosti MongoCluster.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Rozhraní představující operace MongoClusters

Volitelné parametry.

Volitelné parametry.

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

Lokalizované zobrazovací informace pro operaci.

Volitelné parametry.

Rozhraní představující operace operací

Možnosti pro metodu byPage

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

Prostředek privátního koncového bodu.

Prostředek připojení privátního koncového bodu

Vlastnosti připojení privátního koncového bodu

Konkrétní typy prostředků proxy můžou být vytvořeny aliasem tohoto typu pomocí konkrétního typu vlastnosti.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Rozhraní představující operace PrivateEndpointConnections

Konkrétní typy prostředků proxy můžou být vytvořeny aliasem tohoto typu pomocí konkrétního typu vlastnosti.

Vlastnosti prostředku privátního propojení

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

Volitelné parametry.

Rozhraní představující operace PrivateLinks

Zvýšení úrovně vlastností žádosti o repliku

Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.

Představuje repliku clusteru Mongo.

Volitelné parametry.

Rozhraní představující operace replik.

Vlastnosti repliky clusteru Mongo

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

Vlastnosti horizontálního dělení clusteru. To zahrnuje počet horizontálních oddílů a možnosti škálování clusteru.

Vlastnosti úložiště clusteru. To zahrnuje velikost úložiště dat a škálování použité na servery v clusteru.

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

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

Představuje uživatele clusteru Mongo.

Vlastnosti identity přiřazené uživatelem

Definice uživatelského prostředku Mongo v clusteru.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Volitelné parametry.

Rozhraní reprezentující uživatelské operace.

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.

Režimy ověřování podporující cluster Mongo.
KnownAuthenticationMode lze použít zaměnitelně s AuthenticationMode , tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

NativeAuth: Nativní režim mongo autentizace pomocí uživatelského jména a hesla s mechanismem ověřování "SCRAM-SHA-256".
MicrosoftEntraID: Režim ověřování Microsoft Entra ID pomocí uživatelů Entra přiřazených ke clusteru a mechanismu ověřování "MONGODB-OIDC".

Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu

Možné důvody, proč název není dostupný.
PoleCheckNameAvailabilityReason lze použít zaměnitelně s CheckNameAvailabilityReason, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Neplatné: Název je neplatný.
AlreadyExists: Název již existuje.

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

Režim, se kterým je cluster Mongo vytvořen.
PoleCreateMode lze použít zaměnitelně s CreateMode, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Výchozí: Vytvořte nový cluster mongo.
PointInTimeRestore: Vytvořte cluster mongo z bodu v čase.
GeoReplica: Vytvořte cluster replik v odlišné geografické oblasti od zdrojového clusteru.
Replika: Vytvořte cluster replik ve stejné geografické oblasti jako zdrojový cluster.

Druh entity, která prostředek vytvořila.
PoleCreatedByType 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.

Režim, který se má použít pro rozhraní Mongo Data API.
KnownDataApiMode lze použít zaměnitelně s DataApiMode, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Povoleno: Pro cluster je povoleno rozhraní Mongo Data API.
Zakázáno: Rozhraní Mongo Data API je pro cluster zakázané.

Typy objektů zabezpečení Microsoft Entra ID dostupné pro uživatele Mongo.
KnownEntraPrincipalType lze použít zaměnitelně s EntraPrincipalType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

user: Typ uživatele Entra.
instanční objekt: Typ instančního objektu entra.

Režimy vysoké dostupnosti pro cluster.
PoleHighAvailabilityMode lze použít zaměnitelně s HighAvailabilityMode, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Zakázáno: Režim vysoké dostupnosti je zakázán. Tento režim může mít dopad na dostupnost během poruch nebo údržby a nedoporučuje se pro produkci.
SameZone: Je povolený režim vysoké dostupnosti, kdy je každý server v horizontálním oddílu umístěn ve stejné zóně dostupnosti.
ZoneRedundantPreferred: Režim vysoké dostupnosti je povolený a upřednostňuje ZoneRedundant, pokud je v oblasti k dispozici kapacita zón dostupnosti, jinak se vrátí ke zřizování pomocí SameZone.

Typy zprostředkovatele identity, ke kterým může patřit identita uživatele.
KnownIdentityProviderType lze použít zaměnitelně s IdentityProviderType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

MicrosoftEntraID: Poskytovatel Microsoft Entra ID.

Alias pro IdentityProviderUnion

Typ identity pro šifrovací klíč klíče.
KnownKeyEncryptionKeyIdentityType lze použít zaměnitelně s KeyEncryptionKeyIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

UserAssignedIdentity: Identita přiřazená uživatelem.

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.
UserAssigned: Spravovaná identita přiřazená uživatelem.
SystemAssigned, UserAssigned: Spravovaná identita přiřazená systémem a uživatelem.

Stav prostředku clusteru Mongo
PoleMongoClusterStatus lze použít zaměnitelně s MongoClusterStatus, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Připraveno: Prostředek clusteru mongo je připraven k použití.
Zřizování: Prostředek clusteru mongo se zřizuje.
Aktualizace: Prostředek clusteru mongo se aktualizuje.
Spuštění: Prostředek clusteru mongo je spuštěn.
Zastavení: Prostředek clusteru mongo je zastaven.
Zastaveno: Prostředek clusteru mongo je zastaven.
Vyřazení: Prostředek clusteru mongo je zahozen.

Režim obcházení sítě pro cluster Mongo.
KnownNetworkBypassMode lze používat zaměnitelně s NetworkBypassMode, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Žádné: Není povolen žádný síťový obcházení.
AzureCosmosDB: Umožňuje službě Azure Cosmos DB obejít síťová omezení.

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.

Funkce ve verzi Preview, které je možné povolit v clusteru Mongo.
PolePreviewFeature lze použít zaměnitelně s verzí PreviewFeature, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

GeoReplicas: Povolí funkci náhledu geografických replik. Tato funkce musí být nastavena v době vytváření v novém clusteru, aby bylo možné s ní propojit cluster geografické repliky.

Aktuální stav zřizování.
PolePrivateEndpointConnectionProvisioningState lze použít zaměnitelně s PrivateEndpointConnectionProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Úspěch: Připojení bylo zřízeno
Vytváření: Vytváří se spojení
Smazání: Připojení se odstraňuje
Nezdařilo se: Zřizování připojení se nezdařilo

Stav připojení privátního koncového bodu.
KnownPrivateEndpointServiceConnectionStatus lze použít zaměnitelně s PrivateEndpointServiceConnectionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Čeká na vyřízení: Připojení čeká na schválení nebo zamítnutí
Schváleno: Připojení schváleno
Odmítnuto: Připojení odmítnuto

Režim, který se má použít pro operaci povýšení.
PolePromoteMode lze použít zaměnitelně s PromoteMode, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Přepnutí: Povýšení přepne aktuální cluster repliky na primární roli a původní primární role se přepne na roli repliky, přičemž se zachová propojení replikace.

Možnost použití na operaci zvýšení úrovně
PolePromoteOption lze použít zaměnitelně s PromoteOption, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Vynucené: Možnost Povýšení vynutí povýšení bez čekání na to, až bude replika zachycena na primární úrovni. To může vést ke ztrátě dat, proto by se mělo používat pouze ve scénářích zotavení po havárii.

Stav zřizování poslední přijaté operace.
KnownProvisioningState lze použít zaměnitelně s ProvisioningState, 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.
InProgress: Na zdroji probíhá operace.
Aktualizace: U prostředku probíhá operace aktualizace.
Vyřazení: U prostředku probíhá operace přetažení.

Určuje, jestli je pro tento cluster Mongo povolený přístup k veřejnému koncovému bodu nebo ne. Hodnota je volitelná a výchozí hodnota je Enabled (Povoleno).
KnownPublicNetworkAccess lze použít zaměnitelně s PublicNetworkAccess, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Povoleno: Pokud je tato možnost nastavena, ke clusteru mongo lze přistupovat prostřednictvím soukromých a veřejných metod.
Zakázáno: Pokud je tato možnost nastavená, privátní koncové body jsou výhradní metodou přístupu.

Role replikace clusteru Mongo
PoleReplicationRole lze použít zaměnitelně s ReplicationRole, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Primární: Cluster je primární replikou.
AsyncReplica: Cluster je místní asynchronní replika.
GeoAsyncReplica: Cluster je geograficky asynchronní replika.

Stav propojení replikace mezi replikou a zdrojovým clusterem
PoleReplicationState lze použít zaměnitelně s ReplicationState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Aktivní: Odkaz replikace je aktivní.
Dohánění: Replica dohání primární. K tomu může dojít po vytvoření repliky nebo po aktivaci povýšení.
Zřizování: Vytváří se replika a odkaz replikace na primární server.
Aktualizace: Odkaz na replikaci se aktualizuje z důvodu změny repliky nebo upgradu.
Přerušeno: Propojení replikace je přerušeno a repliku může být nutné znovu vytvořit.
Změna konfigurace: Odkaz replikace se překonfiguruje z důvodu propagační akce.

Typ úložiště, se kterým lze cluster mongo zřídit.
PoleStorageType lze použít zaměnitelně s typem StorageType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

PremiumSSD: SSD úrovně Premium pro úlohy s vysokým výkonem.
PremiumSSDv2: SSD úrovně Premium v2 pro úlohy velmi náročné na vstupně-výstupní operace. Jedná se o možnost náhledu a má další omezení.

Předdefinovaná databázová role, kterou lze přiřadit uživateli.
KnownUserRole lze použít zaměnitelně s UserRole, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

root: Oprávnění kořenové role v cílovém oboru.

Výčet popisující cloudová prostředí Azure.

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

Režimy ověřování podporující cluster Mongo.

Možné důvody, proč název není dostupný.

Režim, se kterým je cluster Mongo vytvořen.

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

Režim, který se má použít pro rozhraní Mongo Data API.

Typy objektů zabezpečení Microsoft Entra ID dostupné pro uživatele Mongo.

Režimy vysoké dostupnosti pro cluster.

Typy zprostředkovatele identity, ke kterým může patřit identita uživatele.

Typ identity pro šifrovací klíč klíče.

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

Stav prostředku clusteru Mongo

Režim obcházení sítě pro cluster Mongo.

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.

Funkce ve verzi Preview, které je možné povolit v clusteru Mongo.

Aktuální stav zřizování.

Stav připojení privátního koncového bodu.

Režim, který se má použít pro operaci povýšení.

Možnost použití na operaci zvýšení úrovně

Stav zřizování poslední přijaté operace.

Určuje, jestli je pro tento cluster Mongo povolený přístup k veřejnému koncovému bodu nebo ne. Hodnota je volitelná a výchozí hodnota je 'Enabled'

Role replikace clusteru Mongo

Stav propojení replikace mezi replikou a zdrojovým clusterem

Typ úložiště, se kterým lze cluster mongo zřídit.

Předdefinovaná databázová role, kterou lze přiřadit uživateli.

Dostupné verze rozhraní API.

Typeguard pro RestError

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.

Vlastní typ chyby pro neúspěšné požadavky kanálu.