Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2016-03-31
- nejnovější
- 2016-03-31
-
2016-03-19 - 11. 11. 2015
- 04.04.2015
- 04.04.2015
Definice prostředku Bicep
Typ prostředku databaseAccounts/apis/databases/containers je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31' = {
parent: resourceSymbolicName
name: 'string'
properties: {
options: {
{customized property}: 'string'
}
resource: {
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Hodnoty vlastností
ConflictResolutionPolicy
Jméno | Popis | Hodnota |
---|---|---|
conflictResolutionPath | Cesta řešení konfliktů v případě režimu LastWriterWins. | řetězec |
conflictResolutionProcedure | Postup řešení konfliktů v případě vlastního režimu. | řetězec |
režim | Označuje režim řešení konfliktů. | Vlastní LastWriterWins |
ContainerPartitionKey
Jméno | Popis | Hodnota |
---|---|---|
laskavý | Označuje typ algoritmu používaného k dělení. | "Hash" "Rozsah" |
stezky | Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru | string[] |
CreateUpdateOptions
Jméno | Popis | Hodnota |
---|
ExcludedPath
Jméno | Popis | Hodnota |
---|---|---|
cesta | Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) | řetězec |
IncludedPath
Indexy
Jméno | Popis | Hodnota |
---|---|---|
Datatype | Datový typ, na který se používá chování indexování. | 'LineString' MultiPolygon 'Číslo' "Point" "Mnohoúhelník" Řetězec |
laskavý | Určuje typ indexu. | "Hash" "Rozsah" Prostorový |
přesnost | Přesnost indexu. -1 je maximální přesnost. | Int |
IndexingPolicy
Jméno | Popis | Hodnota |
---|---|---|
automatický | Označuje, jestli je zásada indexování automatická. | Bool |
excludedPaths | Seznam cest, které se mají vyloučit z indexování | ExcludedPath[] |
includedPaths | Seznam cest, které se mají zahrnout do indexování | IncludedPath[] |
indexingMode | Označuje režim indexování. | "Konzistentní" "Opožděný" None (Žádný) |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název prostředku | string (povinné) |
rodič | V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu: databaseAccounts/apis/databases |
vlastnosti | Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB | sqlContainerCreateUpdatePropertiesOrSqlContainerProperties (povinné) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Jméno | Popis | Hodnota |
---|---|---|
volby | Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. | CreateUpdateOptions (povinné) |
zdroj | Standardní formát JSON kontejneru | SqlContainerResource (povinné) |
SqlContainerResource
Jméno | Popis | Hodnota |
---|---|---|
conflictResolutionPolicy | Zásady řešení konfliktů pro kontejner. | ConflictResolutionPolicy |
defaultTtl | Výchozí čas k živému provozu | Int |
id | Název kontejneru SQL služby Cosmos DB | string (povinné) |
indexingPolicy | Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru. | IndexingPolicy |
partitionKey | Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů | ContainerPartitionKey |
uniqueKeyPolicy | Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. | UniqueKeyPolicy |
UniqueKey
Jméno | Popis | Hodnota |
---|---|---|
stezky | Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. | string[] |
UniqueKeyPolicy
Jméno | Popis | Hodnota |
---|---|---|
uniqueKeys | Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB | UniqueKey[] |
Definice prostředku šablony ARM
Typ prostředku databaseAccounts/apis/databases/containers je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, přidejte do šablony následující JSON.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
"apiVersion": "2016-03-31",
"name": "string",
"properties": {
"options": {
"{customized property}": "string"
},
"resource": {
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ]
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Hodnoty vlastností
ConflictResolutionPolicy
Jméno | Popis | Hodnota |
---|---|---|
conflictResolutionPath | Cesta řešení konfliktů v případě režimu LastWriterWins. | řetězec |
conflictResolutionProcedure | Postup řešení konfliktů v případě vlastního režimu. | řetězec |
režim | Označuje režim řešení konfliktů. | Vlastní LastWriterWins |
ContainerPartitionKey
Jméno | Popis | Hodnota |
---|---|---|
laskavý | Označuje typ algoritmu používaného k dělení. | "Hash" "Rozsah" |
stezky | Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru | string[] |
CreateUpdateOptions
Jméno | Popis | Hodnota |
---|
ExcludedPath
Jméno | Popis | Hodnota |
---|---|---|
cesta | Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) | řetězec |
IncludedPath
Indexy
Jméno | Popis | Hodnota |
---|---|---|
Datatype | Datový typ, na který se používá chování indexování. | 'LineString' MultiPolygon 'Číslo' "Point" "Mnohoúhelník" Řetězec |
laskavý | Určuje typ indexu. | "Hash" "Rozsah" Prostorový |
přesnost | Přesnost indexu. -1 je maximální přesnost. | Int |
IndexingPolicy
Jméno | Popis | Hodnota |
---|---|---|
automatický | Označuje, jestli je zásada indexování automatická. | Bool |
excludedPaths | Seznam cest, které se mají vyloučit z indexování | ExcludedPath[] |
includedPaths | Seznam cest, které se mají zahrnout do indexování | IncludedPath[] |
indexingMode | Označuje režim indexování. | "Konzistentní" "Opožděný" None (Žádný) |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Jméno | Popis | Hodnota |
---|---|---|
apiVersion | Verze rozhraní API | '2016-03-31' |
Jméno | Název prostředku | string (povinné) |
vlastnosti | Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB | sqlContainerCreateUpdatePropertiesOrSqlContainerProperties (povinné) |
typ | Typ prostředku | Microsoft.DocumentDB/databaseAccounts/apis/databases/containers |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Jméno | Popis | Hodnota |
---|---|---|
volby | Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. | CreateUpdateOptions (povinné) |
zdroj | Standardní formát JSON kontejneru | SqlContainerResource (povinné) |
SqlContainerResource
Jméno | Popis | Hodnota |
---|---|---|
conflictResolutionPolicy | Zásady řešení konfliktů pro kontejner. | ConflictResolutionPolicy |
defaultTtl | Výchozí čas k živému provozu | Int |
id | Název kontejneru SQL služby Cosmos DB | string (povinné) |
indexingPolicy | Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru. | IndexingPolicy |
partitionKey | Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů | ContainerPartitionKey |
uniqueKeyPolicy | Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. | UniqueKeyPolicy |
UniqueKey
Jméno | Popis | Hodnota |
---|---|---|
stezky | Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. | string[] |
UniqueKeyPolicy
Jméno | Popis | Hodnota |
---|---|---|
uniqueKeys | Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB | UniqueKey[] |
Příklady použití
Šablony azure pro rychlý start
Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.
Šablona | Popis |
---|---|
vytvoření služby Azure Cosmos s využitím rozhraní SQL API a několika kontejnerů nasazení |
Šablona vytvoří kontejner Cosmos s rozhraním SQL API a umožňuje přidávání mulitple kontejnerů. |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku databaseAccounts/apis/databases/containers je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"
name = "string"
body = jsonencode({
properties = {
options = {
{customized property} = "string"
}
resource = {
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Hodnoty vlastností
ConflictResolutionPolicy
Jméno | Popis | Hodnota |
---|---|---|
conflictResolutionPath | Cesta řešení konfliktů v případě režimu LastWriterWins. | řetězec |
conflictResolutionProcedure | Postup řešení konfliktů v případě vlastního režimu. | řetězec |
režim | Označuje režim řešení konfliktů. | Vlastní LastWriterWins |
ContainerPartitionKey
Jméno | Popis | Hodnota |
---|---|---|
laskavý | Označuje typ algoritmu používaného k dělení. | "Hash" "Rozsah" |
stezky | Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru | string[] |
CreateUpdateOptions
Jméno | Popis | Hodnota |
---|
ExcludedPath
Jméno | Popis | Hodnota |
---|---|---|
cesta | Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) | řetězec |
IncludedPath
Indexy
Jméno | Popis | Hodnota |
---|---|---|
Datatype | Datový typ, na který se používá chování indexování. | 'LineString' MultiPolygon 'Číslo' "Point" "Mnohoúhelník" Řetězec |
laskavý | Určuje typ indexu. | "Hash" "Rozsah" Prostorový |
přesnost | Přesnost indexu. -1 je maximální přesnost. | Int |
IndexingPolicy
Jméno | Popis | Hodnota |
---|---|---|
automatický | Označuje, jestli je zásada indexování automatická. | Bool |
excludedPaths | Seznam cest, které se mají vyloučit z indexování | ExcludedPath[] |
includedPaths | Seznam cest, které se mají zahrnout do indexování | IncludedPath[] |
indexingMode | Označuje režim indexování. | "Konzistentní" "Opožděný" None (Žádný) |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název prostředku | string (povinné) |
parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: databaseAccounts/apis/databases |
vlastnosti | Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB | sqlContainerCreateUpdatePropertiesOrSqlContainerProperties (povinné) |
typ | Typ prostředku | Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31" |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Jméno | Popis | Hodnota |
---|---|---|
volby | Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. | CreateUpdateOptions (povinné) |
zdroj | Standardní formát JSON kontejneru | SqlContainerResource (povinné) |
SqlContainerResource
Jméno | Popis | Hodnota |
---|---|---|
conflictResolutionPolicy | Zásady řešení konfliktů pro kontejner. | ConflictResolutionPolicy |
defaultTtl | Výchozí čas k živému provozu | Int |
id | Název kontejneru SQL služby Cosmos DB | string (povinné) |
indexingPolicy | Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru. | IndexingPolicy |
partitionKey | Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů | ContainerPartitionKey |
uniqueKeyPolicy | Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. | UniqueKeyPolicy |
UniqueKey
Jméno | Popis | Hodnota |
---|---|---|
stezky | Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. | string[] |
UniqueKeyPolicy
Jméno | Popis | Hodnota |
---|---|---|
uniqueKeys | Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB | UniqueKey[] |