1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. listDatabaseAccountConnectionStrings
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.documentdb.listDatabaseAccountConnectionStrings

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Lists the connection strings for the specified Azure Cosmos DB database account. Azure REST API version: 2023-04-15.

Other available API versions: 2021-04-01-preview, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview.

Using listDatabaseAccountConnectionStrings

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 listDatabaseAccountConnectionStrings(args: ListDatabaseAccountConnectionStringsArgs, opts?: InvokeOptions): Promise<ListDatabaseAccountConnectionStringsResult>
function listDatabaseAccountConnectionStringsOutput(args: ListDatabaseAccountConnectionStringsOutputArgs, opts?: InvokeOptions): Output<ListDatabaseAccountConnectionStringsResult>
Copy
def list_database_account_connection_strings(account_name: Optional[str] = None,
                                             resource_group_name: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> ListDatabaseAccountConnectionStringsResult
def list_database_account_connection_strings_output(account_name: Optional[pulumi.Input[str]] = None,
                                             resource_group_name: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[ListDatabaseAccountConnectionStringsResult]
Copy
func ListDatabaseAccountConnectionStrings(ctx *Context, args *ListDatabaseAccountConnectionStringsArgs, opts ...InvokeOption) (*ListDatabaseAccountConnectionStringsResult, error)
func ListDatabaseAccountConnectionStringsOutput(ctx *Context, args *ListDatabaseAccountConnectionStringsOutputArgs, opts ...InvokeOption) ListDatabaseAccountConnectionStringsResultOutput
Copy

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

public static class ListDatabaseAccountConnectionStrings 
{
    public static Task<ListDatabaseAccountConnectionStringsResult> InvokeAsync(ListDatabaseAccountConnectionStringsArgs args, InvokeOptions? opts = null)
    public static Output<ListDatabaseAccountConnectionStringsResult> Invoke(ListDatabaseAccountConnectionStringsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListDatabaseAccountConnectionStringsResult> listDatabaseAccountConnectionStrings(ListDatabaseAccountConnectionStringsArgs args, InvokeOptions options)
public static Output<ListDatabaseAccountConnectionStringsResult> listDatabaseAccountConnectionStrings(ListDatabaseAccountConnectionStringsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:listDatabaseAccountConnectionStrings
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
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.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

listDatabaseAccountConnectionStrings Result

The following output properties are available:

ConnectionStrings List<Pulumi.AzureNative.DocumentDB.Outputs.DatabaseAccountConnectionStringResponse>
An array that contains the connection strings for the Cosmos DB account.
ConnectionStrings []DatabaseAccountConnectionStringResponse
An array that contains the connection strings for the Cosmos DB account.
connectionStrings List<DatabaseAccountConnectionStringResponse>
An array that contains the connection strings for the Cosmos DB account.
connectionStrings DatabaseAccountConnectionStringResponse[]
An array that contains the connection strings for the Cosmos DB account.
connection_strings Sequence[DatabaseAccountConnectionStringResponse]
An array that contains the connection strings for the Cosmos DB account.
connectionStrings List<Property Map>
An array that contains the connection strings for the Cosmos DB account.

Supporting Types

DatabaseAccountConnectionStringResponse

ConnectionString This property is required. string
Value of the connection string
Description This property is required. string
Description of the connection string
KeyKind This property is required. string
Kind of the connection string key
Type This property is required. string
Type 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
KeyKind This property is required. string
Kind of the connection string key
Type This property is required. string
Type 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
keyKind This property is required. String
Kind of the connection string key
type This property is required. String
Type 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
keyKind This property is required. string
Kind of the connection string key
type This property is required. string
Type 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
key_kind This property is required. str
Kind of the connection string key
type This property is required. str
Type 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
keyKind This property is required. String
Kind of the connection string key
type This property is required. String
Type of the connection string

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi