Skip to main content

mongo_clusters

Overview

Namemongo_clusters
TypeResource
Idazure.cosmos_db.mongo_clusters

Fields

NameDatatypeDescription
locationstringThe geo-location where the resource lives
propertiesobjectThe properties of a mongo cluster.
tagsobjectResource tags.

Methods

NameAccessible byRequired ParamsDescription
getSELECTmongoClusterName, resourceGroupName, subscriptionIdGets information about a mongo cluster.
listSELECTsubscriptionIdList all the mongo clusters in a given subscription.
list_by_resource_groupSELECTresourceGroupName, subscriptionIdList all the mongo clusters in a given resource group.
create_or_updateINSERTmongoClusterName, resourceGroupName, subscriptionIdCreate or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.
deleteDELETEmongoClusterName, resourceGroupName, subscriptionIdDeletes a mongo cluster.
_listEXECsubscriptionIdList all the mongo clusters in a given subscription.
_list_by_resource_groupEXECresourceGroupName, subscriptionIdList all the mongo clusters in a given resource group.
check_name_availabilityEXEClocation, subscriptionIdCheck the availability of name for resource
updateEXECmongoClusterName, resourceGroupName, subscriptionIdUpdates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.