Skip to main content

mongo_clusters_connection_strings

Creates, updates, deletes, gets or lists a mongo_clusters_connection_strings resource.

Overview

Namemongo_clusters_connection_strings
TypeResource
Idazure_isv.mongo_db.mongo_clusters_connection_strings

Fields

The following fields are returned by SELECT queries:

Azure operation completed successfully.

NameDatatypeDescription
connectionStringsarrayAn array that contains the connection strings for a mongo cluster.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectsubscriptionId, resourceGroupName, mongoClusterNameList mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
mongoClusterNamestringThe name of the mongo cluster.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
subscriptionIdstring (uuid)The ID of the target subscription. The value must be an UUID.

SELECT examples

List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.

SELECT
connectionStrings
FROM azure_isv.mongo_db.mongo_clusters_connection_strings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mongoClusterName = '{{ mongoClusterName }}' -- required
;