@azure/arm-mongocluster package

Классы

MongoClusterManagementClient

Интерфейсы

AdministratorProperties	Свойства входа локального администратора.
AuthConfigProperties	Конфигурация аутентификации для кластера Mongo.
BackupProperties	Свойства резервного копирования кластера. Сюда входят самые ранние параметры времени восстановления и хранения.
CheckNameAvailabilityRequest	Текст запроса проверки доступности.
CheckNameAvailabilityResponse	Результат проверки доступности.
ComputeProperties	Свойства вычислений кластера. К ним относятся виртуальные ядра или память и параметры масштабирования, применяемые к серверам в кластере.
ConnectionString	Строка подключения для кластера Mongo
CustomerManagedKeyEncryptionProperties	Настройки шифрования ключа, управляемые клиентом.
DataApiProperties	Свойства API данных.
DatabaseRole	Определение роли базы данных, назначенной пользователю.
EncryptionProperties	Конфигурация шифрования для кластера mongo.
EntraIdentityProvider	Определяет пользователя Microsoft Entra ID Mongo.
EntraIdentityProviderProperties	Свойства поставщика Microsoft Entra ID.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций.
FirewallRule	Представляет правило брандмауэра кластера Mongo.
FirewallRuleProperties	Свойства правила брандмауэра кластера Mongo.
FirewallRulesCreateOrUpdateOptionalParams	Необязательные параметры.
FirewallRulesDeleteOptionalParams	Необязательные параметры.
FirewallRulesGetOptionalParams	Необязательные параметры.
FirewallRulesListByMongoClusterOptionalParams	Необязательные параметры.
FirewallRulesOperations	Интерфейс, представляющий операции FirewallRules.
HighAvailabilityProperties	Свойства высокого уровня доступности кластера.
IdentityProvider	Определяет определение поставщика удостоверений пользователя.
KeyEncryptionKeyIdentity	Удостоверение, используемое для ключа шифрования ключа.
ListConnectionStringsResult	Строки подключения для данного кластера Mongo.
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
MongoCluster	Представляет ресурс кластера Mongo.
MongoClusterManagementClientOptionalParams	Необязательные параметры для клиента.
MongoClusterProperties	Свойства кластера mongo.
MongoClusterReplicaParameters	Параметры, используемые для операций реплики.
MongoClusterRestoreParameters	Параметры, используемые для операций восстановления
MongoClusterUpdate	Тип, используемый для операций обновления MongoCluster.
MongoClusterUpdateProperties	Обновляемые свойства MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Необязательные параметры.
MongoClustersCreateOrUpdateOptionalParams	Необязательные параметры.
MongoClustersDeleteOptionalParams	Необязательные параметры.
MongoClustersGetOptionalParams	Необязательные параметры.
MongoClustersListByResourceGroupOptionalParams	Необязательные параметры.
MongoClustersListConnectionStringsOptionalParams	Необязательные параметры.
MongoClustersListOptionalParams	Необязательные параметры.
MongoClustersOperations	Интерфейс, представляющий операции MongoClusters.
MongoClustersPromoteOptionalParams	Необязательные параметры.
MongoClustersUpdateOptionalParams	Необязательные параметры.
Operation	Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов
OperationDisplay	Локализованные сведения о отображении и операции.
OperationsListOptionalParams	Необязательные параметры.
OperationsOperations	Интерфейс, представляющий операции операций.
PageSettings	Параметры метода byPage
PagedAsyncIterableIterator	Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
PrivateEndpoint	Ресурс частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке
PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки.
PrivateEndpointConnectionResource	Конкретные типы ресурсов прокси-сервера можно создать путем псевдонима этого типа с помощью определенного типа свойства.
PrivateEndpointConnectionsCreateOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsDeleteOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsGetOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsOperations	Интерфейс, представляющий операции PrivateEndpointConnections.
PrivateLinkResource	Конкретные типы ресурсов прокси-сервера можно создать путем псевдонима этого типа с помощью определенного типа свойства.
PrivateLinkResourceProperties	Свойства ресурса приватного канала.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
PrivateLinksListByMongoClusterOptionalParams	Необязательные параметры.
PrivateLinksOperations	Интерфейс, представляющий операции PrivateLinks.
PromoteReplicaRequest	Повышение свойств запроса реплики.
ProxyResource	Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
Replica	Представляет реплику кластера Mongo.
ReplicasListByParentOptionalParams	Необязательные параметры.
ReplicasOperations	Интерфейс, представляющий операции реплик.
ReplicationProperties	Свойства реплики кластера Mongo.
Resource	Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
RestorePollerOptions
ShardingProperties	Свойства сегментирования кластера. Сюда входят параметры подсчета сегментов и масштабирования кластера.
StorageProperties	Свойства хранилища кластера. К ним относятся размер хранилища данных и масштабирование, применяемые к серверам в кластере.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TrackedResource	Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
User	Представляет пользователя кластера Mongo.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
UserProperties	Определение пользовательского ресурса Mongo в кластере.
UsersCreateOrUpdateOptionalParams	Необязательные параметры.
UsersDeleteOptionalParams	Необязательные параметры.
UsersGetOptionalParams	Необязательные параметры.
UsersListByMongoClusterOptionalParams	Необязательные параметры.
UsersOperations	Интерфейс, представляющий операции пользователей.

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

ActionType	Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API. KnownActionType можно использовать взаимозаменяемо с ActionType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой внутренних: действия предназначены для внутренних API.
AuthenticationMode	Режимы аутентификации, поддерживаемые на кластере Mongo. KnownAuthenticationMode может использоваться взаимозаменяемо с AuthenticationMode, это перечисление содержит известные значения, которые поддерживает служба. Известные значения, поддерживаемые службой NativeAuth: Нативный режим аутентификации mongo с использованием имени пользователя и пароля с механизмом аутентификации 'SCRAM-SHA-256'. MicrosoftEntraID: режим проверки подлинности Microsoft Entra ID с использованием пользователей Entra, назначенных кластеру, и механизма проверки подлинности MONGODB-OIDC.
AzureSupportedClouds	Поддерживаемые значения для настройки облака в виде строкового литерала
CheckNameAvailabilityReason	Возможные причины недоступности имени. KnownCheckNameAvailabilityReason можно использовать взаимозаменяемо с CheckNameAvailabilityReason, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Invalid: Имя неверно. AlreadyExists: Имя уже существует.
ContinuablePage	Интерфейс, описывающий страницу результатов.
CreateMode	Режим создания кластера Mongo. KnownCreateMode можно использовать взаимозаменяемо с CreateMode, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой По умолчанию: создание нового кластера mongo. PointInTimeRestore: создание кластера mongo на основе восстановления на определенный момент времени. GeoReplica: создание кластера реплик в отдельном географическом регионе от исходного кластера. Реплика: создание кластера реплик в том же географическом регионе, что и исходный кластер.
CreatedByType	Тип сущности, создающей ресурс. KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой user: сущность была создана пользователем. приложения: сущность была создана приложением. ManagedIdentity: сущность была создана управляемым удостоверением. ключ: сущность была создана ключом.
DataApiMode	Режим, который будет применяться к Mongo Data API. KnownDataApiMode можно использовать взаимозаменяемо с DataApiMode, это перечисление содержит известные значения, которые поддерживает служба. Известные значения, поддерживаемые службой Включено: для кластера включен API данных Mongo. Отключено: Mongo Data API отключен для кластера.
EntraPrincipalType	Типы участников Microsoft Entra ID доступны для пользователя Mongo. KnownEntraPrincipalType можно использовать взаимозаменяемо с EntraPrincipalType, это перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой user: тип пользователя Entra. servicePrincipal: тип субъекта-службы Entra.
HighAvailabilityMode	Режимы высокой доступности для кластера. KnownHighAvailabilityMode можно использовать взаимозаменяемо с HighAvailabilityMode, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Отключено: режим высокой доступности отключен. Этот режим может влиять на доступность во время неисправностей или технического обслуживания и не рекомендуется для производства. SameZone: включен режим высокой доступности, в котором каждый сервер в сегменте находится в одной зоне доступности. ZoneRedundantPreferred: включен режим высокого уровня доступности и предпочтительно ZoneRedundant, если в регионе доступна емкость зон доступности, в противном случае возвращается к подготовке с помощью SameZone.
IdentityProviderType	Типы поставщиков удостоверений, к которым может принадлежать удостоверение пользователя. KnownIdentityProviderType может использоваться взаимозаменяемо с IdentityProviderType, это перечисление содержит известные значения, которые поддерживает служба. Известные значения, поддерживаемые службой MicrosoftEntraID: поставщик идентификаторов Microsoft Entra.
IdentityProviderUnion	Псевдоним для IdentityProviderUnion
KeyEncryptionKeyIdentityType	Тип удостоверения ключа шифрования ключа. KnownKeyEncryptionKeyIdentityType может использоваться взаимозаменяемо с KeyEncryptionKeyIdentityType, это перечисление содержит известные значения, которые поддерживает служба. Известные значения, поддерживаемые службой UserAssignedIdentity: Удостоверение, назначенное пользователем.
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). KnownManagedServiceIdentityType можно использовать взаимозаменяемо с ManagedServiceIdentityType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Нет: Нет управляемой идентификации. SystemAssigned: управляемое удостоверение, назначаемое системой. UserAssigned: управляемое удостоверение, назначаемое пользователем. SystemAssigned,UserAssigned: управляемое удостоверение, назначаемое системой и пользователем.
MongoClusterStatus	Состояние ресурса кластера Mongo. KnownMongoClusterStatus можно использовать взаимозаменяемо с MongoClusterStatus, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Готово: ресурс кластера mongo готов к использованию. Инициализация: ресурс кластера mongo инициализируется. Обновление: Ресурс кластера mongo обновляется. Запуск: запускается ресурс кластера mongo. Остановка: ресурс кластера mongo останавливается. Остановлено: ресурс кластера mongo остановлен. Отбрасывание: ресурс кластера mongo удаляется.
Origin	Предполагаемый исполнитель операции; как и в RBAC, а также в журналах аудита. Значение по умолчанию — user, system KnownOrigin можно использовать взаимозаменяемо с Origin, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой пользователя. Указывает, что операция инициируется пользователем. системный: указывает, что операция инициируется системой. пользователя, системная: указывает, что операция инициируется пользователем или системой.
PreviewFeature	Предварительные версии функций, которые можно включить в кластере mongo. KnownPreviewFeature можно использовать взаимозаменяемо с PreviewFeature, эта перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой GeoReplicas: Включает функцию предварительного просмотра геореплик. Функция должна быть задана во время создания нового кластера, чтобы можно было связать кластер геореплик с ним.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки. KnownPrivateEndpointConnectionProvisioningState можно использовать взаимозаменяемо с PrivateEndpointConnectionProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Успешно: подключение подготовлено Создание: Соединение создается Удаление: Соединение удаляется Ошибка: сбой подготовки подключения
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке. KnownPrivateEndpointServiceConnectionStatus можно использовать взаимозаменяемо с PrivateEndpointServiceConnectionStatus, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой В ожидании: подключение ожидает подтверждения или отклонения Одобрено: Подключение одобрено Rejected: Соединение отклонено
PromoteMode	Режим, применяемый к операции повышения уровня. KnownPromoteMode можно использовать взаимозаменяемо с PromoteMode, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Переключение: при повышении текущего кластера реплик текущий кластер реплик будет переключен на основную роль, а исходный основной кластер будет переключен на роль реплики, сохраняя связь репликации.
PromoteOption	Параметр, применяемый к операции повышения уровня. KnownPromoteOption можно использовать взаимозаменяемо с PromoteOption, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Принудительно: опция «Продвигать» принудительно продвигает продвижение, не дожидаясь, пока реплика будет доведена до основной. Это может привести к потере данных, поэтому его следует использовать только во время сценариев аварийного восстановления.
ProvisioningState	Состояние подготовки последней принятой операции. KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой успешно создан: ресурс создан. сбой: сбой создания ресурса. отменено: создание ресурса было отменено. InProgress: выполняется операция с ресурсом. Обновление: на ресурсе выполняется операция обновления. Удаление: Операция удаления выполняется на ресурсе.
PublicNetworkAccess	Разрешен доступ к общедоступной конечной точке для этого кластера Mongo. Значение является необязательным, а значение по умолчанию — "Включено" KnownPublicNetworkAccess можно использовать взаимозаменяемо с PublicNetworkAccess, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Включено: Если установлено, доступ к кластеру mongo можно получить через частные и публичные методы. Отключено: если этот параметр установлен, частные конечные точки являются методом эксклюзивного доступа.
ReplicationRole	Роль репликации кластера Mongo. KnownReplicationRole можно использовать взаимозаменяемо с ReplicationRole, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Первичная реплика: кластер является первичной репликой. AsyncReplica: кластер является локальной асинхронной репликой. GeoAsyncReplica: кластер является геоасинхронной репликой.
ReplicationState	Состояние связи репликации между репликой и исходным кластером. KnownReplicationState можно использовать взаимозаменяемо с ReplicationState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Активно: ссылка репликации активна. Догоняющее: реплика догоняет основную. Это может произойти после создания реплики или после активации акции. Инициализация: создается реплика и ссылка репликации на первичную реплику. Обновление: ссылка репликации обновляется в связи с изменением реплики или обновлением. Broken (Разорвано): Ссылка репликации разорвана, и может потребоваться повторное создание реплики. Реконфигурация: ссылка репликации перенастраивается в связи с событием акции.
StorageType	Тип хранилища, с которым может быть подготовлен кластер mongo. KnownStorageType можно использовать взаимозаменяемо с StorageType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой SSD класса "Премиум": SSD класса "Премиум" для высокопроизводительных рабочих нагрузок. SSD (цен. категория "Премиум") версии 2: SSD (цен. категория "Премиум") версии 2 для рабочих нагрузок с интенсивным вводом-выводом. Это вариант предварительного просмотра, который имеет дополнительные ограничения.
UserRole	Встроенная роль базы данных, которая может быть назначена пользователю. KnownUserRole может использоваться взаимозаменяемо с UserRole, это перечисление содержит известные значения, которые поддерживает служба. Известные значения, поддерживаемые службой root: разрешения роли root в целевой области.

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

AzureClouds	Перечисление для описания облачных сред Azure.
KnownActionType	Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.
KnownAuthenticationMode	Режимы аутентификации, поддерживаемые на кластере Mongo.
KnownCheckNameAvailabilityReason	Возможные причины недоступности имени.
KnownCreateMode	Режим создания кластера Mongo.
KnownCreatedByType	Тип сущности, создающей ресурс.
KnownDataApiMode	Режим, который будет применяться к Mongo Data API.
KnownEntraPrincipalType	Типы участников Microsoft Entra ID доступны для пользователя Mongo.
KnownHighAvailabilityMode	Режимы высокой доступности для кластера.
KnownIdentityProviderType	Типы поставщиков удостоверений, к которым может принадлежать удостоверение пользователя.
KnownKeyEncryptionKeyIdentityType	Тип удостоверения ключа шифрования ключа.
KnownManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
KnownMongoClusterStatus	Состояние ресурса кластера Mongo.
KnownOrigin	Предполагаемый исполнитель операции; как и в RBAC, а также в журналах аудита. Значение по умолчанию — user, system
KnownPreviewFeature	Предварительные версии функций, которые можно включить в кластере mongo.
KnownPrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
KnownPrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
KnownPromoteMode	Режим, применяемый к операции повышения уровня.
KnownPromoteOption	Параметр, применяемый к операции повышения уровня.
KnownProvisioningState	Состояние подготовки последней принятой операции.
KnownPublicNetworkAccess	Разрешен доступ к общедоступной конечной точке для этого кластера Mongo. Значение является необязательным, а значение по умолчанию — «Включено»
KnownReplicationRole	Роль репликации кластера Mongo.
KnownReplicationState	Состояние связи репликации между репликой и исходным кластером.
KnownStorageType	Тип хранилища, с которым может быть подготовлен кластер mongo.
KnownUserRole	Встроенная роль базы данных, которая может быть назначена пользователю.
KnownVersions	Доступные версии API.

Функции

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

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

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

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

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

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

Параметры

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

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

PollerLike<OperationState<TResult>, TResult>