RoutingCosmosDBSqlApiProperties interface
與 cosmos DB sql 容器端點相關的屬性。
屬性
| authentication |
用來對 cosmos DB sql 容器端點進行驗證的方法 |
| container |
cosmos DB 資料庫中 cosmos DB sql 容器的名稱。 |
| database |
cosmos DB 帳戶中 cosmos DB 資料庫的名稱。 |
| endpoint |
cosmos DB 帳戶的 URL。 它必須包含通訊協定 HTTPs:// |
| id | cosmos DB sql 容器端點的識別碼注意：此屬性不會序列化。 它只能由伺服器填入。 |
| identity | 路由 cosmos DB 容器端點的受控識別屬性。 |
| name | 識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字號，且長度上限為 64 個字元。 下列名稱是保留的：events、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 |
| partition |
如果有的話，與這個 cosmos DB sql 容器相關聯的分割區索引鍵名稱。 這是選擇性參數。 |
| partition |
用來產生綜合分割區索引鍵值的範本，以便與這個 cosmos DB sql 容器搭配使用。 範本至少必須包含下列其中一個預留位置：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個預留位置最多可以指定一次，但順序和非預留位置元件都是任意的。 只有在指定 PartitionKeyName 時，才需要此參數。 |
| primary |
cosmos DB 帳戶的主鍵。 |
| resource |
cosmos DB 帳戶的資源群組名稱。 |
| secondary |
cosmos DB 帳戶的次要金鑰。 |
| subscription |
cosmos DB 帳戶的訂用帳戶識別碼。 |
屬性詳細資料
authenticationType
用來對 cosmos DB sql 容器端點進行驗證的方法
authenticationType?: string屬性值
string
containerName
cosmos DB 資料庫中 cosmos DB sql 容器的名稱。
containerName: string屬性值
string
databaseName
cosmos DB 帳戶中 cosmos DB 資料庫的名稱。
databaseName: string屬性值
string
endpointUri
cosmos DB 帳戶的 URL。 它必須包含通訊協定 HTTPs://
endpointUri: string屬性值
string
id
cosmos DB sql 容器端點的識別碼注意：此屬性不會序列化。 它只能由伺服器填入。
id?: string屬性值
string
identity
name
識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字號，且長度上限為 64 個字元。 下列名稱是保留的：events、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。
name: string屬性值
string
partitionKeyName
如果有的話，與這個 cosmos DB sql 容器相關聯的分割區索引鍵名稱。 這是選擇性參數。
partitionKeyName?: string屬性值
string
partitionKeyTemplate
用來產生綜合分割區索引鍵值的範本，以便與這個 cosmos DB sql 容器搭配使用。 範本至少必須包含下列其中一個預留位置：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個預留位置最多可以指定一次，但順序和非預留位置元件都是任意的。 只有在指定 PartitionKeyName 時，才需要此參數。
partitionKeyTemplate?: string屬性值
string
primaryKey
cosmos DB 帳戶的主鍵。
primaryKey?: string屬性值
string
resourceGroup
cosmos DB 帳戶的資源群組名稱。
resourceGroup?: string屬性值
string
secondaryKey
cosmos DB 帳戶的次要金鑰。
secondaryKey?: string屬性值
string
subscriptionId
cosmos DB 帳戶的訂用帳戶識別碼。
subscriptionId?: string屬性值
string