@azure/arm-cosmosdbforpostgresql package

Classi

CosmosDBForPostgreSQL

Interfacce

AuthConfig

Configurazione dell'autenticazione di un cluster.
Cluster

Rappresenta un cluster.
ClusterForUpdate

Rappresenta un cluster per l'aggiornamento.
ClusterProperties

Proprietà del cluster.
ClusterPropertiesForUpdate

Le proprietà usate per aggiornare un cluster.
ClusterServer

Rappresenta un server in un cluster.
ClusterServerProperties

Proprietà di un server nel cluster.
ClustersCheckNameAvailabilityOptionalParams

Parametri facoltativi.
ClustersCreateOptionalParams

Parametri facoltativi.
ClustersDeleteOptionalParams

Parametri facoltativi.
ClustersGetOptionalParams

Parametri facoltativi.
ClustersListByResourceGroupOptionalParams

Parametri facoltativi.
ClustersListOptionalParams

Parametri facoltativi.
ClustersOperations

Interfaccia che rappresenta le operazioni di un cluster.
ClustersPromoteReadReplicaOptionalParams

Parametri facoltativi.
ClustersRestartOptionalParams

Parametri facoltativi.
ClustersStartOptionalParams

Parametri facoltativi.
ClustersStopOptionalParams

Parametri facoltativi.
ClustersUpdateOptionalParams

Parametri facoltativi.
Configuration

Rappresenta i dettagli di configurazione per coordinatore e nodo.
ConfigurationProperties

Le proprietà della configurazione.
ConfigurationsGetCoordinatorOptionalParams

Parametri facoltativi.
ConfigurationsGetNodeOptionalParams

Parametri facoltativi.
ConfigurationsGetOptionalParams

Parametri facoltativi.
ConfigurationsListByClusterOptionalParams

Parametri facoltativi.
ConfigurationsListByServerOptionalParams

Parametri facoltativi.
ConfigurationsOperations

Interfaccia che rappresenta le operazioni di Configurazione.
ConfigurationsUpdateOnCoordinatorOptionalParams

Parametri facoltativi.
ConfigurationsUpdateOnNodeOptionalParams

Parametri facoltativi.
CosmosDBForPostgreSQLOptionalParams

Parametri facoltativi per il client.
DataEncryption

Proprietà di crittografia dei dati di un cluster.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

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

Rappresenta una regola del firewall del cluster.
FirewallRuleProperties

Le proprietà di una regola firewall cluster.
FirewallRulesCreateOrUpdateOptionalParams

Parametri facoltativi.
FirewallRulesDeleteOptionalParams

Parametri facoltativi.
FirewallRulesGetOptionalParams

Parametri facoltativi.
FirewallRulesListByClusterOptionalParams

Parametri facoltativi.
FirewallRulesOperations

Interfaccia che rappresenta un'operazione FirewallRules.
IdentityProperties

Descrive l'identità del cluster.
MaintenanceWindow

Pianificare le impostazioni per gli aggiornamenti regolari del cluster.
NameAvailability

Rappresenta la disponibilità del nome del cluster.
NameAvailabilityRequest

Richiedere dal client di controllare la disponibilità del nome del cluster.
Operation

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

Informazioni di visualizzazione localizzate per un'operazione.
OperationsListOptionalParams

Parametri facoltativi.
OperationsOperations

Interfaccia che rappresenta un'operazione operativa.
PageSettings

Opzioni per il metodo byPage
PagedAsyncIterableIterator

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

Risorsa endpoint privato.
PrivateEndpointConnection

Una risorsa privata di connessione endpoint
PrivateEndpointConnectionProperties

Proprietà della connessione dell'endpoint privato.
PrivateEndpointConnectionSimpleProperties

Le proprietà nella connessione privata degli endpoint
PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Parametri facoltativi.
PrivateEndpointConnectionsDeleteOptionalParams

Parametri facoltativi.
PrivateEndpointConnectionsGetOptionalParams

Parametri facoltativi.
PrivateEndpointConnectionsListByClusterOptionalParams

Parametri facoltativi.
PrivateEndpointConnectionsOperations

Interfaccia che rappresenta un'operazione PrivateEndpointConnections.
PrivateEndpointProperty

Proprietà per rappresentare l'ID risorsa dell'endpoint privato.
PrivateLinkResource

Una risorsa di collegamento privato.
PrivateLinkResourceProperties

Proprietà di una risorsa collegamento privato.
PrivateLinkResourcesGetOptionalParams

Parametri facoltativi.
PrivateLinkResourcesListByClusterOptionalParams

Parametri facoltativi.
PrivateLinkResourcesOperations

Interfaccia che rappresenta un'operazione PrivateLinkResources.
PrivateLinkServiceConnectionState

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

Richiedere dal client di alzare di livello la replica con ridondanza geografica
ProxyResource

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

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

Rappresenta un ruolo del cluster.
RoleProperties

Le proprietà di un ruolo di cluster.
RolePropertiesExternalIdentity

interfaccia modello RuoloProprietàIdentità Esterna
RolesCreateOptionalParams

Parametri facoltativi.
RolesDeleteOptionalParams

Parametri facoltativi.
RolesGetOptionalParams

Parametri facoltativi.
RolesListByClusterOptionalParams

Parametri facoltativi.
RolesOperations

Interfaccia che rappresenta un'operazione di Ruolo.
ServerConfiguration

Rappresenta una configurazione.
ServerConfigurationProperties

Proprietà di una configurazione.
ServerNameItem

Oggetto nome per un server.
ServerProperties

Proprietà di un server.
ServerRoleGroupConfiguration

Rappresenta il valore di configurazione del gruppo di ruoli del server.
ServersGetOptionalParams

Parametri facoltativi.
ServersListByClusterOptionalParams

Parametri facoltativi.
ServersOperations

Interfaccia che rappresenta le operazioni di un server.
SimplePollerLike

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.
SimplePrivateEndpointConnection

Una connessione endpoint privato.
SystemData

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

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

Proprietà di identità assegnate dall'utente

Alias tipo

AadEnabledEnum

Indica se il cluster è stato creato usando l'autenticazione AAD.
KnownAadEnabledEnum può essere usato in modo intercambiabile con AadEnabledEnum, che contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

abilitato
disabilitato
ActionType

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 per le API solo interne.
ActiveDirectoryAuth

Tipo di ActiveDirectoryAuth
AzureSupportedClouds

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

Tipo di risorsa utilizzato per la verifica della disponibilità del nome.
ConfigurationDataType

Tipo di dati della configurazione.
KnownConfigurationDataType può essere usato in modo intercambiabile con ConfigurationDataType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Booleano
Numerico
Intero
Enumerazione
ContinuablePage

Interfaccia che descrive una pagina di risultati.
CreatedByType

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.
DataEncryptionType

Tipo di DataEncryptionType
IdentityType

Tipo di IdentitàTipo
Origin

Esecutore previsto dell'operazione; come nel Controllo degli accessi basato sulle risorse (RBAC) e nell'interfaccia utente dei log di audit. 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

user: indica che l'operazione è stata avviata da un utente.
system: indica che l'operazione è stata avviata da un sistema.
user,system: Indica che l'operazione è stata avviata da un utente o da un sistema.
PasswordAuth

Tipo di PasswordAuth
PasswordEnabledEnum

Indica se il cluster è stato creato con una password o usando l'autenticazione AAD.
KnownPasswordEnabledEnum può essere usato in modo intercambiabile con PasswordEnabledEnum, questo enum contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

abilitato
disabilitato
PrincipalType

Tipo di PrincipalType
PrivateEndpointConnectionProvisioningState

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
PrivateEndpointServiceConnectionStatus

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
ProvisioningState

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

Valori noti supportati dal servizio

Riuscito
Annullata
InProgress
Non riuscito
RoleType

Tipo di ruolo
ServerRole

Ruolo di un server.
KnownServerRole può essere usato in modo intercambiabile con ServerRole, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Coordinator
worker

Enumerazioni

AzureClouds

Un enum per descrivere gli ambienti Azure Cloud.
KnownAadEnabledEnum

Indica se il cluster è stato creato usando l'autenticazione AAD.
KnownActionType

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

Valori noti di ActiveDirectoryAuth accettati dal servizio.
KnownConfigurationDataType

Tipo di dati della configurazione.
KnownCreatedByType

Tipo di entità che ha creato la risorsa.
KnownDataEncryptionType

Valori noti di DataEncryptionType che il servizio accetta.
KnownIdentityType

Valori noti di IdentityType accettati dal servizio.
KnownOrigin

Esecutore previsto dell'operazione; come nel Controllo degli accessi basato sulle risorse (RBAC) e nell'interfaccia utente dei log di audit. Il valore predefinito è "user, system"
KnownPasswordAuth

Valori noti di PasswordAuth accettati dal servizio.
KnownPasswordEnabledEnum

Indica se il cluster è stato creato con una password o usando l'autenticazione AAD.
KnownPrincipalType

Valori noti di PrincipalType accettati dal servizio.
KnownPrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.
KnownPrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.
KnownProvisioningState

Stato di provisioning corrente.
KnownRoleType

Valori noti di RoleType accettati dal servizio.
KnownServerRole

Ruolo di un server.
KnownVersions

Versioni dell'API disponibili.

Funzioni

isRestError(unknown)

Typeguard per RestError
restorePoller<TResponse, TResult>(CosmosDBForPostgreSQL, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Crea un poller dallo stato serializzato di un altro poller. Ciò può essere utile quando si desidera creare poller su un host diverso o quando è necessario creare un poller dopo che quello originale non è incluso nell'ambito.

Variabili

RestError

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

Dettagli funzione

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e

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

Crea un poller dallo stato serializzato di un altro poller. Ciò può essere utile quando si desidera creare poller su un host diverso o quando è necessario creare un poller dopo che quello originale non è incluso nell'ambito.

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

Parametri

client
CosmosDBForPostgreSQL
serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Valori restituiti

PollerLike<OperationState<TResult>, TResult>

Dettagli delle variabili

RestError

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

RestError: RestErrorConstructor

Tipo

RestErrorConstructor