@azure/arm-mongocluster package

Classes

MongoClusterManagementClient

Interfaces

AdministratorProperties	As propriedades de logon 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 e as configurações de retenção mais antigas.
CheckNameAvailabilityRequest	O corpo da solicitação de disponibilidade de verificação.
CheckNameAvailabilityResponse	O resultado da disponibilidade de verificação.
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 Mongo da ID do Microsoft Entra.
EntraIdentityProviderProperties	Propriedades do provedor de ID do Microsoft Entra.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha.
FirewallRule	Representa uma regra de firewall do cluster mongo.
FirewallRuleProperties	As propriedades de uma regra de firewall do 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 do 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 o cluster mongo especificado.
ManagedServiceIdentity	Identidade de serviço gerenciada (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 operações do MongoClusters.
MongoClustersPromoteOptionalParams	Parâmetros opcionais.
MongoClustersUpdateOptionalParams	Parâmetros opcionais.
Operation	Detalhes de uma operação de API REST, retornada 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 operações de operações.
PageSettings	Opções para o método byPage
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto 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 com o alias desse 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 com o alias desse tipo usando um tipo de propriedade específico.
PrivateLinkResourceProperties	Propriedades de um recurso de link privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
PrivateLinksListByMongoClusterOptionalParams	Parâmetros opcionais.
PrivateLinksOperations	Interface que representa uma operação PrivateLinks.
PromoteReplicaRequest	Promover propriedades de solicitação de réplica.
ProxyResource	A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local
Replica	Representa uma réplica de cluster mongo.
ReplicasListByParentOptionalParams	Parâmetros opcionais.
ReplicasOperations	Interface que representa operações 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 a contagem de fragmentos e as opções de 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 relativos à criação e última modificação do recurso.
TrackedResource	A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local'
User	Representa um usuário do cluster Mongo.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
UserProperties	Definição do recurso de usuário do 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	Enumeração 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Interno: as ações são para APIs somente internas.
AuthenticationMode	Os modos de autenticação compatíveis com o cluster Mongo. KnownAuthenticationMode pode ser usado de forma intercambiável com AuthenticationMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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 de ID do Microsoft Entra usando usuários do Entra atribuídos ao cluster e ao mecanismo de autenticação 'MONGODB-OIDC'.
AzureSupportedClouds	Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres
CheckNameAvailabilityReason	Possíveis motivos para um nome não estar disponível. KnownCheckNameAvailabilityReason pode ser usado de forma intercambiável com CheckNameAvailabilityReason, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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 Cluster do Mongo é criado. KnownCreateMode pode ser usado de forma intercambiável com CreateMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Padrão: crie um novo cluster mongo. PointInTimeRestore: crie um cluster mongo a partir de um ponto de restauração no tempo. 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 que o cluster de origem.
CreatedByType	O tipo de entidade que criou o recurso. KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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 do Mongo. KnownDataApiMode pode ser usado de forma intercambiável com DataApiMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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 de entidade de segurança de ID do Microsoft Entra disponíveis para um usuário do Mongo. KnownEntraPrincipalType pode ser usado de forma intercambiável com EntraPrincipalType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço user: tipo de usuário Entra. servicePrincipal: tipo de entidade de serviço do Entra.
HighAvailabilityMode	Os modos de alta disponibilidade para um cluster. KnownHighAvailabilityMode pode ser usado de forma intercambiável com HighAvailabilityMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Desabilitado: o modo de alta disponibilidade está desabilitado. Esse 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, em que cada servidor em um fragmento é colocado na mesma zona de disponibilidade. ZoneRedundantPreferred: o modo de alta disponibilidade está habilitado e as preferências são ZoneRedundant se a capacidade das zonas de disponibilidade estiver disponível na região, caso contrário, retornará 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço UserAssignedIdentity: Identidade atribuída pelo usuário.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos). KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhum: nenhuma identidade gerenciada. SystemAssigned: identidade gerenciada atribuída pelo sistema. UserAssigned: identidade gerenciada atribuída pelo usuário. SystemAssigned,UserAssigned: identidade gerenciada atribuída pelo sistema e pelo usuário.
MongoClusterStatus	O status do recurso de cluster do Mongo. KnownMongoClusterStatus podem ser usados de forma intercambiável com MongoClusterStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Pronto: o recurso de cluster do Mongo está pronto para uso. Provisionamento: o recurso de cluster mongo está sendo provisionado. Atualizando: o recurso de cluster mongo está sendo atualizado. Iniciando: o recurso de cluster do mongo está sendo iniciado. Parando: o recurso de cluster do mongo está sendo interrompido. Parado: o recurso de cluster mongo é interrompido. Descartando: o recurso de cluster mongo está sendo descartado.
Origin	O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na UX de logs de auditoria. O valor padrão é "user,system" KnownOrigin pode ser usado de forma intercambiável com a Origem, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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,do sistema: indica que a operação é iniciada por um usuário ou sistema.
PreviewFeature	Recursos de visualização que podem ser habilitados em um cluster mongo. KnownPreviewFeature pode ser usado de forma intercambiável com PreviewFeature, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço GeoReplicas: habilita o recurso de visualização de réplicas geográficas. O recurso deve ser definido no momento da 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Êxito: a conexão foi provisionada Criando: A conexão está sendo criada Eliminando: A conexão está sendo excluída Falha: Falha no provisionamento de conexão
PrivateEndpointServiceConnectionStatus	O status da conexão do ponto de extremidade privado. KnownPrivateEndpointServiceConnectionStatus pode ser usado de forma intercambiável com PrivateEndpointServiceConnectionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Alternância: a promoção alternará o cluster de réplica atual para a função primária e o primário original será alternado para uma função de réplica, mantendo o link de replicação.
PromoteOption	A opção a ser aplicada a uma operação de promoção. KnownPromoteOption pode ser usado de forma intercambiável com PromoteOption, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Forçado: a opção Promover força a promoção sem esperar que a réplica seja alcançada até o primário. Isso pode resultar em perda de dados, portanto, só deve ser usado durante cenários de recuperação de desastre.
ProvisioningState	O estado de provisionamento da última operação aceita. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço bem-sucedido: o recurso foi criado. falha no: falha na criação de recursos. cancelou: a criação de recursos foi cancelada. InProgress: uma operação está em andamento no recurso. Atualizando: uma operação de atualização está em andamento no recurso. Descartar: 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 do Mongo. O valor é opcional e o valor padrão é 'Enabled' KnownPublicNetworkAccess podem ser usados de forma intercambiável com PublicNetworkAccess, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Ativado: se definido, o cluster mongo pode ser acessado por meio de métodos privados e públicos. Desabilitado: 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Primário: o cluster é uma réplica primária. AsyncReplica: o cluster é uma réplica assíncrona local. GeoAsyncReplica: o cluster é uma réplica assíncrona geográfica.
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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Ativo: o link de replicação está ativo. Catchup: A réplica está alcançando o primário. Isso pode ocorrer depois que a réplica é criada ou depois que uma promoção é disparada. Provisionamento: a réplica e o link de replicação para o primário estão sendo criados. Atualizando: 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 está quebrado e a réplica pode precisar ser recriada. Reconfigurando: 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço SSD Premium: SSD Premium para cargas de trabalho de alto desempenho. PremiumSSDv2: SSD Premium v2 para cargas de trabalho com uso intensivo de E/S. Esta é uma opção de 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço root: permissões de função raiz no escopo de destino.

Enumerações

AzureClouds	Um enumeração para descrever os ambientes de nuvem do Azure.
KnownActionType	Enumeração 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 compatíveis com o cluster Mongo.
KnownCheckNameAvailabilityReason	Possíveis motivos para um nome não estar disponível.
KnownCreateMode	O modo com o qual o Cluster do Mongo é criado.
KnownCreatedByType	O tipo de entidade que criou o recurso.
KnownDataApiMode	O modo a ser aplicado à API de dados do Mongo.
KnownEntraPrincipalType	Tipos de entidade de segurança de ID do Microsoft Entra disponíveis para um usuário do 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 (em que os tipos SystemAssigned e UserAssigned são permitidos).
KnownMongoClusterStatus	O status do recurso de cluster do Mongo.
KnownOrigin	O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na UX de logs de auditoria. O valor padrão é "user,system"
KnownPreviewFeature	Recursos de visualização que podem ser habilitados em um cluster mongo.
KnownPrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
KnownPrivateEndpointServiceConnectionStatus	O status da conexão do ponto de extremidade privado.
KnownPromoteMode	O modo a ser aplicado a uma operação de promoção.
KnownPromoteOption	A opção a ser aplicada 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 do 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 sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

Detalhes da função

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

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver 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>

Retornos

PollerLike<OperationState<TResult>, TResult>