@azure/arm-mongocluster package

Classes

MongoClusterManagementClient

Interfaces

AdministratorProperties	As propriedades de login do administrador local.
AuthConfigProperties	A configuração de autenticação para o cluster Mongo.
BackupProperties	As propriedades de backup do cluster. Isso inclui o tempo de restauração mais antigo e as configurações de retenção.
CheckNameAvailabilityRequest	O corpo da solicitação de verificação de disponibilidade.
CheckNameAvailabilityResponse	O resultado da verificação da disponibilidade.
ComputeProperties	As propriedades de computação do cluster. Isso inclui as opções de núcleos virtuais/memória e dimensionamento aplicadas aos servidores no cluster.
ConnectionString	Cadeia de conexão para o cluster mongo
CustomerManagedKeyEncryptionProperties	Configurações de criptografia de chave gerenciadas pelo cliente.
DataApiProperties	Propriedades da API de dados.
DatabaseRole	Definição de função de banco de dados atribuída a um usuário.
EncryptionProperties	A configuração de criptografia para o cluster mongo.
EntraIdentityProvider	Define um usuário do Microsoft Entra ID Mongo.
EntraIdentityProviderProperties	Propriedades do provedor Microsoft Entra ID.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha.
FirewallRule	Representa uma regra de firewall de cluster mongo.
FirewallRuleProperties	As propriedades de uma regra de firewall de cluster mongo.
FirewallRulesCreateOrUpdateOptionalParams	Parâmetros opcionais.
FirewallRulesDeleteOptionalParams	Parâmetros opcionais.
FirewallRulesGetOptionalParams	Parâmetros opcionais.
FirewallRulesListByMongoClusterOptionalParams	Parâmetros opcionais.
FirewallRulesOperations	Interface que representa uma operação FirewallRules.
HighAvailabilityProperties	As propriedades de alta disponibilidade do cluster.
IdentityProvider	Define a definição de provedor de identidade de um usuário.
KeyEncryptionKeyIdentity	A identidade usada para a chave de criptografia de chave.
ListConnectionStringsResult	As cadeias de conexão para um determinado cluster mongo.
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
MongoCluster	Representa um recurso de cluster mongo.
MongoClusterManagementClientOptionalParams	Parâmetros opcionais para o cliente.
MongoClusterProperties	As propriedades de um cluster mongo.
MongoClusterReplicaParameters	Parâmetros usados para operações de réplica.
MongoClusterRestoreParameters	Parâmetros usados para operações de restauração
MongoClusterUpdate	O tipo usado para operações de atualização do MongoCluster.
MongoClusterUpdateProperties	As propriedades atualizáveis do MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Parâmetros opcionais.
MongoClustersCreateOrUpdateOptionalParams	Parâmetros opcionais.
MongoClustersDeleteOptionalParams	Parâmetros opcionais.
MongoClustersGetOptionalParams	Parâmetros opcionais.
MongoClustersListByResourceGroupOptionalParams	Parâmetros opcionais.
MongoClustersListConnectionStringsOptionalParams	Parâmetros opcionais.
MongoClustersListOptionalParams	Parâmetros opcionais.
MongoClustersOperations	Interface que representa uma operação MongoClusters.
MongoClustersPromoteOptionalParams	Parâmetros opcionais.
MongoClustersUpdateOptionalParams	Parâmetros opcionais.
Operation	Detalhes de uma operação da API REST, retornados da API de Operações do Provedor de Recursos
OperationDisplay	Informações de exibição localizadas para e operação.
OperationsListOptionalParams	Parâmetros opcionais.
OperationsOperations	Interface que representa uma operação de Operações.
PageSettings	Opções para o método byPage
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável até a conclusão e por página.
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso de conexão de ponto de extremidade privado
PrivateEndpointConnectionProperties	Propriedades da conexão de ponto de extremidade privado.
PrivateEndpointConnectionResource	Tipos de recursos de proxy concretos podem ser criados aliando esse tipo usando um tipo de propriedade específico.
PrivateEndpointConnectionsCreateOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsDeleteOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsGetOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsOperations	Interface que representa uma operação PrivateEndpointConnections.
PrivateLinkResource	Tipos de recursos de proxy concretos podem ser criados aliando esse tipo usando um tipo de propriedade específico.
PrivateLinkResourceProperties	Propriedades de um recurso de link privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
PrivateLinksListByMongoClusterOptionalParams	Parâmetros opcionais.
PrivateLinksOperations	Interface que representa uma operação PrivateLinks.
PromoteReplicaRequest	Promova propriedades de solicitação de réplica.
ProxyResource	A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags e um local
Replica	Representa uma réplica de cluster mongo.
ReplicasListByParentOptionalParams	Parâmetros opcionais.
ReplicasOperations	Interface que representa uma operação de réplicas.
ReplicationProperties	Propriedades de réplica do cluster mongo.
Resource	Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager
RestorePollerOptions
ShardingProperties	As propriedades de fragmentação do cluster. Isso inclui as opções de contagem de estilhaços e dimensionamento para o cluster.
StorageProperties	As propriedades de armazenamento do cluster. Isso inclui o tamanho do armazenamento de dados e o dimensionamento aplicados aos servidores no cluster.
SystemData	Metadados referentes à criação e última modificação do recurso.
TrackedResource	A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local'
User	Representa um usuário de cluster Mongo.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
UserProperties	Definição do recurso de usuário Mongo em um cluster.
UsersCreateOrUpdateOptionalParams	Parâmetros opcionais.
UsersDeleteOptionalParams	Parâmetros opcionais.
UsersGetOptionalParams	Parâmetros opcionais.
UsersListByMongoClusterOptionalParams	Parâmetros opcionais.
UsersOperations	Interface que representa uma operação de Usuários.

Aliases de Tipo

ActionType	Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas. KnownActionType pode ser usado de forma intercambiável com ActionType, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço interno: As ações são apenas para APIs internas.
AuthenticationMode	Os modos de autenticação suportados no cluster Mongo. KnownAuthenticationMode pode ser usado de forma intercambiável com AuthenticationMode, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço NativeAuth: Modo de autenticação mongo nativo usando nome de usuário e senha com mecanismo de autenticação 'SCRAM-SHA-256'. MicrosoftEntraID: modo de autenticação do Microsoft Entra ID usando usuários do Entra atribuídos ao cluster e mecanismo de autenticação 'MONGODB-OIDC'.
AzureSupportedClouds	Os valores suportados para a configuração de nuvem como um tipo literal de cadeia de caracteres
CheckNameAvailabilityReason	Possíveis razões para um nome não estar disponível. KnownCheckNameAvailabilityReason pode ser usado de forma intercambiável com CheckNameAvailabilityReason, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço inválido: O nome é inválido. AlreadyExists: O nome já existe.
ContinuablePage	Uma interface que descreve uma página de resultados.
CreateMode	O modo com o qual o Mongo Cluster é criado. KnownCreateMode pode ser usado de forma intercambiável com CreateMode, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Padrão: crie um novo cluster mongo. PointInTimeRestore: Crie um cluster mongo a partir de uma restauração point-in-time. GeoReplica: crie um cluster de réplica em uma região geográfica distinta do cluster de origem. Réplica: crie um cluster de réplica na mesma região geográfica do cluster de origem.
CreatedByType	O tipo de entidade que criou o recurso. KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço User: A entidade foi criada por um usuário. Application: A entidade foi criada por um aplicativo. ManagedIdentity: A entidade foi criada por uma identidade gerenciada. Key: A entidade foi criada por uma chave.
DataApiMode	O modo a ser aplicado à API de dados Mongo. KnownDataApiMode pode ser usado de forma intercambiável com DataApiMode, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Habilitado: a API de dados do Mongo está habilitada para o cluster. Desabilitado: a API de dados do Mongo está desabilitada para o cluster.
EntraPrincipalType	Tipos principais de ID do Microsoft Entra disponíveis para um usuário Mongo. KnownEntraPrincipalType pode ser usado de forma intercambiável com EntraPrincipalType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço user: Entra user type. servicePrincipal: Entra o tipo de entidade de serviço.
HighAvailabilityMode	Os modos de alta disponibilidade para um cluster. KnownHighAvailabilityMode pode ser usado de forma intercambiável com HighAvailabilityMode, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Desativado: o modo de alta disponibilidade está desativado. Este modo pode ver o impacto da disponibilidade durante falhas ou manutenção e não é recomendado para produção. SameZone: O modo de alta disponibilidade está habilitado, onde cada servidor em um fragmento é colocado na mesma zona de disponibilidade. ZoneRedundantPreferred: O modo de alta disponibilidade está habilitado e as preferências ZoneRedundant se a capacidade das zonas de disponibilidade estiver disponível na região, caso contrário, voltará ao provisionamento com SameZone.
IdentityProviderType	Tipos de provedor de identidade aos quais uma identidade de usuário pode pertencer. KnownIdentityProviderType pode ser usado de forma intercambiável com IdentityProviderType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço MicrosoftEntraID: Provedor de ID do Microsoft Entra.
IdentityProviderUnion	Alias para IdentityProviderUnion
KeyEncryptionKeyIdentityType	O tipo de identidade para a chave de criptografia de chave. KnownKeyEncryptionKeyIdentityType pode ser usado de forma intercambiável com KeyEncryptionKeyIdentityType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço UserAssignedIdentity: Identidade atribuída pelo usuário.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Nenhum: Nenhuma identidade gerenciada. SystemAssigned: Identidade gerenciada atribuída ao sistema. UserAssigned: Identidade gerenciada atribuída pelo usuário. SystemAssigned,UserAssigned: Sistema e usuário atribuído identidade gerenciada.
MongoClusterStatus	O status do recurso de cluster Mongo. KnownMongoClusterStatus pode ser usado de forma intercambiável com MongoClusterStatus, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Pronto: O recurso de cluster mongo está pronto para uso. Provisionamento: O recurso de cluster mongo está sendo provisionado. Atualização: O recurso de cluster mongo está sendo atualizado. Início: O recurso de cluster mongo está sendo iniciado. Paragem: O recurso de cluster mongo está sendo interrompido. Parado: O recurso de cluster mongo é interrompido. Dropping: O recurso de cluster mongo está sendo descartado.
Origin	O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system" KnownOrigin pode ser usado de forma intercambiável com Origin, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço usuário: Indica que a operação é iniciada por um usuário. sistema: Indica que a operação é iniciada por um sistema. usuário, sistema: Indica que a operação é iniciada por um usuário ou sistema.
PreviewFeature	Visualizar recursos que podem ser ativados em um cluster mongo. KnownPreviewFeature pode ser usado de forma intercambiável com PreviewFeature, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço GeoReplicas: Habilita o recurso de visualização de réplicas geográficas. O recurso deve ser definido em tempo de criação no novo cluster para permitir a vinculação de um cluster de réplica geográfica a ele.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual. KnownPrivateEndpointConnectionProvisioningState pode ser usado de forma intercambiável com PrivateEndpointConnectionProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço bem-sucedido : A conexão foi provisionada Criando: A conexão está sendo criada Excluindo: A conexão está sendo excluída Falha: Falha no provisionamento de conexão
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado. KnownPrivateEndpointServiceConnectionStatus pode ser usado de forma intercambiável com PrivateEndpointServiceConnectionStatus, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Pendente: Conexão aguardando aprovação ou rejeição Aprovado: Conexão aprovada Rejeitado: Conexão rejeitada
PromoteMode	O modo a ser aplicado a uma operação de promoção. KnownPromoteMode pode ser usado de forma intercambiável com PromoteMode, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Alternância: a promoção alternará o cluster de réplica atual para a função principal e o primário original será alternado para uma função de réplica, mantendo o link de replicação.
PromoteOption	A opção de se candidatar a uma operação de promoção. KnownPromoteOption pode ser usado de forma intercambiável com PromoteOption, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Forçado: Promover opção força a promoção sem esperar que a réplica seja alcançada até a primária. Isso pode resultar em perda de dados, portanto, só deve ser usado durante cenários de recuperação de desastres.
ProvisioningState	O estado de provisionamento da última operação aceita. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Successful: O recurso foi criado. Falha: Falha na criação de recursos. cancelado: A criação de recursos foi cancelada. InProgress: Uma operação está em andamento no recurso. Atualização: uma operação de atualização está em andamento no recurso. Descartagem: uma operação de descarte está em andamento no recurso.
PublicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este cluster Mongo. O valor é opcional e o valor padrão é 'Ativado' KnownPublicNetworkAccess pode ser usado de forma intercambiável com PublicNetworkAccess, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Ativado: Se definido, o cluster mongo pode ser acessado por meio de métodos privados e públicos. Desativado: Se definido, os pontos de extremidade privados são o método de acesso exclusivo.
ReplicationRole	Função de replicação do cluster mongo. KnownReplicationRole pode ser usado de forma intercambiável com ReplicationRole, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Principal: o cluster é uma réplica primária. AsyncReplica: O cluster é uma réplica assíncrona local. GeoAsyncReplica: O cluster é uma réplica geoassíncrona.
ReplicationState	O estado do link de replicação entre a réplica e o cluster de origem. KnownReplicationState pode ser usado de forma intercambiável com ReplicationState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Ativo: o link de replicação está ativo. Catchup: Replica está alcançando o primário. Isso pode ocorrer depois que a réplica é criada ou depois que uma promoção é acionada. Provisionamento: o link de réplica e replicação para o primário está sendo criado. Atualização: o link de replicação está sendo atualizado devido a uma alteração na réplica ou a uma atualização. Quebrado: o link de replicação foi quebrado e a réplica pode precisar ser recriada. Reconfiguração: o link de replicação está sendo reconfigurado devido a um evento de promoção.
StorageType	O tipo de armazenamento com o qual um cluster mongo pode ser provisionado. KnownStorageType pode ser usado de forma intercambiável com StorageType, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço PremiumSSD: SSD Premium para cargas de trabalho de alto desempenho. PremiumSSDv2: SSD Premium v2 para cargas de trabalho muito intensivas em IO. Esta é uma opção de pré-visualização e tem limitações adicionais.
UserRole	Função de banco de dados interna que pode ser atribuída a um usuário. KnownUserRole pode ser usado de forma intercambiável com UserRole, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço root: permissões de função raiz no escopo de destino.

Enumerações

AzureClouds	Um enum para descrever ambientes de nuvem do Azure.
KnownActionType	Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownAuthenticationMode	Os modos de autenticação suportados no cluster Mongo.
KnownCheckNameAvailabilityReason	Possíveis razões para um nome não estar disponível.
KnownCreateMode	O modo com o qual o Mongo Cluster é criado.
KnownCreatedByType	O tipo de entidade que criou o recurso.
KnownDataApiMode	O modo a ser aplicado à API de dados Mongo.
KnownEntraPrincipalType	Tipos principais de ID do Microsoft Entra disponíveis para um usuário Mongo.
KnownHighAvailabilityMode	Os modos de alta disponibilidade para um cluster.
KnownIdentityProviderType	Tipos de provedor de identidade aos quais uma identidade de usuário pode pertencer.
KnownKeyEncryptionKeyIdentityType	O tipo de identidade para a chave de criptografia de chave.
KnownManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
KnownMongoClusterStatus	O status do recurso de cluster Mongo.
KnownOrigin	O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system"
KnownPreviewFeature	Visualizar recursos que podem ser ativados em um cluster mongo.
KnownPrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
KnownPrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
KnownPromoteMode	O modo a ser aplicado a uma operação de promoção.
KnownPromoteOption	A opção de se candidatar a uma operação de promoção.
KnownProvisioningState	O estado de provisionamento da última operação aceita.
KnownPublicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este cluster Mongo. O valor é opcional e o valor padrão é 'Ativado'
KnownReplicationRole	Função de replicação do cluster mongo.
KnownReplicationState	O estado do link de replicação entre a réplica e o cluster de origem.
KnownStorageType	O tipo de armazenamento com o qual um cluster mongo pode ser provisionado.
KnownUserRole	Função de banco de dados interna que pode ser atribuída a um usuário.
KnownVersions	As versões de API disponíveis.

Funções

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Detalhes de Função

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

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

Parâmetros

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Devoluções

PollerLike<OperationState<TResult>, TResult>