@azure/arm-mongocluster package

Proprietà di accesso dell'amministratore locale.

Configurazione dell'autenticazione per il cluster Mongo.

Proprietà di backup del cluster. Sono incluse le impostazioni di conservazione e ora di ripristino meno recente.

Corpo della richiesta di disponibilità del controllo.

Risultato della disponibilità del controllo.

Proprietà di calcolo del cluster. Sono incluse le opzioni virtual-cores/memory e scaling applicate ai server nel cluster.

Stringa di connessione per il cluster mongo

Impostazioni di crittografia delle chiavi gestite dal cliente.

Proprietà dell'API dati.

Definizione del ruolo del database assegnata a un utente.

Configurazione della crittografia per il cluster mongo.

Definisce un utente Mongo ID Microsoft Entra.

Proprietà del provider ID Microsoft Entra.

Informazioni aggiuntive sull'errore di gestione delle risorse.

Dettagli dell'errore.

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite.

Rappresenta una regola del firewall del cluster mongo.

Proprietà di una regola del firewall del cluster mongo.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Interfaccia che rappresenta un'operazione FirewallRules.

Proprietà a disponibilità elevata del cluster.

Definisce la definizione del provider di identità di un utente.

Identità utilizzata per la chiave di crittografia della chiave.

Stringhe di connessione per il cluster mongo specificato.

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

Rappresenta una risorsa cluster mongo.

Parametri facoltativi per il client.

Proprietà di un cluster mongo.

Parametri usati per le operazioni di replica.

Parametri usati per le operazioni di ripristino

Tipo usato per le operazioni di aggiornamento di MongoCluster.

Proprietà aggiornabili di MongoCluster.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Interfaccia che rappresenta un'operazione MongoClusters.

Parametri facoltativi.

Parametri facoltativi.

Dettagli di un'operazione API REST, restituita dall'API operazioni del provider di risorse

Informazioni di visualizzazione localizzate per un'operazione.

Parametri facoltativi.

Interfaccia che rappresenta un'operazione operations.

Opzioni per il metodo byPage

Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.

Risorsa endpoint privato.

Risorsa di connessione dell'endpoint privato

Proprietà della connessione dell'endpoint privato.

È possibile creare tipi di risorse proxy concreti eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Interfaccia che rappresenta un'operazione PrivateEndpointConnections.

È possibile creare tipi di risorse proxy concreti eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.

Proprietà di una risorsa collegamento privato.

Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

Parametri facoltativi.

Interfaccia che rappresenta un'operazione PrivateLinks.

Alzare di livello le proprietà della richiesta di replica.

Definizione del modello di risorse per una risorsa proxy di Azure Resource Manager. Non avrà tag e una posizione

Rappresenta una replica cluster mongo.

Parametri facoltativi.

Interfaccia che rappresenta le operazioni di replica.

Proprietà di replica del cluster mongo.

Campi comuni restituiti nella risposta per tutte le risorse di Azure Resource Manager

Proprietà di partizionamento orizzontale del cluster. Sono incluse le opzioni di ridimensionamento e conteggio delle partizioni per il cluster.

Proprietà di archiviazione del cluster. Sono incluse le dimensioni di archiviazione dei dati e il ridimensionamento applicati ai server nel cluster.

Metadati relativi alla creazione e all'ultima modifica della risorsa.

La definizione del modello di risorsa per una risorsa di livello superiore di Azure Resource Manager con "tag" e "location"

Rappresenta un utente del cluster Mongo.

Proprietà di identità assegnate dall'utente

Definizione della risorsa utente Mongo in un cluster.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Parametri facoltativi.

Interfaccia che rappresenta le operazioni di un utente.

Enumerazione estendibile. Indica il tipo di azione. "Interno" si riferisce alle azioni destinate solo alle API interne.
KnownActionType può essere usato in modo intercambiabile con ActionType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

interno: le azioni sono destinate alle API solo interne.

Le modalità di autenticazione supportate nel cluster Mongo.
KnownAuthenticationMode può essere usato in modo intercambiabile con AuthenticationMode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

NativeAuth: modalità di autenticazione mongo nativa utilizzando nome utente e password con meccanismo di autenticazione 'SCRAM-SHA-256'.
MicrosoftEntraID: modalità di autenticazione dell'ID Microsoft Entra con gli utenti Entra assegnati al cluster e al meccanismo di autenticazione 'MONGODB-OIDC'.

I valori supportati per l'impostazione cloud come tipo letterale stringa

Possibili motivi per cui un nome non è disponibile.
KnownCheckNameAvailabilityReason può essere usato in modo intercambiabile con CheckNameAvailabilityReason, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

non valido: nome non valido.
AlreadyExists: il nome esiste già.

Interfaccia che descrive una pagina di risultati.

Modalità con cui viene creato il cluster Mongo.
KnownCreateMode può essere usato in modo intercambiabile con CreateMode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Impostazione predefinita: creare un nuovo cluster mongo.
PointInTimeRestore: creare un cluster mongo da un punto nel tempo di ripristino.
GeoReplica: creare un cluster di replica in un'area geografica distinta dal cluster di origine.
Replica: creare un cluster di replica nella stessa area geografica del cluster di origine.

Tipo di entità che ha creato la risorsa.
KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

User: l'entità è stata creata da un utente.
'applicazione: l'entità è stata creata da un'applicazione.
ManagedIdentity: l'entità è stata creata da un'identità gestita.
Key: l'entità è stata creata da una chiave.

Modalità da applicare all'API Mongo Data.
KnownDataApiMode può essere usato in modo intercambiabile con DataApiMode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Abilitato: l'API dati Mongo è abilitata per il cluster.
Disabilitato: l'API Mongo Data è disabilitata per il cluster.

Tipi di entità ID Microsoft Entra disponibili per un utente Mongo.
KnownEntraPrincipalType può essere utilizzato in modo intercambiabile con EntraPrincipalType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

user: Entra il tipo di utente.
servicePrincipal: tipo di entità servizio Entra.

Modalità di disponibilità elevata per un cluster.
KnownHighAvailabilityMode può essere usato in modo intercambiabile con HighAvailabilityMode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Disabilitato: la modalità a disponibilità elevata è disabilitata. Questa modalità è in grado di vedere l'impatto sulla disponibilità durante gli errori o la manutenzione e non è consigliata per la produzione.
SameZone: la modalità a disponibilità elevata è abilitata, in cui ogni server in una partizione viene posizionato nella stessa zona di disponibilità.
ZoneRedundantPreferred: la modalità di disponibilità elevata è abilitata e le preferenze sono impostate su ZoneRedundant se la capacità delle zone di disponibilità è disponibile nell'area, altrimenti torna al provisioning con SameZone.

Tipi di provider di identità a cui può appartenere un'identità utente.
KnownIdentityProviderType può essere usato in modo intercambiabile con IdentityProviderType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

MicrosoftEntraID: provider di ID Microsoft Entra.

Alias per IdentityProviderUnion

Tipo di identità per la chiave di crittografia della chiave.
KnownKeyEncryptionKeyIdentityType può essere utilizzato in modo intercambiabile con KeyEncryptionKeyIdentityType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

UserAssignedIdentity: identità assegnata dall'utente.

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
KnownManagedServiceIdentityType può essere usato in modo intercambiabile con ManagedServiceIdentityType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Nessuna: nessuna identità gestita.
SystemAssigned: identità gestita assegnata dal sistema.
'UserAssigned: identità gestita assegnata dall'utente.
SystemAssigned,UserAssigned: identità gestita assegnata dal sistema e dall'utente.

Stato della risorsa cluster Mongo.
KnownMongoClusterStatus può essere usato in modo intercambiabile con MongoClusterStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Pronto: la risorsa cluster mongo è pronta per l'uso.
Provisioning: è in corso il provisioning della risorsa cluster mongo.
Aggiornamento: la risorsa cluster mongo è in fase di aggiornamento.
Avvio: è in corso l'avvio della risorsa cluster mongo.
Arresto: la risorsa cluster mongo è in fase di arresto.
Arrestato: la risorsa cluster mongo viene arrestata.
Eliminazione: la risorsa cluster mongo viene eliminata.

La modalità bypass di rete per il cluster Mongo.
KnownNetworkBypassMode può essere usato in modo intercambiabile con NetworkBypassMode, questo enum contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Nessuno: nessun bypass di rete è abilitato.
AzureCosmosDB: Permette al servizio Azure Cosmos DB di bypassare le restrizioni di rete.

Executor previsto dell'operazione; come in Controllo degli accessi in base alle risorse e nell'esperienza utente dei log di controllo. Il valore predefinito è "user, system"
KnownOrigin può essere usato in modo intercambiabile con Origin, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

'utente: indica che l'operazione viene avviata da un utente.
di sistema: indica che l'operazione viene avviata da un sistema.
utente,di sistema: indica che l'operazione viene avviata da un utente o da un sistema.

Funzionalità di anteprima che possono essere abilitate in un cluster mongo.
KnownPreviewFeature può essere usato in modo intercambiabile con PreviewFeature, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

GeoReplicas: abilita la funzionalità di anteprima delle repliche geografiche. La funzionalità deve essere impostata in fase di creazione nel nuovo cluster per consentire il collegamento di un cluster di replica geografica.

Stato di provisioning corrente.
KnownPrivateEndpointConnectionProvisioningState può essere usato in modo intercambiabile con PrivateEndpointConnectionProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

riuscito: è stato effettuato il provisioning della connessione
Creazione di: viene creata la connessione
eliminazione di: la connessione viene eliminata
non riuscito: il provisioning della connessione non è riuscito

Stato della connessione dell'endpoint privato.
KnownPrivateEndpointServiceConnectionStatus può essere usato in modo intercambiabile con PrivateEndpointServiceConnectionStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

In sospeso: connessione in attesa di approvazione o rifiuto
approvato: connessione approvata
rifiutata: connessione rifiutata

Modalità da applicare a un'operazione di promozione.
KnownPromoteMode può essere usato in modo intercambiabile con PromoteMode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Switchover: l'innalzamento di livello consente di passare il cluster di replica corrente al ruolo primario e il cluster primario originale di passare a un ruolo di replica, mantenendo il collegamento di replica.

Opzione da applicare a un'operazione di promozione.
KnownPromoteOption può essere usato in modo intercambiabile con PromoteOption, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Forzata: l'opzione di promozione forza la promozione senza attendere che la replica venga raggiunta al primario. Ciò può comportare la perdita di dati, quindi deve essere utilizzato solo durante gli scenari di ripristino di emergenza.

Stato di provisioning dell'ultima operazione accettata.
KnownProvisioningState può essere usato in modo intercambiabile con ProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Operazione riuscita: la risorsa è stata creata.
non riuscito: creazione della risorsa non riuscita.
annullata: la creazione della risorsa è stata annullata.
InProgress: è in corso un'operazione sulla risorsa.
Aggiornamento: è in corso un'operazione di aggiornamento sulla risorsa.
Eliminazione: è in corso un'operazione di eliminazione della risorsa.

Indica se l'accesso all'endpoint pubblico è consentito per questo cluster Mongo. Il valore è facoltativo e il valore predefinito è 'Enabled'
KnownPublicNetworkAccess può essere usato in modo intercambiabile con PublicNetworkAccess, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Abilitato: se impostato, è possibile accedere al cluster mongo tramite metodi privati e pubblici.
Disabilitato: se impostato, gli endpoint privati sono il metodo di accesso esclusivo.

Ruolo di replica del cluster mongo.
KnownReplicationRole può essere usato in modo intercambiabile con ReplicationRole, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Primario: il cluster è una replica primaria.
AsyncReplica: il cluster è una replica asincrona locale.
GeoAsyncReplica: il cluster è una replica geo-asincrona.

Stato del collegamento di replica tra la replica e il cluster di origine.
KnownReplicationState può essere usato in modo intercambiabile con ReplicationState, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Attivo: il collegamento di replica è attivo.
Recupero: la replica sta recuperando il ritardo con il primario. Ciò può verificarsi dopo la creazione della replica o dopo l'attivazione di una promozione.
Provisioning: è in corso la creazione del collegamento di replica e replica al server primario.
Aggiornamento: il collegamento di replica è in fase di aggiornamento a causa di una modifica nella replica o di un aggiornamento.
Interrotto: il collegamento di replica è interrotto e potrebbe essere necessario ricreare la replica.
Riconfigurazione: il collegamento di replica viene riconfigurato a causa di un evento di promozione.

Tipo di archiviazione con cui è possibile effettuare il provisioning di un cluster mongo.
KnownStorageType può essere usato in modo intercambiabile con StorageType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

PremiumSSD: SSD Premium per carichi di lavoro ad alte prestazioni.
PremiumSSDv2: SSD Premium v2 per carichi di lavoro a elevato utilizzo di I/O. Si tratta di un'opzione di anteprima che presenta ulteriori limitazioni.

Ruolo del database predefinito che può essere assegnato a un utente.
KnownUserRole può essere utilizzato in modo intercambiabile con UserRole, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

root: autorizzazioni del ruolo radice nell'ambito di destinazione.

Un'enumerazione per descrivere gli ambienti Azure Cloud.

Enumerazione estendibile. Indica il tipo di azione. "Interno" si riferisce alle azioni destinate solo alle API interne.

Le modalità di autenticazione supportate nel cluster Mongo.

Possibili motivi per cui un nome non è disponibile.

Modalità con cui viene creato il cluster Mongo.

Tipo di entità che ha creato la risorsa.

Modalità da applicare all'API Mongo Data.

Tipi di entità ID Microsoft Entra disponibili per un utente Mongo.

Modalità di disponibilità elevata per un cluster.

Tipi di provider di identità a cui può appartenere un'identità utente.

Tipo di identità per la chiave di crittografia della chiave.

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

Stato della risorsa cluster Mongo.

La modalità bypass di rete per il cluster Mongo.

Executor previsto dell'operazione; come in Controllo degli accessi in base alle risorse e nell'esperienza utente dei log di controllo. Il valore predefinito è "user, system"

Funzionalità di anteprima che possono essere abilitate in un cluster mongo.

Stato di provisioning corrente.

Stato della connessione dell'endpoint privato.

Modalità da applicare a un'operazione di promozione.

Opzione da applicare a un'operazione di promozione.

Stato di provisioning dell'ultima operazione accettata.

Indica se l'accesso all'endpoint pubblico è consentito per questo cluster Mongo. Il valore è facoltativo e il valore predefinito è 'Abilitato'

Ruolo di replica del cluster mongo.

Stato del collegamento di replica tra la replica e il cluster di origine.

Tipo di archiviazione con cui è possibile effettuare il provisioning di un cluster mongo.

Ruolo del database predefinito che può essere assegnato a un utente.

Versioni dell'API disponibili.

Typeguard per RestError

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

Tipo di errore personalizzato per le richieste di pipeline non riuscite.