@azure/arm-mongodbatlas package

Classes

AtlasClient

Interfaces

AtlasClientOptionalParams	Parâmetros opcionais para o cliente.
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.
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
MarketplaceDetails	Detalhes do Marketplace para uma organização
OfferDetails	Oferecer detalhes para o mercado selecionado pelo usuário
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.
OrganizationProperties	Propriedades específicas da Organização
OrganizationResource	A definição do modelo de recursos para uma Organização do Azure
OrganizationResourceUpdate	O tipo usado para operações de atualização do OrganizationResource.
OrganizationResourceUpdateProperties	As propriedades atualizáveis do OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Parâmetros opcionais.
OrganizationsDeleteOptionalParams	Parâmetros opcionais.
OrganizationsGetOptionalParams	Parâmetros opcionais.
OrganizationsListByResourceGroupOptionalParams	Parâmetros opcionais.
OrganizationsListBySubscriptionOptionalParams	Parâmetros opcionais.
OrganizationsOperations	Interface que representa as operações de uma Organização.
OrganizationsUpdateOptionalParams	Parâmetros opcionais.
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.
PartnerProperties	Propriedades específicas do MongoDB
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'
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
UserDetails	Detalhes do usuário de uma organização

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.
ContinuablePage	Uma interface que descreve uma página de resultados.
CreatedByType	O tipo de entidade que criou o recurso. <xref:KnowncreatedByType> pode ser usado de forma intercambiável com createdByType, este 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.
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.
MarketplaceSubscriptionStatus	Status da assinatura do Marketplace de um recurso. KnownMarketplaceSubscriptionStatus pode ser usado de forma intercambiável com MarketplaceSubscriptionStatus, este enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço PendingFulfillmentStart: Comprado, mas ainda não ativado Subscrição: A subscrição do Marketplace está ativada suspenso: este estado indica que o pagamento de um cliente pelo serviço do Marketplace não foi recebido não subscrito: o Cliente cancelou a subscrição
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.
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 Successful: O recurso foi criado. Falha: Falha na criação de recursos. cancelado: A criação de recursos foi cancelada.

Enumerações

KnownActionType	Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownCreatedByType	O tipo de entidade que criou o recurso.
KnownManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
KnownMarketplaceSubscriptionStatus	Status da assinatura do Marketplace de um recurso.
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"
KnownResourceProvisioningState	O estado de provisionamento de um tipo de recurso.
KnownVersions	Versões suportadas para o modelo de recursos MongoDB.Atlas

Funções

restorePoller<TResponse, TResult>(AtlasClient, 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>(AtlasClient, 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: AtlasClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parâmetros

client

AtlasClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Devoluções

PollerLike<OperationState<TResult>, TResult>