通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

RoutingCosmosDBSqlApiProperties interface

  • 参考
包:
@azure/arm-iothub

与 cosmos DB sql 容器终结点相关的属性。

属性

authenticationType

用于对 cosmos DB sql 容器终结点进行身份验证的方法
containerName

cosmos DB 数据库中 cosmos DB sql 容器的名称。
databaseName

cosmos DB 帐户中 cosmos DB 数据库的名称。
endpointUri

cosmos DB 帐户的 URL。 它必须包含协议 https://
id

cosmos DB sql 容器终结点的 ID 注意：此属性不会被序列化。 它只能由服务器填充。
identity

路由 cosmos DB 容器终结点的托管标识属性。
name

标识此终结点的名称。 名称只能包含字母数字字符、句点、下划线、连字符，最大长度为 64 个字符。 保留以下名称：events、fileNotifications $default。 终结点名称在终结点类型中必须是唯一的。
partitionKeyName

与此 cosmos DB sql 容器关联的分区键的名称（如果存在）。 这是一个可选参数。
partitionKeyTemplate

用于生成用于此 cosmos DB sql 容器的合成分区键值的模板。 模板必须至少包含以下占位符之一：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一个占位符最多可以指定一次，但顺序和非占位符组件是任意的。 仅当指定 PartitionKeyName 时，才需要此参数。
primaryKey

cosmos DB 帐户的主键。
resourceGroup

cosmos DB 帐户的资源组的名称。
secondaryKey

cosmos DB 帐户的辅助密钥。
subscriptionId

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 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

identity

路由 cosmos DB 容器终结点的托管标识属性。

identity?: ManagedIdentity

属性值

ManagedIdentity

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