Compartilhar via


Database Accounts - List Connection Strings

Listas as cadeias de conexão para a conta de banco de dados do Azure Cosmos DB especificada.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
path True

string

Nome da conta de banco de dados do Cosmos DB.

Padrão Regex: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

DatabaseAccountListConnectionStringsResult

A operação foi concluída com sucesso.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation Representar sua conta de usuário

Exemplos

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

Solicitação de exemplo

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

Resposta de exemplo

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

CosmosDBDatabaseAccountListConnectionStringsMongo

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
DatabaseAccountConnectionString

Cadeia de conexão para a conta do Cosmos DB

DatabaseAccountListConnectionStringsResult

As cadeias de conexão para a conta de banco de dados fornecida.

Kind

Tipo de chave de cadeia de conexão

Type

Tipo do cadeia de conexão

DatabaseAccountConnectionString

Cadeia de conexão para a conta do Cosmos DB

Nome Tipo Description
connectionString

string

Valor do cadeia de conexão

description

string

Descrição do cadeia de conexão

keyKind

Kind

Tipo de chave de cadeia de conexão

type

Type

Tipo do cadeia de conexão

DatabaseAccountListConnectionStringsResult

As cadeias de conexão para a conta de banco de dados fornecida.

Nome Tipo Description
connectionStrings

DatabaseAccountConnectionString[]

Uma matriz que contém as cadeias de conexão para a conta do Cosmos DB.

Kind

Tipo de chave de cadeia de conexão

Nome Tipo Description
Primary

string

PrimaryReadonly

string

Secondary

string

SecondaryReadonly

string

Type

Tipo do cadeia de conexão

Nome Tipo Description
Cassandra

string

CassandraConnectorMetadata

string

Gremlin

string

GremlinV2

string

MongoDB

string

Sql

string

SqlDedicatedGateway

string

Table

string

Undefined

string