MongoClustersOperations interface
表示 MongoClusters 作業的介面。
屬性
check |
檢查 mongo 叢集名稱是否可供使用。 |
create |
建立或更新 Mongo 叢集。 更新會覆寫資源的所有屬性。 若要只修改某些屬性,請使用 PATCH。 |
delete | 刪除 mongo 叢集。 |
get | 取得 mongo 叢集的相關信息。 |
list | 列出指定訂用帳戶中的所有 Mongo 叢集。 |
list |
列出指定資源群組中的所有 Mongo 叢集。 |
list |
列出 mongo 叢集連接字串。 這包括使用 SCRAM-SHA-256 的預設連接字串,以及叢集支援的其他連接字串。 |
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
刪除 mongo 叢集。
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>
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>