azure-native.documentdb.listMongoClusterConnectionStrings
Explore with Pulumi AI
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:
- Mongo
Cluster stringName - The name of the mongo cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Mongo
Cluster stringName - The name of the mongo cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- mongo
Cluster StringName - The name of the mongo cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- mongo
Cluster stringName - The name of the mongo cluster.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- mongo_
cluster_ strname - The name of the mongo cluster.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- mongo
Cluster StringName - The name of the mongo cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
listMongoClusterConnectionStrings Result
The following output properties are available:
- Connection
Strings List<Pulumi.Azure Native. Document DB. Outputs. Connection String Response> - An array that contains the connection strings for a mongo cluster.
- Connection
Strings []ConnectionString Response - An array that contains the connection strings for a mongo cluster.
- connection
Strings List<ConnectionString Response> - An array that contains the connection strings for a mongo cluster.
- connection
Strings ConnectionString Response[] - An array that contains the connection strings for a mongo cluster.
- connection_
strings Sequence[ConnectionString Response] - An array that contains the connection strings for a mongo cluster.
- connection
Strings List<Property Map> - An array that contains the connection strings for a mongo cluster.
Supporting Types
ConnectionStringResponse
- Connection
String string - Value of the connection string
- Description string
- Description of the connection string
- Connection
String string - Value of the connection string
- Description string
- Description of the connection string
- connection
String String - Value of the connection string
- description String
- Description of the connection string
- connection
String 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
- connection
String 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