Partager via


Database Accounts - List Connection Strings

Listes les chaînes de connexion pour le compte de base de données Azure Cosmos DB spécifié.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings?api-version=2024-05-15

Paramètres URI

Nom Dans Obligatoire Type Description
accountName
path True

string

Nom du compte de base de données Cosmos DB.

Modèle d’expression régulière: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

DatabaseAccountListConnectionStringsResult

L’opération s’est terminée avec succès.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

Exemple de requête

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listConnectionStrings?api-version=2024-05-15

Exemple de réponse

{
  "connectionStrings": [
    {
      "connectionString": "connection-string",
      "description": "Primary SQL Connection String",
      "keyKind": "Primary",
      "type": "Sql"
    }
  ]
}

CosmosDBDatabaseAccountListConnectionStringsMongo

Exemple de requête

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/mongo-ddb1/listConnectionStrings?api-version=2024-05-15

Exemple de réponse

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

Définitions

Nom Description
DatabaseAccountConnectionString

Chaîne de connexion pour le compte Cosmos DB

DatabaseAccountListConnectionStringsResult

Chaînes de connexion pour le compte de base de données donné.

Kind

Type de clé chaîne de connexion

Type

Type du chaîne de connexion

DatabaseAccountConnectionString

Chaîne de connexion pour le compte Cosmos DB

Nom Type Description
connectionString

string

Valeur du chaîne de connexion

description

string

Description du chaîne de connexion

keyKind

Kind

Type de clé chaîne de connexion

type

Type

Type du chaîne de connexion

DatabaseAccountListConnectionStringsResult

Chaînes de connexion pour le compte de base de données donné.

Nom Type Description
connectionStrings

DatabaseAccountConnectionString[]

Tableau qui contient les chaînes de connexion pour le compte Cosmos DB.

Kind

Type de clé chaîne de connexion

Nom Type Description
Primary

string

PrimaryReadonly

string

Secondary

string

SecondaryReadonly

string

Type

Type du chaîne de connexion

Nom Type Description
Cassandra

string

CassandraConnectorMetadata

string

Gremlin

string

GremlinV2

string

MongoDB

string

Sql

string

SqlDedicatedGateway

string

Table

string

Undefined

string