Condividi tramite


Database Accounts - List Connection Strings

Elenchi le stringhe di connessione per l'account di database Azure Cosmos DB specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
accountName
path True

string

Nome dell'account del database Cosmos DB.

Criterio di espressione regolare: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

DatabaseAccountListConnectionStringsResult

Operazione riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation Rappresentare l'account utente

Esempio

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

Esempio di richiesta

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

Risposta di esempio

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

CosmosDBDatabaseAccountListConnectionStringsMongo

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
DatabaseAccountConnectionString

Stringa di connessione per l'account Cosmos DB

DatabaseAccountListConnectionStringsResult

Stringhe di connessione per l'account del database specificato.

Kind

Tipo di chiave stringa di connessione

Type

Tipo del stringa di connessione

DatabaseAccountConnectionString

Stringa di connessione per l'account Cosmos DB

Nome Tipo Descrizione
connectionString

string

Valore dell'stringa di connessione

description

string

Descrizione dell'stringa di connessione

keyKind

Kind

Tipo di chiave stringa di connessione

type

Type

Tipo del stringa di connessione

DatabaseAccountListConnectionStringsResult

Stringhe di connessione per l'account del database specificato.

Nome Tipo Descrizione
connectionStrings

DatabaseAccountConnectionString[]

Matrice che contiene le stringhe di connessione per l'account Cosmos DB.

Kind

Tipo di chiave stringa di connessione

Nome Tipo Descrizione
Primary

string

PrimaryReadonly

string

Secondary

string

SecondaryReadonly

string

Type

Tipo del stringa di connessione

Nome Tipo Descrizione
Cassandra

string

CassandraConnectorMetadata

string

Gremlin

string

GremlinV2

string

MongoDB

string

Sql

string

SqlDedicatedGateway

string

Table

string

Undefined

string