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