Microsoft.DocumentDB-databaseAccounts/apis/databases/containers 2016-03-31
Bicep-resourcedefinitie
Het resourcetype databaseAccounts/apis/databases/containers kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/apis/databases/containers wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31' = {
name: 'string'
parent: resourceSymbolicName
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'
]
}
]
}
}
}
}
Eigenschapswaarden
databaseAccounts/apis/databases/containers
Naam | Description | Waarde |
---|---|---|
naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep. |
tekenreeks (vereist) |
Bovenliggende | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie Onderliggende resource buiten bovenliggende resource voor meer informatie. |
Symbolische naam voor resource van het type: databases |
properties | Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (vereist) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProp...
Naam | Description | Waarde |
---|---|---|
opties | Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptions (vereist) |
resource | De standaard-JSON-indeling van een container | SqlContainerResource (vereist) |
CreateUpdateOptions
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | tekenreeks |
SqlContainerResource
Naam | Description | Waarde |
---|---|---|
conflictResolutionPolicy | Het conflictoplossingsbeleid voor de container. | ConflictResolutionPolicy |
defaultTtl | Standaard time to live | int |
id | Naam van de Cosmos DB SQL-container | tekenreeks (vereist) |
indexingPolicy | De configuratie van het indexeringsbeleid. Standaard wordt de indexering automatisch uitgevoerd voor alle documentpaden in de container | IndexingPolicy |
partitionKey | De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities | ContainerPartitionKey |
uniqueKeyPolicy | De configuratie van het unieke sleutelbeleid voor het opgeven van uniekheidsbeperkingen voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKeyPolicy |
ConflictResolutionPolicy
Naam | Description | Waarde |
---|---|---|
conflictResolutionPath | Het pad voor conflictoplossing in het geval van de modus LastWriterWins. | tekenreeks |
conflictResolutionProcedure | De procedure voor het oplossen van conflicten in het geval van een aangepaste modus. | tekenreeks |
mode | Geeft de conflictoplossingsmodus aan. | 'Aangepast' 'LastWriterWins' |
IndexingPolicy
Naam | Description | Waarde |
---|---|---|
automatisch | Geeft aan of het indexeringsbeleid automatisch is | booleaans |
excludedPaths | Lijst met paden die moeten worden uitgesloten van indexering | ExcludedPath[] |
includedPaths | Lijst met paden die moeten worden opgenomen in de indexering | IncludedPath[] |
indexingMode | Geeft de indexeringsmodus aan. | 'Consistent' 'Luie' 'Geen' |
ExcludedPath
Naam | Description | Waarde |
---|---|---|
leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
IncludedPath
Naam | Description | Waarde |
---|---|---|
Indexen | Lijst met indexen voor dit pad | Indexen[] |
leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
Indexen
Naam | Description | Waarde |
---|---|---|
dataType | Het gegevenstype waarop het indexeringsgedrag wordt toegepast. | 'LineString' 'MultiPolygon' 'Getal' 'Punt' 'Veelhoek' 'Tekenreeks' |
Soort | Geeft het type index aan. | Hash 'Bereik' 'Ruimtelijk' |
precisie | De precisie van de index. -1 is maximale precisie. | int |
ContainerPartitionKey
Naam | Description | Waarde |
---|---|---|
Soort | Geeft het type algoritme aan dat wordt gebruikt voor partitionering | Hash 'Bereik' |
Paden | Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd | tekenreeks[] |
UniqueKeyPolicy
Naam | Description | Waarde |
---|---|---|
uniqueKeys | Lijst met unieke sleutels op die de uniekheidsbeperking afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKey[] |
UniqueKey
Naam | Description | Waarde |
---|---|---|
Paden | De lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service | tekenreeks[] |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
Template | Beschrijving |
---|---|
Azure Cosmos maken met SQL API en meerdere containers |
Met de sjabloon maakt u een Cosmos-container met een SQL-API en kunt u meerdere containers toevoegen. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype databaseAccounts/apis/databases/containers kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/apis/databases/containers wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"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" ]
}
]
}
}
}
}
Eigenschapswaarden
databaseAccounts/apis/databases/containers
Naam | Description | Waarde |
---|---|---|
type | Het resourcetype | 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers' |
apiVersion | De resource-API-versie | '2016-03-31' |
naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) |
properties | Eigenschappen voor het maken en bijwerken van Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (vereist) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProp...
Naam | Description | Waarde |
---|---|---|
opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptions (vereist) |
resource | De standaard-JSON-indeling van een container | SqlContainerResource (vereist) |
CreateUpdateOptions
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | tekenreeks |
SqlContainerResource
Naam | Description | Waarde |
---|---|---|
conflictResolutionPolicy | Het conflictoplossingsbeleid voor de container. | ConflictResolutionPolicy |
defaultTtl | Standaard time to live | int |
id | Naam van de Cosmos DB SQL-container | tekenreeks (vereist) |
indexingPolicy | De configuratie van het indexeringsbeleid. Standaard wordt de indexering automatisch uitgevoerd voor alle documentpaden in de container | IndexingPolicy |
partitionKey | De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities | ContainerPartitionKey |
uniqueKeyPolicy | De configuratie van het unieke sleutelbeleid voor het opgeven van uniekheidsbeperkingen voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKeyPolicy |
ConflictResolutionPolicy
Naam | Description | Waarde |
---|---|---|
conflictResolutionPath | Het pad voor conflictoplossing in het geval van de modus LastWriterWins. | tekenreeks |
conflictResolutionProcedure | De procedure voor het oplossen van conflicten in het geval van een aangepaste modus. | tekenreeks |
mode | Geeft de conflictoplossingsmodus aan. | 'Aangepast' 'LastWriterWins' |
IndexingPolicy
Naam | Description | Waarde |
---|---|---|
automatisch | Geeft aan of het indexeringsbeleid automatisch is | booleaans |
excludedPaths | Lijst met paden die moeten worden uitgesloten van indexering | ExcludedPath[] |
includedPaths | Lijst met paden die moeten worden opgenomen in de indexering | IncludedPath[] |
indexingMode | Geeft de indexeringsmodus aan. | 'Consistent' 'Lui' 'Geen' |
ExcludedPath
Naam | Description | Waarde |
---|---|---|
leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) | tekenreeks |
IncludedPath
Naam | Description | Waarde |
---|---|---|
Indexen | Lijst met indexen voor dit pad | Indexen[] |
leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) | tekenreeks |
Indexen
Naam | Description | Waarde |
---|---|---|
dataType | Het gegevenstype waarop het indexeringsgedrag wordt toegepast. | 'LineString' 'MultiPolygon' 'Getal' Punt 'Veelhoek' 'Tekenreeks' |
Soort | Geeft het type index aan. | 'Hash' 'Bereik' 'Ruimtelijk' |
precisie | De precisie van de index. -1 is maximale precisie. | int |
ContainerPartitionKey
Naam | Description | Waarde |
---|---|---|
Soort | Geeft het type algoritme aan dat wordt gebruikt voor partitionering | 'Hash' 'Bereik' |
Paden | Lijst met paden met behulp van welke gegevens in de container kunnen worden gepartitioneerd | tekenreeks[] |
UniqueKeyPolicy
Naam | Description | Waarde |
---|---|---|
uniqueKeys | Lijst met unieke sleutels op waarmee u een uniekheidsbeperking afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKey[] |
UniqueKey
Naam | Description | Waarde |
---|---|---|
Paden | De lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service | tekenreeks[] |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
Template | Beschrijving |
---|---|
Azure Cosmos maken met SQL API en meerdere containers |
Met de sjabloon maakt u een Cosmos-container met een SQL-API en kunt u meerdere containers toevoegen. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype databaseAccounts/apis/databases/containers kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DocumentDB/databaseAccounts/apis/databases/containers wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"
name = "string"
parent_id = "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"
]
}
]
}
}
}
})
}
Eigenschapswaarden
databaseAccounts/apis/databases/containers
Naam | Description | Waarde |
---|---|---|
type | Het resourcetype | "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31" |
naam | De resourcenaam | tekenreeks (vereist) |
parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: databases |
properties | Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (vereist) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProp...
Naam | Description | Waarde |
---|---|---|
opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptions (vereist) |
resource | De standaard-JSON-indeling van een container | SqlContainerResource (vereist) |
CreateUpdateOptions
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | tekenreeks |
SqlContainerResource
Naam | Description | Waarde |
---|---|---|
conflictResolutionPolicy | Het conflictoplossingsbeleid voor de container. | ConflictResolutionPolicy |
defaultTtl | Standaard time to live | int |
id | Naam van de Cosmos DB SQL-container | tekenreeks (vereist) |
indexingPolicy | De configuratie van het indexeringsbeleid. Standaard wordt de indexering automatisch uitgevoerd voor alle documentpaden in de container | IndexingPolicy |
partitionKey | De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities | ContainerPartitionKey |
uniqueKeyPolicy | De configuratie van het unieke sleutelbeleid voor het opgeven van uniekheidsbeperkingen voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKeyPolicy |
ConflictResolutionPolicy
Naam | Description | Waarde |
---|---|---|
conflictResolutionPath | Het pad voor conflictoplossing in het geval van de modus LastWriterWins. | tekenreeks |
conflictResolutionProcedure | De procedure voor het oplossen van conflicten in het geval van een aangepaste modus. | tekenreeks |
mode | Geeft de conflictoplossingsmodus aan. | "Aangepast" "LastWriterWins" |
IndexingPolicy
Naam | Description | Waarde |
---|---|---|
automatisch | Geeft aan of het indexeringsbeleid automatisch is | booleaans |
excludedPaths | Lijst met paden die moeten worden uitgesloten van indexering | ExcludedPath[] |
includedPaths | Lijst met paden die moeten worden opgenomen in de indexering | IncludedPath[] |
indexingMode | Geeft de indexeringsmodus aan. | "Consistent" "Luie" "Geen" |
ExcludedPath
Naam | Description | Waarde |
---|---|---|
leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
IncludedPath
Naam | Description | Waarde |
---|---|---|
Indexen | Lijst met indexen voor dit pad | Indexen[] |
leertraject | Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met een jokerteken (/pad/*) | tekenreeks |
Indexen
Naam | Description | Waarde |
---|---|---|
dataType | Het gegevenstype waarop het indexeringsgedrag wordt toegepast. | "Lijntekenreeks" "MultiPolygon" "Getal" "Punt" "Veelhoek" "Tekenreeks" |
Soort | Geeft het type index aan. | "Hash" "Bereik" "Ruimtelijk" |
precisie | De precisie van de index. -1 is maximale precisie. | int |
ContainerPartitionKey
Naam | Description | Waarde |
---|---|---|
Soort | Geeft het type algoritme aan dat wordt gebruikt voor partitionering | "Hash" "Bereik" |
Paden | Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd | tekenreeks[] |
UniqueKeyPolicy
Naam | Description | Waarde |
---|---|---|
uniqueKeys | Lijst met unieke sleutels op die de uniekheidsbeperking afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service. | UniqueKey[] |
UniqueKey
Naam | Description | Waarde |
---|---|---|
Paden | De lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service | tekenreeks[] |