1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. listMongoClusterConnectionStrings
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi

azure-native.documentdb.listMongoClusterConnectionStrings

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi

    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. Azure REST API version: 2023-03-15-preview.

    Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-03-01-preview.

    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>
    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]
    func ListMongoClusterConnectionStrings(ctx *Context, args *ListMongoClusterConnectionStringsArgs, opts ...InvokeOption) (*ListMongoClusterConnectionStringsResult, error)
    func ListMongoClusterConnectionStringsOutput(ctx *Context, args *ListMongoClusterConnectionStringsOutputArgs, opts ...InvokeOption) ListMongoClusterConnectionStringsResultOutput

    > 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)
    }
    public static CompletableFuture<ListMongoClusterConnectionStringsResult> listMongoClusterConnectionStrings(ListMongoClusterConnectionStringsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:listMongoClusterConnectionStrings
      arguments:
        # arguments dictionary

    The following arguments are supported:

    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    mongoClusterName string
    The name of the mongo cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    mongo_cluster_name str
    The name of the mongo cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    listMongoClusterConnectionStrings Result

    The following output properties are available:

    ConnectionStrings List<Pulumi.AzureNative.DocumentDB.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 string
    Value of the connection string
    Description string
    Description of the connection string
    ConnectionString string
    Value of the connection string
    Description string
    Description of the connection string
    connectionString String
    Value of the connection string
    description String
    Description of the connection string
    connectionString string
    Value of the connection string
    description string
    Description of the connection string
    connection_string str
    Value of the connection string
    description str
    Description of the connection string
    connectionString String
    Value of the connection string
    description String
    Description of the connection string

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi