Database Accounts - List Connection Strings

Lists the connection strings for the specified Azure Cosmos DB database account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings?api-version=2020-06-01-preview

URI Parameters

Name In Required Type Description
accountName
path True
  • string

Cosmos DB database account name.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

The operation completed successfully.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Impersonate your user account

Examples

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listConnectionStrings?api-version=2020-06-01-preview

Sample Response

{}

CosmosDBDatabaseAccountListConnectionStringsMongo

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/mongo-ddb1/listConnectionStrings?api-version=2020-06-01-preview

Sample Response

{
  "connectionStrings": [
    {
      "connectionString": "connection-string",
      "description": "Name of the connection string"
    }
  ]
}

Definitions

DatabaseAccountConnectionString

Connection string for the Cosmos DB account

DatabaseAccountListConnectionStringsResult

The connection strings for the given database account.

DatabaseAccountConnectionString

Connection string for the Cosmos DB account

Name Type Description
connectionString
  • string

Value of the connection string

description
  • string

Description of the connection string

DatabaseAccountListConnectionStringsResult

The connection strings for the given database account.

Name Type Description
connectionStrings

An array that contains the connection strings for the Cosmos DB account.