Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2022-02-15-preview
- Senaste
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-resursdefinition
Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
clientEncryptionPolicy: {
includedPaths: [
{
clientEncryptionKeyId: 'string'
encryptionAlgorithm: 'string'
encryptionType: 'string'
path: 'string'
}
]
policyFormatVersion: int
}
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
compositeIndexes: [
{
order: 'string'
path: 'string'
}
]
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
spatialIndexes: [
{
path: 'string'
types: [
'string'
]
}
]
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Egenskapsvärden
databaseAccounts/sqlDatabases/containers
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
location | Platsen för den resursgrupp som resursen tillhör. | sträng |
tags | Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". | Ordlista med taggnamn och värden. Se Taggar i mallar |
parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: sqlDatabases |
identity | Identitet för resursen. | ManagedServiceIdentity |
properties | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (krävs) |
ManagedServiceIdentity
Name | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten. | "Ingen" "SystemTilldelade" "SystemAssigned,UserAssigned" "Användartilldelade" |
userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter |
ManagedServiceIdentityUserAssignedIdentiteter
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
Name | Beskrivning | Värde |
---|---|---|
alternativ | Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
resource | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResou... (krävs) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
Name | Beskrivning | Värde |
---|---|---|
autoscaleSettings | Anger inställningarna för autoskalning. | AutoscaleSettings |
dataflöde | Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000. | int |
AutoscaleSettings
Name | Beskrivning | Värde |
---|---|---|
maxThroughput | Representerar maximalt dataflöde, resursen kan skalas upp till. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
Name | Beskrivning | Värde |
---|---|---|
analyticalStorageTtl | TTL för analys. | int |
clientEncryptionPolicy | Klientkrypteringsprincipen för containern. | ClientEncryptionPolicy |
conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
defaultTtl | Standardtid till live | int |
id | Namnet på Cosmos DB SQL-containern | sträng (krävs) |
indexingPolicy | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | IndexingPolicy |
partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
ClientEncryptionPolicy
Name | Beskrivning | Värde |
---|---|---|
includedPaths | Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. | ClientEncryptionIncludedPath[] (krävs) |
policyFormatVersion | Version av principdefinitionen för klientkryptering. Observera att värdet som användaren skickade ignoreras. Standardprincipversionen är 1. | int |
ClientEncryptionIncludedPath
Name | Beskrivning | Värde |
---|---|---|
clientEncryptionKeyId | Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. | sträng (krävs) |
encryptionAlgorithm | Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. | sträng (krävs) |
encryptionType | Vilken typ av kryptering som ska utföras. T.ex. – deterministisk, randomiserad. | sträng (krävs) |
path | Sökväg som måste krypteras. | sträng (krävs) |
ConflictResolutionPolicy
Name | Beskrivning | Värde |
---|---|---|
conflictResolutionPath | Konfliktlösningssökvägen i fallet LastWriterWins-läge. | sträng |
conflictResolutionProcedure | Proceduren för att lösa konflikter i ett anpassat läge. | sträng |
mode | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
IndexingPolicy
Name | Beskrivning | Värde |
---|---|---|
automatiskt | Anger om indexeringsprincipen är automatisk | boolesk |
compositeIndexes | Lista över lista över sammansatta sökvägar | CompositePath[] |
excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] |
indexingMode | Anger indexeringsläget. | "konsekvent" "lat" "ingen" |
spatialIndexes | Lista över rumsliga detaljer | SpatialSpec[] |
CompositePath
Name | Beskrivning | Värde |
---|---|---|
ordningsföljd | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" |
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
ExcludedPath
Name | Beskrivning | Värde |
---|---|---|
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
IncludedPath
Name | Beskrivning | Värde |
---|---|---|
Index | Lista över index för den här sökvägen | Index[] |
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
Index
Name | Beskrivning | Värde |
---|---|---|
dataType | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
Typ | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
precision | Indexets precision. -1 är maximal precision. | int |
SpatialSpec
Name | Beskrivning | Värde |
---|---|---|
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" |
ContainerPartitionKey
Name | Beskrivning | Värde |
---|---|---|
Typ | Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" |
Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
version | Anger versionen av partitionsnyckeldefinitionen | int Begränsningar: Minsta värde = 1 Maxvärde = 2 |
UniqueKeyPolicy
Name | Beskrivning | Värde |
---|---|---|
uniqueKeys | Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
UniqueKey
Name | Beskrivning | Värde |
---|---|---|
Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | string[] |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå |
Den här mallen skapar ett Azure Cosmos DB-konto på kostnadsfri nivå för SQL API med en databas med delat dataflöde och container. |
Skapa ett Azure Cosmos DB-konto för Core -API (SQL) |
Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ. |
SQL API för Azure Cosmos DB-konto med analysarkiv |
Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container som konfigurerats med analysarkivet. |
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning |
Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde för automatisk skalning med flera andra alternativ. |
Skapa lagrade PROCEDUREr för Azure Cosmos DB Core (SQL)-API:et |
Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion. |
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning |
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. |
Resursdefinition för ARM-mall
Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2022-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"clientEncryptionPolicy": {
"includedPaths": [
{
"clientEncryptionKeyId": "string",
"encryptionAlgorithm": "string",
"encryptionType": "string",
"path": "string"
}
],
"policyFormatVersion": "int"
},
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"compositeIndexes": [
{
"order": "string",
"path": "string"
}
],
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string",
"spatialIndexes": [
{
"path": "string",
"types": [ "string" ]
}
]
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Egenskapsvärden
databaseAccounts/sqlDatabases/containers
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" |
apiVersion | Resurs-API-versionen | "2022-02-15-preview" |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
location | Platsen för den resursgrupp som resursen tillhör. | sträng |
tags | Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". | Ordlista med taggnamn och värden. Se Taggar i mallar |
identity | Identitet för resursen. | ManagedServiceIdentity |
properties | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (krävs) |
ManagedServiceIdentity
Name | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten. | "Ingen" "SystemTilldelade" "SystemAssigned,UserAssigned" "Användartilldelade" |
userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
Name | Beskrivning | Värde |
---|---|---|
alternativ | Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
resource | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResou... (krävs) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
Name | Beskrivning | Värde |
---|---|---|
autoscaleSettings | Anger inställningarna för autoskalning. | AutoscaleSettings |
dataflöde | Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000. | int |
AutoscaleSettings
Name | Beskrivning | Värde |
---|---|---|
maxThroughput | Representerar maximalt dataflöde, resursen kan skalas upp till. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
Name | Beskrivning | Värde |
---|---|---|
analyticalStorageTtl | TTL för analys. | int |
clientEncryptionPolicy | Klientkrypteringsprincipen för containern. | ClientEncryptionPolicy |
conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
defaultTtl | Standardtid till live | int |
id | Namnet på Cosmos DB SQL-containern | sträng (krävs) |
indexingPolicy | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | IndexingPolicy |
partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
ClientEncryptionPolicy
Name | Beskrivning | Värde |
---|---|---|
includedPaths | Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. | ClientEncryptionIncludedPath[] (krävs) |
policyFormatVersion | Version av principdefinitionen för klientkryptering. Observera att värdet som användaren skickade ignoreras. Standardprincipversionen är 1. | int |
ClientEncryptionIncludedPath
Name | Beskrivning | Värde |
---|---|---|
clientEncryptionKeyId | Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. | sträng (krävs) |
encryptionAlgorithm | Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. | sträng (krävs) |
encryptionType | Vilken typ av kryptering som ska utföras. T.ex. – deterministisk, randomiserad. | sträng (krävs) |
path | Sökväg som måste krypteras. | sträng (krävs) |
ConflictResolutionPolicy
Name | Beskrivning | Värde |
---|---|---|
conflictResolutionPath | Konfliktlösningssökvägen i fallet LastWriterWins-läge. | sträng |
conflictResolutionProcedure | Proceduren för att lösa konflikter i ett anpassat läge. | sträng |
mode | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
IndexingPolicy
Name | Beskrivning | Värde |
---|---|---|
automatiskt | Anger om indexeringsprincipen är automatisk | boolesk |
compositeIndexes | Lista över sammansatt sökvägslista | CompositePath[] |
excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
includedPaths | Lista över sökvägar som ska ingå i indexeringen | IncludedPath[] |
indexingMode | Anger indexeringsläget. | "konsekvent" "lat" "ingen" |
spatialIndexes | Lista över rumsliga detaljer | SpatialSpec[] |
CompositePath
Name | Beskrivning | Värde |
---|---|---|
ordningsföljd | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" |
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*) | sträng |
ExcludedPath
Name | Beskrivning | Värde |
---|---|---|
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*) | sträng |
IncludedPath
Name | Beskrivning | Värde |
---|---|---|
Index | Lista över index för den här sökvägen | Index[] |
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*) | sträng |
Index
Name | Beskrivning | Värde |
---|---|---|
dataType | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
Typ | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
precision | Precisionen för indexet. -1 är maximal precision. | int |
SpatialSpec
Name | Beskrivning | Värde |
---|---|---|
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*) | sträng |
typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" |
ContainerPartitionKey
Name | Beskrivning | Värde |
---|---|---|
Typ | Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" |
Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
version | Anger versionen av partitionsnyckeldefinitionen | int Begränsningar: Minsta värde = 1 Maxvärde = 2 |
UniqueKeyPolicy
Name | Beskrivning | Värde |
---|---|---|
uniqueKeys | Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
UniqueKey
Name | Beskrivning | Värde |
---|---|---|
Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | string[] |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå |
Den här mallen skapar ett Azure Cosmos DB-konto på kostnadsfri nivå för SQL API med en databas med delat dataflöde och en container. |
Skapa ett Azure Cosmos DB-konto för Core (SQL) API |
Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med dataflöde med flera andra alternativ. |
SQL-API för Azure Cosmos DB-konto med analysarkiv |
Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkiv. |
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning |
Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med dataflöde för automatisk skalning med flera andra alternativ. |
Skapa lagrade PROCEDUREr för Azure Cosmos DB Core (SQL) API |
Den här mallen skapar ett Azure Cosmos DB-konto för Core (SQL) API och en container med en lagrad procedur, utlösare och användardefinierad funktion. |
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning |
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
clientEncryptionPolicy = {
includedPaths = [
{
clientEncryptionKeyId = "string"
encryptionAlgorithm = "string"
encryptionType = "string"
path = "string"
}
]
policyFormatVersion = int
}
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
compositeIndexes = [
{
order = "string"
path = "string"
}
]
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
spatialIndexes = [
{
path = "string"
types = [
"string"
]
}
]
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Egenskapsvärden
databaseAccounts/sqlDatabases/containers
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-02-15-preview" |
name | Resursnamnet | sträng (krävs) |
location | Platsen för resursgruppen som resursen tillhör. | sträng |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: sqlDatabases |
tags | Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". | Ordlista med taggnamn och värden. |
identity | Identitet för resursen. | ManagedServiceIdentity |
properties | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (krävs) |
ManagedServiceIdentity
Name | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten. | "SystemTilldelade" "SystemAssigned,UserAssigned" "Användartilldelade" |
identity_ids | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | Matris med användaridentitets-ID:t. |
ManagedServiceIdentityUserAssignedIdentiteter
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
Name | Beskrivning | Värde |
---|---|---|
alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
resource | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResou... (krävs) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
Name | Beskrivning | Värde |
---|---|---|
autoscaleSettings | Anger inställningarna för autoskalning. | AutoskalningInställningar |
dataflöde | Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000. | int |
AutoskalningInställningar
Name | Beskrivning | Värde |
---|---|---|
maxThroughput | Representerar maximalt dataflöde, resursen kan skalas upp till. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
Name | Beskrivning | Värde |
---|---|---|
analyticalStorageTtl | TTL för analys. | int |
clientEncryptionPolicy | Klientkrypteringsprincipen för containern. | ClientEncryptionPolicy |
conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
defaultTtl | Standardtid att leva | int |
id | Namnet på Cosmos DB SQL-containern | sträng (krävs) |
indexingPolicy | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | IndexingPolicy |
partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
ClientEncryptionPolicy
Name | Beskrivning | Värde |
---|---|---|
includedPaths | Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. | ClientEncryptionIncludedPath[] (krävs) |
policyFormatVersion | Version av definitionen av klientkrypteringsprincipen. Observera att det användarförda värdet ignoreras. Standardprincipversionen är 1. | int |
ClientEncryptionIncludedPath
Name | Beskrivning | Värde |
---|---|---|
clientEncryptionKeyId | Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. | sträng (krävs) |
encryptionAlgorithm | Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. | sträng (krävs) |
encryptionType | Vilken typ av kryptering som ska utföras. T.ex. deterministisk, randomiserad. | sträng (krävs) |
path | Sökväg som måste krypteras. | sträng (krävs) |
ConflictResolutionPolicy
Name | Beskrivning | Värde |
---|---|---|
conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng |
conflictResolutionProcedure | Proceduren för att lösa konflikter i ett anpassat läge. | sträng |
mode | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
IndexingPolicy
Name | Beskrivning | Värde |
---|---|---|
automatiskt | Anger om indexeringsprincipen är automatisk | boolesk |
compositeIndexes | Lista över lista över sammansatta sökvägar | CompositePath[] |
excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] |
indexingMode | Anger indexeringsläget. | "konsekvent" "lat" "ingen" |
spatialIndexes | Lista över rumsliga detaljer | SpatialSpec[] |
CompositePath
Name | Beskrivning | Värde |
---|---|---|
ordningsföljd | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" |
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
ExcludedPath
Name | Beskrivning | Värde |
---|---|---|
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
IncludedPath
Name | Beskrivning | Värde |
---|---|---|
Index | Lista över index för den här sökvägen | Index[] |
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
Index
Name | Beskrivning | Värde |
---|---|---|
dataType | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
Typ | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
precision | Indexets precision. -1 är maximal precision. | int |
SpatialSpec
Name | Beskrivning | Värde |
---|---|---|
path | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" |
ContainerPartitionKey
Name | Beskrivning | Värde |
---|---|---|
Typ | Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" |
Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
version | Anger versionen av partitionsnyckeldefinitionen | int Begränsningar: Minsta värde = 1 Maxvärde = 2 |
UniqueKeyPolicy
Name | Beskrivning | Värde |
---|---|---|
uniqueKeys | Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
UniqueKey
Name | Beskrivning | Värde |
---|---|---|
Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | string[] |