Partilhar via


@azure/arm-mongocluster package

Classes

MongoClusterManagementClient

Interfaces

CheckNameAvailabilityRequest

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

CheckNameAvailabilityResponse

O resultado da verificação da disponibilidade.

ConnectionString

Cadeia de conexão para o cluster mongo

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.

ListConnectionStringsResult

As cadeias de conexão para um determinado cluster mongo.

MongoCluster

Representa um recurso de cluster mongo.

MongoClusterManagementClientOptionalParams

Parâmetros opcionais para o cliente.

MongoClusterProperties

As propriedades de um cluster mongo.

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.

MongoClustersUpdateOptionalParams

Parâmetros opcionais.

NodeGroupSpec

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

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 Ponto Final 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.

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

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

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

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

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

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

do Utilizador
Application
ManagedIdentity
Key

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
de provisionamento
Atualização
Começando
Parar
parou
Largando

NodeKind

O tipo de nó no cluster.
KnownNodeKind pode ser usado de forma intercambiável com NodeKind, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Shard

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

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

Sucedeu
Criação de
Excluindo
Falhou

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
Aprovado
Rejeitado

ProvisioningState

Alias para ProvisioningState

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
Deficientes

ResourceProvisioningState

O estado de provisionamento de um tipo de recurso.
KnownResourceProvisioningState pode ser usado de forma intercambiável com ResourceProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Sucedeu
Falhou
Cancelado

Versions

As versões de API disponíveis.

Enumerações

KnownActionType

Os valores conhecidos de ActionType que o serviço aceita.

KnownCheckNameAvailabilityReason

Os valores conhecidos de CheckNameAvailabilityReason que o serviço aceita.

KnownCreateMode

Os valores conhecidos de CreateMode que o serviço aceita.

KnownCreatedByType

Os valores conhecidos de CreatedByType que o serviço aceita.

KnownMongoClusterStatus

Os valores conhecidos de MongoClusterStatus que o serviço aceita.

KnownNodeKind

Os valores conhecidos de NodeKind que o serviço aceita.

KnownOrigin

Valores conhecidos de Origem que o serviço aceita.

KnownPrivateEndpointConnectionProvisioningState

Os valores conhecidos de PrivateEndpointConnectionProvisioningState que o serviço aceita.

KnownPrivateEndpointServiceConnectionStatus

Os valores conhecidos de PrivateEndpointServiceConnectionStatus que o serviço aceita.

KnownPublicNetworkAccess

Os valores conhecidos de PublicNetworkAccess que o serviço aceita.

KnownResourceProvisioningState

Os valores conhecidos de ResourceProvisioningState que o serviço aceita.

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

serializedState

string

sourceOperation

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

Devoluções

PollerLike<OperationState<TResult>, TResult>