MongoClustersOperations interface

Пакет:

@azure/arm-mongocluster

Интерфейс, представляющий операции MongoClusters.

Свойства

checkNameAvailability	Проверьте, доступно ли имя кластера Mongo для использования.
createOrUpdate	Создание или обновление кластера mongo. Обновление перезаписывает все свойства ресурса. Чтобы изменить только некоторые свойства, используйте PATCH.
delete
get	Возвращает сведения о кластере mongo.
list	Список всех кластеров Mongo в данной подписке.
listByResourceGroup	Список всех кластеров Mongo в заданной группе ресурсов.
listConnectionStrings	Список строк подключения к кластеру Mongo. Это включает строку подключения по умолчанию с помощью SCRAM-SHA-256, а также других строк подключения, поддерживаемых кластером.
promote	Способствует кластеру mongo реплики к основной роли.
update	Обновляет существующий кластер Mongo. Текст запроса может содержать один ко многим свойствам, присутствующих в обычном определении кластера Mongo.

Сведения о свойстве

checkNameAvailability

Проверьте, доступно ли имя кластера Mongo для использования.

checkNameAvailability: (location: string, body: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>

Значение свойства

(location: string, body: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>

createOrUpdate

Создание или обновление кластера mongo. Обновление перезаписывает все свойства ресурса. Чтобы изменить только некоторые свойства, используйте PATCH.

createOrUpdate: (resourceGroupName: string, mongoClusterName: string, resource: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>

Значение свойства

(resourceGroupName: string, mongoClusterName: string, resource: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>

delete

delete: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Значение свойства

(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Возвращает сведения о кластере mongo.

get: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams) => Promise<MongoCluster>

Значение свойства

(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams) => Promise<MongoCluster>

list

Список всех кластеров Mongo в данной подписке.

list: (options?: MongoClustersListOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

Значение свойства

(options?: MongoClustersListOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

listByResourceGroup

Список всех кластеров Mongo в заданной группе ресурсов.

listByResourceGroup: (resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

Значение свойства

(resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

listConnectionStrings

Список строк подключения к кластеру Mongo. Это включает строку подключения по умолчанию с помощью SCRAM-SHA-256, а также других строк подключения, поддерживаемых кластером.

listConnectionStrings: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams) => Promise<ListConnectionStringsResult>

Значение свойства

(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams) => Promise<ListConnectionStringsResult>

promote

Способствует кластеру mongo реплики к основной роли.

promote: (resourceGroupName: string, mongoClusterName: string, body: PromoteReplicaRequest, options?: MongoClustersPromoteOptionalParams) => PollerLike<OperationState<void>, void>

Значение свойства

(resourceGroupName: string, mongoClusterName: string, body: PromoteReplicaRequest, options?: MongoClustersPromoteOptionalParams) => PollerLike<OperationState<void>, void>

update

Обновляет существующий кластер Mongo. Текст запроса может содержать один ко многим свойствам, присутствующих в обычном определении кластера Mongo.

update: (resourceGroupName: string, mongoClusterName: string, properties: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>

Значение свойства

(resourceGroupName: string, mongoClusterName: string, properties: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>