Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. mongocluster
  5. listMongoClusterConnectionStrings
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.mongocluster.listMongoClusterConnectionStrings

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

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.

Uses Azure REST API version 2024-07-01.

Other available API versions: 2024-03-01-preview, 2024-06-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native mongocluster [ApiVersion]. See the version guide for details.

Using listMongoClusterConnectionStrings

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function listMongoClusterConnectionStrings(args: ListMongoClusterConnectionStringsArgs, opts?: InvokeOptions): Promise<ListMongoClusterConnectionStringsResult>
function listMongoClusterConnectionStringsOutput(args: ListMongoClusterConnectionStringsOutputArgs, opts?: InvokeOptions): Output<ListMongoClusterConnectionStringsResult>
Copy
def list_mongo_cluster_connection_strings(mongo_cluster_name: Optional[str] = None,
                                          resource_group_name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> ListMongoClusterConnectionStringsResult
def list_mongo_cluster_connection_strings_output(mongo_cluster_name: Optional[pulumi.Input[str]] = None,
                                          resource_group_name: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[ListMongoClusterConnectionStringsResult]
Copy
func ListMongoClusterConnectionStrings(ctx *Context, args *ListMongoClusterConnectionStringsArgs, opts ...InvokeOption) (*ListMongoClusterConnectionStringsResult, error)
func ListMongoClusterConnectionStringsOutput(ctx *Context, args *ListMongoClusterConnectionStringsOutputArgs, opts ...InvokeOption) ListMongoClusterConnectionStringsResultOutput
Copy

> Note: This function is named ListMongoClusterConnectionStrings in the Go SDK.

public static class ListMongoClusterConnectionStrings 
{
    public static Task<ListMongoClusterConnectionStringsResult> InvokeAsync(ListMongoClusterConnectionStringsArgs args, InvokeOptions? opts = null)
    public static Output<ListMongoClusterConnectionStringsResult> Invoke(ListMongoClusterConnectionStringsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListMongoClusterConnectionStringsResult> listMongoClusterConnectionStrings(ListMongoClusterConnectionStringsArgs args, InvokeOptions options)
public static Output<ListMongoClusterConnectionStringsResult> listMongoClusterConnectionStrings(ListMongoClusterConnectionStringsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:mongocluster:listMongoClusterConnectionStrings
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MongoClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
MongoClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
mongoClusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the mongo cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
mongoClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
mongo_cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the mongo cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
mongoClusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the mongo cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

listMongoClusterConnectionStrings Result

The following output properties are available:

ConnectionStrings List<Pulumi.AzureNative.MongoCluster.Outputs.ConnectionStringResponse>
An array that contains the connection strings for a mongo cluster.
ConnectionStrings []ConnectionStringResponse
An array that contains the connection strings for a mongo cluster.
connectionStrings List<ConnectionStringResponse>
An array that contains the connection strings for a mongo cluster.
connectionStrings ConnectionStringResponse[]
An array that contains the connection strings for a mongo cluster.
connection_strings Sequence[ConnectionStringResponse]
An array that contains the connection strings for a mongo cluster.
connectionStrings List<Property Map>
An array that contains the connection strings for a mongo cluster.

Supporting Types

ConnectionStringResponse

ConnectionString This property is required. string
Value of the connection string
Description This property is required. string
Description of the connection string
Name This property is required. string
Name of the connection string.
ConnectionString This property is required. string
Value of the connection string
Description This property is required. string
Description of the connection string
Name This property is required. string
Name of the connection string.
connectionString This property is required. String
Value of the connection string
description This property is required. String
Description of the connection string
name This property is required. String
Name of the connection string.
connectionString This property is required. string
Value of the connection string
description This property is required. string
Description of the connection string
name This property is required. string
Name of the connection string.
connection_string This property is required. str
Value of the connection string
description This property is required. str
Description of the connection string
name This property is required. str
Name of the connection string.
connectionString This property is required. String
Value of the connection string
description This property is required. String
Description of the connection string
name This property is required. String
Name of the connection string.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native