@azure/arm-mongodbatlas package

Классы

AtlasClient

Интерфейсы

AtlasClientOptionalParams	Необязательные параметры для клиента.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций.
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
MarketplaceDetails	Сведения о Marketplace для организации
OfferDetails	Сведения о предложении для Marketplace, выбранной пользователем
Operation	Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов
OperationDisplay	Локализованные сведения о отображении и операции.
OperationsListOptionalParams	Необязательные параметры.
OperationsOperations	Интерфейс, представляющий операции операций.
OrganizationProperties	Свойства, относящиеся к организации
OrganizationResource	Определение модели ресурсов для организации Azure
OrganizationResourceUpdate	Тип, используемый для операций обновления ресурса OrganizationResource.
OrganizationResourceUpdateProperties	Обновляемые свойства объекта OrganizationResource.
OrganizationsCreateOrUpdateOptionalParams	Необязательные параметры.
OrganizationsDeleteOptionalParams	Необязательные параметры.
OrganizationsGetOptionalParams	Необязательные параметры.
OrganizationsListByResourceGroupOptionalParams	Необязательные параметры.
OrganizationsListBySubscriptionOptionalParams	Необязательные параметры.
OrganizationsOperations	Интерфейс, представляющий операции организации.
OrganizationsUpdateOptionalParams	Необязательные параметры.
PageSettings	Параметры метода byPage
PagedAsyncIterableIterator	Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
PartnerProperties	Свойства, специфичные для MongoDB
Resource	Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
RestorePollerOptions
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TrackedResource	Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
UserDetails	Сведения о пользователе для организации

Псевдонимы типа

ActionType	Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API. KnownActionType можно использовать взаимозаменяемо с ActionType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой внутренних: действия предназначены для внутренних API.
ContinuablePage	Интерфейс, описывающий страницу результатов.
CreatedByType	Тип сущности, создающей ресурс. <xref:KnowncreatedByType> можно использовать взаимозаменяемо с createdByType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой user: сущность была создана пользователем. приложения: сущность была создана приложением. ManagedIdentity: сущность была создана управляемым удостоверением. ключ: сущность была создана ключом.
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). KnownManagedServiceIdentityType можно использовать взаимозаменяемо с ManagedServiceIdentityType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Нет: нет управляемого удостоверения. SystemAssigned: назначаемое системой управляемое удостоверение. UserAssigned: назначаемое пользователем управляемое удостоверение. SystemAssigned,UserAssigned: управляемое удостоверение, назначаемое системой и пользователем.
MarketplaceSubscriptionStatus	Состояние подписки Marketplace ресурса. KnownMarketplaceSubscriptionStatus можно использовать взаимозаменяемо с MarketplaceSubscriptionStatus, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой PendingFulfillmentStart: приобретено, но еще не активировано подписка: подписка Marketplace активируется приостановленные: это состояние указывает, что платеж клиента за службу Marketplace не был получен отмена подписки: клиент отменил подписку
Origin	Предполагаемый исполнитель операции; как и в RBAC, а также в журналах аудита. Значение по умолчанию — user, system KnownOrigin можно использовать взаимозаменяемо с Origin, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой пользователя. Указывает, что операция инициируется пользователем. системный: указывает, что операция инициируется системой. пользователя, системная: указывает, что операция инициируется пользователем или системой.
ResourceProvisioningState	Состояние подготовки типа ресурса. KnownResourceProvisioningState можно использовать взаимозаменяемо с ResourceProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой успешно создан: ресурс создан. сбой: сбой создания ресурса. отменено: создание ресурса было отменено.

Перечисления

KnownActionType	Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.
KnownCreatedByType	Тип сущности, создающей ресурс.
KnownManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
KnownMarketplaceSubscriptionStatus	Состояние подписки Marketplace ресурса.
KnownOrigin	Предполагаемый исполнитель операции; как и в RBAC, а также в журналах аудита. Значение по умолчанию — user, system
KnownResourceProvisioningState	Состояние подготовки типа ресурса.
KnownVersions	Поддерживаемые версии ресурсной модели MongoDB.Atlas

Функции

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

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

Сведения о функции

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

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

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

Параметры

client

AtlasClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Возвращаемое значение

PollerLike<OperationState<TResult>, TResult>