@azure/arm-mongocluster package

Classes

MongoClusterManagementClient

Interfaces

CheckNameAvailabilityRequest

O corpo da solicitação de disponibilidade de verificação.

CheckNameAvailabilityResponse

O resultado da disponibilidade de verificação.

ConnectionString

Cadeia de conexão para o cluster mongo

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.

ListConnectionStringsResult

As cadeias de conexão para o cluster mongo especificado.

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.

NodeGroupSpec

Especificação de um grupo de nós.

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
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'

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

Interna

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
AlreadyExists

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
PointInTimeRestore
GeoReplica
Replica

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

de usuário do
application
ManagedIdentity
key

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
provisionamento
atualizando
iniciando
parar
parado
de remoção

NodeKind

O tipo do nó no cluster.
KnownNodeKind pode ser usado de forma intercambiável com NodeKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

de Fragmentos

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
sistema
usuário, do 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

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
criando
excluindo
falha na

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
aprovado
rejeitado

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

de Alternância

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çada

ProvisioningState

O estado de provisionamento de um tipo de recurso.
KnownProvisioningState pode ser usado de forma intercambiável com ResourceProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

êxito
falha na
Cancelada
InProgress
atualizando
de remoção

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

habilitado
desabilitado

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 do
AsyncReplica
GeoAsyncReplica

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

Active
de recuperação
provisionamento
atualizando
Desfeito
reconfigurando

Enumerações

KnownActionType

Valores conhecidos de ActionType que o serviço aceita.

KnownCheckNameAvailabilityReason

Valores conhecidos de CheckNameAvailabilityReason que o serviço aceita.

KnownCreateMode

Valores conhecidos de CreateMode que o serviço aceita.

KnownCreatedByType

Valores conhecidos de CreatedByType que o serviço aceita.

KnownMongoClusterStatus

Valores conhecidos de MongoClusterStatus que o serviço aceita.

KnownNodeKind

Valores conhecidos de NodeKind que o serviço aceita.

KnownOrigin

Valores conhecidos de Origin que o serviço aceita.

KnownPreviewFeature

Valores conhecidos de PreviewFeature que o serviço aceita.

KnownPrivateEndpointConnectionProvisioningState

Valores conhecidos de PrivateEndpointConnectionProvisioningState que o serviço aceita.

KnownPrivateEndpointServiceConnectionStatus

Valores conhecidos de PrivateEndpointServiceConnectionStatus que o serviço aceita.

KnownPromoteMode

Valores conhecidos de PromoteMode que o serviço aceita.

KnownPromoteOption

Valores conhecidos de PromoteOption que o serviço aceita.

KnownProvisioningState

Valores conhecidos de ProvisioningState que o serviço aceita.

KnownPublicNetworkAccess

Valores conhecidos de PublicNetworkAccess que o serviço aceita.

KnownReplicationRole

Valores conhecidos de ReplicationRole que o serviço aceita.

KnownReplicationState

Valores conhecidos de ReplicationState que o serviço aceita.

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

serializedState

string

sourceOperation

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

Retornos

PollerLike<OperationState<TResult>, TResult>