共用方式為


Database Accounts - List Connection Strings

清單 指定之 Azure Cosmos DB 資料庫帳戶的連接字串。

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

URI 參數

名稱 位於 必要 類型 Description
accountName
path True

string

Cosmos DB 資料庫帳戶名稱。

Regex 模式: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

DatabaseAccountListConnectionStringsResult

作業已成功完成。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

CosmosDBDatabaseAccountListConnectionStrings
CosmosDBDatabaseAccountListConnectionStringsMongo

CosmosDBDatabaseAccountListConnectionStrings

範例要求

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

範例回覆

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

CosmosDBDatabaseAccountListConnectionStringsMongo

範例要求

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

範例回覆

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

定義

名稱 Description
DatabaseAccountConnectionString

Cosmos DB 帳戶的連接字串

DatabaseAccountListConnectionStringsResult

指定資料庫帳戶的連接字串。

Kind

連接字串機碼的種類

Type

連接字串的類型

DatabaseAccountConnectionString

Cosmos DB 帳戶的連接字串

名稱 類型 Description
connectionString

string

連接字串的值

description

string

連接字串 的描述

keyKind

Kind

連接字串機碼的種類

type

Type

連接字串的類型

DatabaseAccountListConnectionStringsResult

指定資料庫帳戶的連接字串。

名稱 類型 Description
connectionStrings

DatabaseAccountConnectionString[]

數位,包含 Cosmos DB 帳戶的連接字串。

Kind

連接字串機碼的種類

名稱 類型 Description
Primary

string

PrimaryReadonly

string

Secondary

string

SecondaryReadonly

string

Type

連接字串的類型

名稱 類型 Description
Cassandra

string

CassandraConnectorMetadata

string

Gremlin

string

GremlinV2

string

MongoDB

string

Sql

string

SqlDedicatedGateway

string

Table

string

Undefined

string