Freigeben über


Database Accounts - List Connection Strings

Listen die Verbindungszeichenfolgen für das angegebene Azure Cosmos DB-Datenbankkonto.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

Name des Cosmos DB-Datenbankkontos.

RegEx-Muster: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

DatabaseAccountListConnectionStringsResult

Der Vorgang wurde erfolgreich abgeschlossen.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

Beispielanforderung

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

Beispiel für eine Antwort

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

CosmosDBDatabaseAccountListConnectionStringsMongo

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
DatabaseAccountConnectionString

Verbindungszeichenfolge für das Cosmos DB-Konto

DatabaseAccountListConnectionStringsResult

Die Verbindungszeichenfolgen für das angegebene Datenbankkonto.

Kind

Art des Verbindungszeichenfolge Schlüssels

Type

Typ der Verbindungszeichenfolge

DatabaseAccountConnectionString

Verbindungszeichenfolge für das Cosmos DB-Konto

Name Typ Beschreibung
connectionString

string

Wert des Verbindungszeichenfolge

description

string

Beschreibung der Verbindungszeichenfolge

keyKind

Kind

Art des Verbindungszeichenfolge Schlüssels

type

Type

Typ der Verbindungszeichenfolge

DatabaseAccountListConnectionStringsResult

Die Verbindungszeichenfolgen für das angegebene Datenbankkonto.

Name Typ Beschreibung
connectionStrings

DatabaseAccountConnectionString[]

Ein Array, das die Verbindungszeichenfolgen für das Cosmos DB-Konto enthält.

Kind

Art des Verbindungszeichenfolge Schlüssels

Name Typ Beschreibung
Primary

string

PrimaryReadonly

string

Secondary

string

SecondaryReadonly

string

Type

Typ der Verbindungszeichenfolge

Name Typ Beschreibung
Cassandra

string

CassandraConnectorMetadata

string

Gremlin

string

GremlinV2

string

MongoDB

string

Sql

string

SqlDedicatedGateway

string

Table

string

Undefined

string