Udostępnij za pośrednictwem


Database Accounts - List Connection Strings

Listy parametry połączenia dla określonego konta bazy danych usługi Azure Cosmos DB.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
accountName
path True

string

Nazwa konta bazy danych usługi Cosmos DB.

Wzorzec wyrażenia regularnego: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

DatabaseAccountListConnectionStringsResult

Operacja została ukończona pomyślnie.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation Personifikuj konto użytkownika

Przykłady

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

Przykładowe żądanie

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

Przykładowa odpowiedź

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

CosmosDBDatabaseAccountListConnectionStringsMongo

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
DatabaseAccountConnectionString

Parametry połączenia dla konta usługi Cosmos DB

DatabaseAccountListConnectionStringsResult

Parametry połączenia dla danego konta bazy danych.

Kind

Rodzaj klucza parametry połączenia

Type

Typ parametry połączenia

DatabaseAccountConnectionString

Parametry połączenia dla konta usługi Cosmos DB

Nazwa Typ Opis
connectionString

string

Wartość parametry połączenia

description

string

Opis parametry połączenia

keyKind

Kind

Rodzaj klucza parametry połączenia

type

Type

Typ parametry połączenia

DatabaseAccountListConnectionStringsResult

Parametry połączenia dla danego konta bazy danych.

Nazwa Typ Opis
connectionStrings

DatabaseAccountConnectionString[]

Tablica zawierająca parametry połączenia dla konta usługi Cosmos DB.

Kind

Rodzaj klucza parametry połączenia

Nazwa Typ Opis
Primary

string

PrimaryReadonly

string

Secondary

string

SecondaryReadonly

string

Type

Typ parametry połączenia

Nazwa Typ Opis
Cassandra

string

CassandraConnectorMetadata

string

Gremlin

string

GremlinV2

string

MongoDB

string

Sql

string

SqlDedicatedGateway

string

Table

string

Undefined

string