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 コンテナー エンドポイントのルーティングのマネージド ID プロパティ。
name	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
partitionKeyName	この Cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。
partitionKeyTemplate	この Cosmos DB SQL コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、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 コンテナー エンドポイントのルーティングのマネージド ID プロパティ。

identity?: ManagedIdentity

プロパティ値

ManagedIdentity

name

このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。

name: string

プロパティ値

string

partitionKeyName

この Cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。

partitionKeyName?: string

プロパティ値

string

partitionKeyTemplate

この Cosmos DB SQL コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、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