Microsoft.DocumentDB databaseAccounts 2022-08-15
- 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
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Bicep-resursdefinition
Resurstypen databaseAccounts 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-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2022-08-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
analyticalStorageConfiguration: {
schemaType: 'string'
}
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
migrationState: {
startTime: 'string'
status: 'string'
targetType: 'string'
}
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
capacity: {
totalThroughputLimit: int
}
connectorOffer: 'Small'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
enablePartitionMerge: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
restoreMode: 'PointInTime'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
}
BackupPolicy-objekt
Ange typegenskapen för att ange typ av objekt.
För Kontinuerlig använder du:
type: 'Continuous'
Använd för periodisk användning:
type: 'Periodic'
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
Egenskapsvärden
databaseAccounts
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet | sträng (krävs) Teckengräns: 3–44 Giltiga tecken: Gemener, siffror och bindestreck. Börja med en gemen bokstav eller siffra. Resursnamnet måste vara unikt i Hela Azure. |
| 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 |
| Typ | Anger typen av databaskonto. Detta kan bara anges när databaskontot skapas. | "GlobalDocumentDB" "MongoDB" "Parsa" |
| identity | Identitet för resursen. | ManagedServiceIdentity |
| properties | Egenskaper för att skapa och uppdatera Azure Cosmos DB-databaskonton. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (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" "SystemAssigned" "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.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | Beskrivning | Värde |
|---|---|---|
| analyticalStorageConfiguration | Analyslagringsspecifika egenskaper. | AnalyticalStorageConfiguration |
| apiProperties | API-specifika egenskaper. Stöds för närvarande endast för MongoDB API. | ApiProperties |
| backupPolicy | Objektet som representerar principen för säkerhetskopiering av ett konto. | BackupPolicy |
| funktioner | Lista över Cosmos DB-funktioner för kontot | Kapacitet[] |
| capacity | Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto. | Kapacitet |
| connectorOffer | Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB-databasens C*-konto. | "Liten" |
| consistencyPolicy | Konsekvensprincipen för Cosmos DB-kontot. | ConsistencyPolicy |
| cors | CORS-principen för Cosmos DB-databaskontot. | CorsPolicy[] |
| createMode | Uppräkning för att ange läget för kontoskapande. | "Standard" "Återställ" |
| databaseAccountOfferType | Erbjudandetypen för databasen | "Standard" (obligatoriskt) |
| defaultIdentity | Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste anges explicit av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. | sträng |
| disableKeyBasedMetadataWriteAccess | Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar | boolesk |
| disableLocalAuth | Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. | boolesk |
| enableAnalyticalStorage | Flagga för att ange om lagringsanalys ska aktiveras. | boolesk |
| enableAutomaticFailover | Aktiverar automatisk redundans för skrivregionen i den sällsynta händelse att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. | boolesk |
| enableCassandraConnector | Aktiverar Cassandra-anslutningsappen på Cosmos DB C*-kontot | boolesk |
| enableFreeTier | Flagga för att ange om den kostnadsfria nivån är aktiverad. | boolesk |
| enableMultipleWriteLocations | Gör att kontot kan skriva på flera platser | boolesk |
| enablePartitionMerge | Flagga som anger aktivering/inaktivering av funktionen För partitionssammanslagning för kontot | boolesk |
| ipRules | Lista över IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flagga för att ange om ACL-regler för virtuellt nätverk ska aktiveras/inaktiveras. | boolesk |
| keyVaultKeyUri | URI för nyckelvalvet | sträng |
| platser | En matris som innehåller de georeplication-platser som är aktiverade för Cosmos DB-kontot. | Plats[] (obligatoriskt) |
| networkAclBypass | Anger vilka tjänster som tillåts att kringgå brandväggskontroller. | "AzureServices" "Ingen" |
| networkAclBypassResourceIds | En matris som innehåller resurs-ID:n för Förbikoppling av nätverks-Acl för Cosmos DB-kontot. | string[] |
| publicNetworkAccess | Om begäranden från offentligt nätverk tillåts | "Inaktiverad" "Aktiverad" |
| restoreParameters | Parametrar som anger information om återställningen. | RestoreParameters |
| virtualNetworkRules | Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Name | Beskrivning | Värde |
|---|---|---|
| schemaType | Beskriver typerna av scheman för analyslagring. | "FullFidelity" "WellDefined" |
ApiProperties
| Name | Beskrivning | Värde |
|---|---|---|
| serverVersion | Beskriver ServerVersion för ett MongoDB-konto. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| migrationState | Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. | BackupPolicyMigrationState |
| typ | Ange objekttyp | Kontinuerligt Periodisk (krävs) |
BackupPolicyMigrationState
| Name | Beskrivning | Värde |
|---|---|---|
| startTime | Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). | sträng |
| status | Beskriver status för migrering mellan typer av säkerhetskopieringsprinciper. | "Slutfört" "Misslyckades" "InProgress" "Ogiltigt" |
| targetType | Beskriver principtypen för målsäkerhetskopiering för migreringen av säkerhetskopieringsprincipen. | "Kontinuerlig" "Periodisk" |
ContinuousModeBackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Beskriver läget för säkerhetskopior. | "Kontinuerlig" (krävs) |
PeriodicModeBackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Beskriver läget för säkerhetskopior. | "Periodisk" (krävs) |
| periodicModeEgenskaper | Konfigurationsvärden för säkerhetskopiering i periodiskt läge | PeriodicModeEgenskaper |
PeriodicModeEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| backupIntervalInMinutes | Ett heltal som representerar intervallet i minuter mellan två säkerhetskopior | int Begränsningar: Minsta värde = 0 |
| backupRetentionIntervalInHours | Ett heltal som representerar den tid (i timmar) som varje säkerhetskopia behålls | int Begränsningar: Minsta värde = 0 |
| backupStorageRedundancy | Räkna upp för att ange typ av säkerhetskopieringshemvist | "Geo" "Lokal" "Zon" |
Funktion
| Name | Beskrivning | Värde |
|---|---|---|
| name | Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". | sträng |
Kapacitet
| Name | Beskrivning | Värde |
|---|---|---|
| totalThroughputLimit | Den totala dataflödesgränsen som har införts för kontot. En totalThroughputLimit på 2000 inför en strikt gräns för maximalt dataflöde som kan etableras för det kontot till 2000. Ett totalThroughputLimit på -1 anger inga gränser för etablering av dataflöde. | int |
ConsistencyPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| defaultConsistencyLevel | Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot. | "BoundedStaleness" "ConsistentPrefix" "Slutlig" "Session" "Stark" (krävs) |
| maxIntervalInSeconds | När det används med konsekvensnivån Begränsad föråldring representerar det här värdet den tidsmängd av föråldring (i sekunder) som tolereras. Godkänt intervall för det här värdet är 5–86400. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". | int Begränsningar: Minsta värde = 5 Maxvärde = 86400 |
| maxStalenessPrefix | När det används med konsekvensnivån Begränsad föråldring representerar det här värdet antalet inaktuella begäranden som tolereras. Godkänt intervall för det här värdet är 1 – 2 147 483 647. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". | int Begränsningar: Minsta värde = 1 Maxvärde = 2147483647 |
CorsPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| allowedHeaders | De begärandehuvuden som ursprungsdomänen kan ange i CORS-begäran. | sträng |
| allowedMethods | De metoder (HTTP-begärandeverb) som ursprungsdomänen kan använda för en CORS-begäran. | sträng |
| allowedOrigins | De ursprungsdomäner som tillåts göra en begäran mot tjänsten via CORS. | sträng (krävs) |
| exposedHeaders | Svarshuvudena som kan skickas i svaret på CORS-begäran och exponeras av webbläsaren för frågeutfärdaren. | sträng |
| maxAgeInSeconds | Den maximala tid som en webbläsare ska cachelagera begäran för förhandsversionen av ALTERNATIV. | int Begränsningar: Minsta värde = 1 Maxvärde = 2147483647 |
IpAddressOrRange
| Name | Beskrivning | Värde |
|---|---|---|
| ipAddressOrRange | En enda IPv4-adress eller ett enda IPv4-adressintervall i CIDR-format. Angivna IP-adresser måste vara välformaterade och kan inte finnas i något av följande intervall: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, eftersom dessa inte kan tillämpas av IP-adressfiltret. Exempel på giltiga indata: "23.40.210.245" eller "23.40.210.0/8". | sträng |
Position
| Namn | Beskrivning | Värde |
|---|---|---|
| failoverPriority | Redundansprioriteten för regionen. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner – 1). Redundansprioritetsvärden måste vara unika för var och en av de regioner där databaskontot finns. | int Begränsningar: Minsta värde = 0 |
| isZoneRedundant | Flagga för att ange om den här regionen är en AvailabilityZone-region eller inte | boolesk |
| locationName | Namnet på regionen. | sträng |
RestoreParameters
| Name | Beskrivning | Värde |
|---|---|---|
| databasesToRestore | Lista över specifika databaser som är tillgängliga för återställning. | DatabaseRestoreResource[] |
| restoreMode | Beskriver återställningsläget. | "PointInTime" |
| restoreSource | ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | sträng |
| restoreTimestampInUtc | Tid till vilken kontot måste återställas (ISO-8601-format). | sträng |
DatabaseRestoreResource
| Name | Beskrivning | Värde |
|---|---|---|
| collectionNames | Namnen på samlingarna som är tillgängliga för återställning. | string[] |
| databaseName | Namnet på databasen som är tillgänglig för återställning. | sträng |
VirtualNetworkRule
| Name | Beskrivning | Värde |
|---|---|---|
| id | Resurs-ID för ett undernät, till exempel: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | sträng |
| ignoreMissingVNetServiceEndpoint | Skapa brandväggsregel innan VNet-tjänstslutpunkten är aktiverad för det virtuella nätverket. | boolesk |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Description |
|---|---|
CI/CD med Jenkins i Azure Container Service (AKS) |
Containrar gör det mycket enkelt för dig att kontinuerligt skapa och distribuera dina program. Genom att dirigera distributionen av dessa containrar med Kubernetes i Azure Container Service kan du uppnå replikerbara, hanterbara kluster med containrar. Genom att konfigurera en kontinuerlig version för att skapa dina containeravbildningar och orkestrering kan du öka distributionens hastighet och tillförlitlighet. |
| Webbapp med en SQL Database, Azure Cosmos DB, Azure Search |
Den här mallen etablerar en webbapp, en SQL Database, Azure Cosmos DB, Azure Search och Application Insights. |
| Skapa ett Azure Cosmos DB-konto för Cassandra-API:et |
Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra-API:et i två regioner med ett nyckelutrymme och en tabell med dedikerat dataflöde. |
| Skapa ett Azure Cosmos DB-konto för automatisk skalning för Cassandra-API:et |
Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra-API:et i två regioner med ett nyckelutrymme och en tabell med dataflöde för automatisk skalning. |
| Skapa ett Azure CosmosDB-konto |
Den här ARM-mallen har för avsikt att snabbt skapa ett CosmosDB-konto med de minsta nödvändiga värdena |
| Skapa ett Azure Cosmos DB-konto i flera regioner |
Den här mallen skapar ett Azure Cosmos DB-konto för alla typer av databas-API:er med en primär och sekundär region med val av konsekvensnivå och redundanstyp. |
| 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 Gremlin API |
Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med dedikerat dataflöde. |
| Skapa ett Azure Cosmos DB-konto för autoskalning av Gremlin API |
Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med dataflöde för autoskalning. |
| Skapa ett Azure Cosmos-konto för MongoDB API |
Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med delat och dedikerat dataflöde med två samlingar. |
| Skapa ett Azure Cosmos-konto för autoskalning av MongoDB API |
Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med både delat och dedikerat dataflöde för autoskalning. |
| Skapa ett Azure Cosmos DB-konto med en privat slutpunkt |
Den här mallen skapar ett Cosmos-konto, ett virtuellt nätverk och en privat slutpunkt som exponerar Cosmos-kontot för det virtuella nätverket. |
| 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. |
| Skapa ett minimalt Azure Cosmos DB-konto för Core (SQL) API |
Den här mallen skapar ett Azure Cosmos DB-konto för Core-API:et (SQL) samtidigt som du bara anger de minsta nödvändiga resursegenskaperna. |
| Skapa Azure Cosmos med SQL API och flera containrar |
Mallen skapar en Cosmos-container med ett SQL-API och gör det möjligt att lägga till flera containrar. |
| Skapa ett Azure Cosmos DB SQL-konto med dataplanets RBAC |
Den här mallen skapar ett SQL Cosmos-konto, en internt underhållen rolldefinition och en internt underhållen rolltilldelning för en AAD-identitet. |
| Skapa ett serverlöst Azure Cosmos DB-konto för SQL API |
Den här mallen skapar ett serverlöst Azure Cosmos DB-konto för Core-API:et (SQL). |
| Skapa ett Azure Cosmos-konto för Tabell-API |
Den här mallen skapar ett Azure Cosmos DB-konto för Tabell-API i två regioner och en enda tabell med etablerat dataflöde. |
| Skapa ett Azure Cosmos-konto för Tabell-API med autoskalning |
Den här mallen skapar ett Azure Cosmos DB-konto för Tabell-API i två regioner och en enda tabell med dataflöde för automatisk skalning. |
| Skapa ett Azure Cosmos-konto med nolltouch och Azure Web App |
Den här mallen skapar ett Azure Cosmos-konto, matar in Cosmos DB-slutpunkten och nycklarna i inställningarna för Azure Web App och distribuerar sedan en ASP MVC-webbapp från GitHub. |
| Skapa ett Cosmos DB-konto med Microsoft Defender aktiverat |
Med den här ARM-mallen kan du distribuera ett Azure Cosmos DB-konto med Microsoft Defender för Azure Cosmos DB aktiverat. Microsoft Defender för Azure Cosmos DB är ett Azure-internt säkerhetslager som identifierar försök att utnyttja databaser i dina Azure Cosmos DB-konton. Microsoft Defender för Azure Cosmos DB identifierar potentiella SQL-inmatningar, kända dåliga aktörer baserat på Microsoft Threat Intelligence, misstänkta åtkomstmönster och potentiella utnyttjanden av databasen via komprometterade identiteter eller skadliga insiders. |
| Distribuera Azure Data Explorer DB med Cosmos DB-anslutning |
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. |
| Azure Cosmos DB-konto med webbapp |
Den här mallen distribuerar ett Azure Cosmos DB-konto, en App Service-plan, och skapar en webbapp i App Service-planen. Dessutom läggs två programinställningar till i webbappen som refererar till Azure Cosmos DB-kontots slutpunkt. På så sätt kan lösningar som distribueras till webbappen ansluta till Azure Cosmos DB-kontots slutpunkt med hjälp av dessa inställningar. |
Resursdefinition för ARM-mall
Resurstypen databaseAccounts kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2022-08-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"analyticalStorageConfiguration": {
"schemaType": "string"
},
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"migrationState": {
"startTime": "string",
"status": "string",
"targetType": "string"
},
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"capacity": {
"totalThroughputLimit": "int"
},
"connectorOffer": "Small",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"enablePartitionMerge": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"restoreMode": "PointInTime",
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
}
}
BackupPolicy-objekt
Ange typegenskapen för att ange typ av objekt.
För Kontinuerlig använder du:
"type": "Continuous"
För Periodisk använder du:
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
}
Egenskapsvärden
databaseAccounts
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts" |
| apiVersion | Resurs-API-versionen | '2022-08-15' |
| name | Resursnamnet | sträng (krävs) Teckengräns: 3–44 Giltiga tecken: Gemener, siffror och bindestreck. Börja med en gemen bokstav eller siffra. Resursnamnet måste vara unikt i Hela Azure. |
| location | Platsen för resursgruppen 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 |
| Typ | Anger typen av databaskonto. Detta kan bara anges när databaskontot skapas. | "GlobalDocumentDB" "MongoDB" "Parsa" |
| identity | Identitet för resursen. | ManagedServiceIdentity |
| properties | Egenskaper för att skapa och uppdatera Azure Cosmos DB-databaskonton. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (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 alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "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.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | Beskrivning | Värde |
|---|---|---|
| analyticalStorageConfiguration | Analyslagringsspecifika egenskaper. | AnalyticalStorageConfiguration |
| apiProperties | API-specifika egenskaper. Stöds för närvarande endast för MongoDB API. | ApiProperties |
| backupPolicy | Objektet som representerar principen för säkerhetskopiering av ett konto. | BackupPolicy |
| funktioner | Lista över Cosmos DB-funktioner för kontot | Kapacitet[] |
| capacity | Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto. | Kapacitet |
| connectorOffer | Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB-databasens C*-konto. | "Liten" |
| consistencyPolicy | Konsekvensprincipen för Cosmos DB-kontot. | ConsistencyPolicy |
| cors | CORS-principen för Cosmos DB-databaskontot. | CorsPolicy[] |
| createMode | Uppräkning för att ange läget för kontoskapande. | "Standard" "Återställ" |
| databaseAccountOfferType | Erbjudandetypen för databasen | "Standard" (obligatoriskt) |
| defaultIdentity | Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste anges explicit av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. | sträng |
| disableKeyBasedMetadataWriteAccess | Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar | boolesk |
| disableLocalAuth | Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. | boolesk |
| enableAnalyticalStorage | Flagga för att ange om lagringsanalys ska aktiveras. | boolesk |
| enableAutomaticFailover | Aktiverar automatisk redundans för skrivregionen i den sällsynta händelse att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. | boolesk |
| enableCassandraConnector | Aktiverar Cassandra-anslutningsappen på Cosmos DB C*-kontot | boolesk |
| enableFreeTier | Flagga för att ange om den kostnadsfria nivån är aktiverad. | boolesk |
| enableMultipleWriteLocations | Gör att kontot kan skriva på flera platser | boolesk |
| enablePartitionMerge | Flagga som anger aktivering/inaktivering av funktionen För partitionssammanslagning för kontot | boolesk |
| ipRules | Lista över IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flagga för att ange om ACL-regler för virtuellt nätverk ska aktiveras/inaktiveras. | boolesk |
| keyVaultKeyUri | URI för nyckelvalvet | sträng |
| platser | En matris som innehåller de georeplication-platser som är aktiverade för Cosmos DB-kontot. | Plats[] (obligatoriskt) |
| networkAclBypass | Anger vilka tjänster som tillåts att kringgå brandväggskontroller. | "AzureServices" "Ingen" |
| networkAclBypassResourceIds | En matris som innehåller resurs-ID:n för förbikoppling av nätverks-Acl för Cosmos DB-kontot. | string[] |
| publicNetworkAccess | Om begäranden från offentligt nätverk tillåts | "Inaktiverad" "Aktiverad" |
| restoreParameters | Parametrar som anger information om återställningen. | RestoreParameters |
| virtualNetworkRules | Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Name | Beskrivning | Värde |
|---|---|---|
| schemaType | Beskriver schematyperna för analytisk lagring. | "Fullständig återgivning" "WellDefined" |
ApiProperties
| Name | Beskrivning | Värde |
|---|---|---|
| serverVersion | Beskriver ServerVersion för ett MongoDB-konto. | '3.2' '3.6' '4.0' '4.2' |
BackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| migrationState | Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. | BackupPolicyMigrationState |
| typ | Ange objekttyp | Kontinuerligt Periodisk (krävs) |
BackupPolicyMigrationState
| Name | Beskrivning | Värde |
|---|---|---|
| startTime | Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). | sträng |
| status | Beskriver status för migrering mellan typer av säkerhetskopieringsprinciper. | "Slutfört" "Misslyckades" "InProgress" "Ogiltigt" |
| targetType | Beskriver principtypen för målsäkerhetskopiering för migreringen av säkerhetskopieringsprincipen. | "Kontinuerlig" "Periodisk" |
ContinuousModeBackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Beskriver läget för säkerhetskopior. | "Kontinuerlig" (krävs) |
PeriodicModeBackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Beskriver läget för säkerhetskopior. | "Periodisk" (krävs) |
| periodicModeEgenskaper | Konfigurationsvärden för säkerhetskopiering i periodiskt läge | PeriodicModeEgenskaper |
PeriodicModeEgenskaper
| Name | Beskrivning | Värde |
|---|---|---|
| backupIntervalInMinutes | Ett heltal som representerar intervallet i minuter mellan två säkerhetskopior | int Begränsningar: Minsta värde = 0 |
| backupRetentionIntervalInHours | Ett heltal som representerar den tid (i timmar) som varje säkerhetskopia behålls | int Begränsningar: Minsta värde = 0 |
| backupStorageRedundancy | Räkna upp för att ange typ av säkerhetskopieringshemvist | "Geo" "Lokal" "Zon" |
Funktion
| Name | Beskrivning | Värde |
|---|---|---|
| name | Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". | sträng |
Kapacitet
| Name | Beskrivning | Värde |
|---|---|---|
| totalThroughputLimit | Den totala dataflödesgränsen som har införts för kontot. En totalThroughputLimit på 2000 inför en strikt gräns för maximalt dataflöde som kan etableras för det kontot till 2000. Ett totalThroughputLimit på -1 anger inga gränser för etablering av dataflöde. | int |
ConsistencyPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| defaultConsistencyLevel | Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot. | "BoundedStaleness" "ConsistentPrefix" "Slutlig" "Session" "Stark" (krävs) |
| maxIntervalInSeconds | När det används med konsekvensnivån Begränsad föråldring representerar det här värdet den tidsmängd av föråldring (i sekunder) som tolereras. Godkänt intervall för det här värdet är 5–86400. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". | int Begränsningar: Minsta värde = 5 Maxvärde = 86400 |
| maxStalenessPrefix | När det används med konsekvensnivån Begränsad föråldring representerar det här värdet antalet inaktuella begäranden som tolereras. Godkänt intervall för det här värdet är 1 – 2 147 483 647. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". | int Begränsningar: Minsta värde = 1 Maxvärde = 2147483647 |
CorsPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| allowedHeaders | De begärandehuvuden som ursprungsdomänen kan ange i CORS-begäran. | sträng |
| allowedMethods | De metoder (HTTP-begärandeverb) som ursprungsdomänen kan använda för en CORS-begäran. | sträng |
| allowedOrigins | De ursprungsdomäner som tillåts göra en begäran mot tjänsten via CORS. | sträng (krävs) |
| exposedHeaders | Svarshuvudena som kan skickas i svaret på CORS-begäran och exponeras av webbläsaren för frågeutfärdaren. | sträng |
| maxAgeInSeconds | Den maximala tid som en webbläsare ska cachelagera begäran för förhandsversionen av ALTERNATIV. | int Begränsningar: Minsta värde = 1 Maxvärde = 2147483647 |
IpAddressOrRange
| Name | Beskrivning | Värde |
|---|---|---|
| ipAddressOrRange | En enda IPv4-adress eller ett enda IPv4-adressintervall i CIDR-format. Angivna IP-adresser måste vara välformaterade och kan inte finnas i något av följande intervall: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, eftersom dessa inte kan tillämpas av IP-adressfiltret. Exempel på giltiga indata: "23.40.210.245" eller "23.40.210.0/8". | sträng |
Position
| Namn | Beskrivning | Värde |
|---|---|---|
| failoverPriority | Redundansprioriteten för regionen. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner – 1). Redundansprioritetsvärden måste vara unika för var och en av de regioner där databaskontot finns. | int Begränsningar: Minsta värde = 0 |
| isZoneRedundant | Flagga för att ange om den här regionen är en AvailabilityZone-region eller inte | boolesk |
| locationName | Namnet på regionen. | sträng |
RestoreParameters
| Name | Beskrivning | Värde |
|---|---|---|
| databasesToRestore | Lista över specifika databaser som är tillgängliga för återställning. | DatabaseRestoreResource[] |
| restoreMode | Beskriver återställningsläget. | "PointInTime" |
| restoreSource | ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | sträng |
| restoreTimestampInUtc | Tid då kontot måste återställas (ISO-8601-format). | sträng |
DatabaseRestoreResource
| Name | Beskrivning | Värde |
|---|---|---|
| collectionNames | Namnen på samlingarna som är tillgängliga för återställning. | string[] |
| databaseName | Namnet på databasen som är tillgänglig för återställning. | sträng |
VirtualNetworkRule
| Name | Beskrivning | Värde |
|---|---|---|
| id | Resurs-ID för ett undernät, till exempel: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | sträng |
| ignoreMissingVNetServiceEndpoint | Skapa brandväggsregel innan VNet-tjänstslutpunkten är aktiverad i det virtuella nätverket. | boolesk |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Description |
|---|---|
| CI/CD med Jenkins i Azure Container Service (AKS) |
Containrar gör det mycket enkelt för dig att kontinuerligt skapa och distribuera dina program. Genom att dirigera distributionen av dessa containrar med Kubernetes i Azure Container Service kan du uppnå replikerbara, hanterbara kluster med containrar. Genom att konfigurera en kontinuerlig version för att skapa dina containeravbildningar och orkestrering kan du öka distributionens hastighet och tillförlitlighet. |
| Webbapp med en SQL Database, Azure Cosmos DB, Azure Search |
Den här mallen etablerar en webbapp, en SQL Database, Azure Cosmos DB, Azure Search och Application Insights. |
| Skapa ett Azure Cosmos DB-konto för Cassandra-API:et |
Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra-API:et i två regioner med ett nyckelutrymme och en tabell med dedikerat dataflöde. |
| Skapa ett Azure Cosmos DB-konto för automatisk skalning för Cassandra-API:et |
Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra-API:et i två regioner med ett nyckelutrymme och en tabell med dataflöde för automatisk skalning. |
| Skapa ett Azure CosmosDB-konto |
Den här ARM-mallen har för avsikt att snabbt skapa ett CosmosDB-konto med de minsta nödvändiga värdena |
| Skapa ett Azure Cosmos DB-konto i flera regioner |
Den här mallen skapar ett Azure Cosmos DB-konto för alla typer av databas-API:er med en primär och sekundär region med val av konsekvensnivå och redundanstyp. |
| 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 Gremlin API |
Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med dedikerat dataflöde. |
| Skapa ett Azure Cosmos DB-konto för autoskalning av Gremlin API |
Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med dataflöde för autoskalning. |
| Skapa ett Azure Cosmos-konto för MongoDB API |
Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med delat och dedikerat dataflöde med två samlingar. |
| Skapa ett Azure Cosmos-konto för autoskalning av MongoDB API |
Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med både delat och dedikerat dataflöde för autoskalning. |
| Skapa ett Azure Cosmos DB-konto med en privat slutpunkt |
Den här mallen skapar ett Cosmos-konto, ett virtuellt nätverk och en privat slutpunkt som exponerar Cosmos-kontot för det virtuella nätverket. |
| 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. |
| Skapa ett minimalt Azure Cosmos DB-konto för Core (SQL) API |
Den här mallen skapar ett Azure Cosmos DB-konto för Core-API:et (SQL) samtidigt som du bara anger de minsta nödvändiga resursegenskaperna. |
| Skapa Azure Cosmos med SQL API och flera containrar |
Mallen skapar en Cosmos-container med ett SQL-API och gör det möjligt att lägga till flera containrar. |
| Skapa ett Azure Cosmos DB SQL-konto med dataplanets RBAC |
Den här mallen skapar ett SQL Cosmos-konto, en internt underhållen rolldefinition och en internt underhållen rolltilldelning för en AAD-identitet. |
| Skapa ett serverlöst Azure Cosmos DB-konto för SQL API |
Den här mallen skapar ett serverlöst Azure Cosmos DB-konto för Core-API:et (SQL). |
| Skapa ett Azure Cosmos-konto för Tabell-API |
Den här mallen skapar ett Azure Cosmos DB-konto för Tabell-API i två regioner och en enda tabell med etablerat dataflöde. |
| Skapa ett Azure Cosmos-konto för Tabell-API med autoskalning |
Den här mallen skapar ett Azure Cosmos DB-konto för Tabell-API i två regioner och en enda tabell med dataflöde för automatisk skalning. |
| Skapa ett Azure Cosmos-konto med nolltouch och Azure Web App |
Den här mallen skapar ett Azure Cosmos-konto, matar in Cosmos DB-slutpunkten och nycklarna i inställningarna för Azure Web App och distribuerar sedan en ASP MVC-webbapp från GitHub. |
| Skapa ett Cosmos DB-konto med Microsoft Defender aktiverat |
Med den här ARM-mallen kan du distribuera ett Azure Cosmos DB-konto med Microsoft Defender för Azure Cosmos DB aktiverat. Microsoft Defender för Azure Cosmos DB är ett Azure-internt säkerhetslager som identifierar försök att utnyttja databaser i dina Azure Cosmos DB-konton. Microsoft Defender för Azure Cosmos DB identifierar potentiella SQL-inmatningar, kända dåliga aktörer baserat på Microsoft Threat Intelligence, misstänkta åtkomstmönster och potentiella utnyttjanden av databasen via komprometterade identiteter eller skadliga insiders. |
| Distribuera Azure Data Explorer DB med Cosmos DB-anslutning |
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. |
| Azure Cosmos DB-konto med webbapp |
Den här mallen distribuerar ett Azure Cosmos DB-konto, en App Service-plan, och skapar en webbapp i App Service-planen. Dessutom läggs två programinställningar till i webbappen som refererar till Azure Cosmos DB-kontots slutpunkt. På så sätt kan lösningar som distribueras till webbappen ansluta till Azure Cosmos DB-kontots slutpunkt med hjälp av dessa inställningar. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts 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 Microsoft.DocumentDB/databaseAccounts-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2022-08-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
analyticalStorageConfiguration = {
schemaType = "string"
}
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
migrationState = {
startTime = "string"
status = "string"
targetType = "string"
}
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
capacity = {
totalThroughputLimit = int
}
connectorOffer = "Small"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
enablePartitionMerge = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
restoreMode = "PointInTime"
restoreSource = "string"
restoreTimestampInUtc = "string"
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
kind = "string"
})
}
BackupPolicy-objekt
Ange typegenskapen för att ange typ av objekt.
För Kontinuerlig använder du:
type = "Continuous"
För Periodisk använder du:
type = "Periodic"
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
Egenskapsvärden
databaseAccounts
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts@2022-08-15" |
| name | Resursnamnet | sträng (krävs) Teckengräns: 3–44 Giltiga tecken: Gemener, siffror och bindestreck. Börja med en gemen bokstav eller siffra. Resursnamnet måste vara unikt i Hela Azure. |
| location | Platsen för resursgruppen som resursen tillhör. | sträng |
| parent_id | Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. | sträng (krävs) |
| 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. |
| Typ | Anger typen av databaskonto. Detta kan bara anges när databaskontot skapas. | "GlobalDocumentDB" "MongoDB" "Parsa" |
| identity | Identitet för resursen. | ManagedServiceIdentity |
| properties | Egenskaper för att skapa och uppdatera Azure Cosmos DB-databaskonton. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (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 alla identiteter från tjänsten. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| 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. |
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.
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Name | Beskrivning | Värde |
|---|---|---|
| analyticalStorageConfiguration | Analyslagringsspecifika egenskaper. | AnalyticalStorageConfiguration |
| apiProperties | API-specifika egenskaper. Stöds för närvarande endast för MongoDB API. | ApiProperties |
| backupPolicy | Objektet som representerar principen för säkerhetskopiering av ett konto. | BackupPolicy |
| funktioner | Lista över Cosmos DB-funktioner för kontot | Kapacitet[] |
| capacity | Objektet som representerar alla egenskaper som är relaterade till kapacitetstillämpning för ett konto. | Kapacitet |
| connectorOffer | Erbjudandetypen för Cassandra-anslutningsappen för Cosmos DB-databasens C*-konto. | "Liten" |
| consistencyPolicy | Konsekvensprincipen för Cosmos DB-kontot. | ConsistencyPolicy |
| cors | CORS-principen för Cosmos DB-databaskontot. | CorsPolicy[] |
| createMode | Uppräkning för att ange läget för kontoskapande. | "Standard" "Återställ" |
| databaseAccountOfferType | Erbjudandetypen för databasen | "Standard" (obligatoriskt) |
| defaultIdentity | Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste anges uttryckligen av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. | sträng |
| disableKeyBasedMetadataWriteAccess | Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar | boolesk |
| disableLocalAuth | Avregistrera lokal autentisering och se till att endast MSI och AAD kan användas exklusivt för autentisering. | boolesk |
| enableAnalyticalStorage | Flagga för att ange om lagringsanalys ska aktiveras. | boolesk |
| enableAutomaticFailover | Aktiverar automatisk redundans för skrivregionen i den sällsynta händelsen att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. | boolesk |
| enableCassandraConnector | Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot | boolesk |
| enableFreeTier | Flagga för att ange om den kostnadsfria nivån är aktiverad. | boolesk |
| enableMultipleWriteLocations | Gör att kontot kan skriva på flera platser | boolesk |
| enablePartitionMerge | Flagga för att ange aktivering/inaktivering av funktionen för sammanslagning av partitioner på kontot | boolesk |
| ipRules | Lista över IpRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk. | boolesk |
| keyVaultKeyUri | URI för nyckelvalvet | sträng |
| platser | En matris som innehåller de georeplication-platser som är aktiverade för Cosmos DB-kontot. | Location[] (krävs) |
| networkAclBypass | Anger vilka tjänster som tillåts kringgå brandväggskontroller. | "AzureServices" "Ingen" |
| networkAclBypassResourceIds | En matris som innehåller resurs-ID:n för Förbikoppling av nätverks-Acl för Cosmos DB-kontot. | string[] |
| publicNetworkAccess | Om begäranden från offentligt nätverk tillåts | "Inaktiverad" "Aktiverad" |
| restoreParameters | Parametrar som anger information om återställningen. | RestoreParameters |
| virtualNetworkRules | Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot. | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Name | Beskrivning | Värde |
|---|---|---|
| schemaType | Beskriver typerna av scheman för analyslagring. | "FullFidelity" "WellDefined" |
ApiProperties
| Name | Beskrivning | Värde |
|---|---|---|
| serverVersion | Beskriver ServerVersion för ett MongoDB-konto. | "3.2" "3.6" "4.0" "4.2" |
BackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| migrationState | Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. | BackupPolicyMigrationState |
| typ | Ange objekttyp | Kontinuerligt Periodisk (krävs) |
BackupPolicyMigrationState
| Name | Beskrivning | Värde |
|---|---|---|
| startTime | Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). | sträng |
| status | Beskriver status för migrering mellan typer av säkerhetskopieringsprinciper. | "Slutfört" "Misslyckades" "InProgress" "Ogiltigt" |
| targetType | Beskriver målprinciptypen för säkerhetskopieringspolicyn för migreringen av säkerhetskopieringspolicyn. | "Kontinuerlig" "Periodisk" |
ContinuousModeBackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Beskriver läget för säkerhetskopior. | "Kontinuerlig" (obligatoriskt) |
PeriodicModeBackupPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Beskriver läget för säkerhetskopior. | "Periodisk" (obligatoriskt) |
| periodicModeProperties | Konfigurationsvärden för periodisk säkerhetskopiering i läge | PeriodicModeProperties |
PeriodicModeProperties
| Name | Beskrivning | Värde |
|---|---|---|
| backupIntervalInMinutes | Ett heltal som representerar intervallet i minuter mellan två säkerhetskopior | int Begränsningar: Minsta värde = 0 |
| backupRetentionIntervalInHours | Ett heltal som representerar den tid (i timmar) som varje säkerhetskopia behålls | int Begränsningar: Minsta värde = 0 |
| backupStorageRedundancy | Uppräkning för att ange typ av säkerhetskopieringshemvist | "Geo" "Lokal" "Zon" |
Funktion
| Name | Beskrivning | Värde |
|---|---|---|
| name | Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". | sträng |
Kapacitet
| Name | Beskrivning | Värde |
|---|---|---|
| totalThroughputLimit | Den totala dataflödesgräns som har införts för kontot. En totalThroughputLimit på 2000 inför en strikt gräns för maximalt dataflöde som kan etableras på det kontot till 2000. Ett totalThroughputLimit på -1 anger inga begränsningar för etablering av dataflöde. | int |
ConsistencyPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| defaultConsistencyLevel | Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot. | "BoundedStaleness" "ConsistentPrefix" "Slutlig" "Session" "Stark" (krävs) |
| maxIntervalInSeconds | När det används med konsekvensnivån Begränsad föråldring representerar det här värdet den tidsmängd av föråldring (i sekunder) som tolereras. Godkänt intervall för det här värdet är 5–86400. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". | int Begränsningar: Minsta värde = 5 Maxvärde = 86400 |
| maxStalenessPrefix | När det används med konsekvensnivån Begränsad föråldring representerar det här värdet antalet inaktuella begäranden som tolereras. Godkänt intervall för det här värdet är 1–2 147 483 647. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness". | int Begränsningar: Minsta värde = 1 Maxvärde = 2147483647 |
CorsPolicy
| Name | Beskrivning | Värde |
|---|---|---|
| allowedHeaders | Begärandehuvudena som ursprungsdomänen kan ange i CORS-begäran. | sträng |
| allowedMethods | De metoder (HTTP-begärandeverb) som ursprungsdomänen kan använda för en CORS-begäran. | sträng |
| allowedOrigins | De ursprungsdomäner som tillåts att göra en begäran mot tjänsten via CORS. | sträng (krävs) |
| exposedHeaders | Svarshuvudena som kan skickas i svaret på CORS-begäran och exponeras av webbläsaren för frågeutfärdaren. | sträng |
| maxAgeInSeconds | Den maximala tid som en webbläsare ska cachelagera begäran för förhandsversionen av ALTERNATIV. | int Begränsningar: Minsta värde = 1 Maxvärde = 2147483647 |
IpAddressOrRange
| Name | Beskrivning | Värde |
|---|---|---|
| ipAddressOrRange | En enda IPv4-adress eller ett enda IPv4-adressintervall i CIDR-format. Angivna IP-adresser måste vara välformaterade och kan inte finnas i något av följande intervall: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, eftersom dessa inte kan tillämpas av IP-adressfiltret. Exempel på giltiga indata: "23.40.210.245" eller "23.40.210.0/8". | sträng |
Position
| Namn | Beskrivning | Värde |
|---|---|---|
| failoverPriority | Redundansprioriteten för regionen. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner – 1). Redundansprioritetsvärden måste vara unika för var och en av de regioner där databaskontot finns. | int Begränsningar: Minsta värde = 0 |
| isZoneRedundant | Flagga för att ange om den här regionen är en AvailabilityZone-region eller inte | boolesk |
| locationName | Namnet på regionen. | sträng |
RestoreParameters
| Name | Beskrivning | Värde |
|---|---|---|
| databasesToRestore | Lista över specifika databaser som är tillgängliga för återställning. | DatabaseRestoreResource[] |
| restoreMode | Beskriver återställningsläget. | "PointInTime" |
| restoreSource | ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | sträng |
| restoreTimestampInUtc | Tid då kontot måste återställas (ISO-8601-format). | sträng |
DatabaseRestoreResource
| Name | Beskrivning | Värde |
|---|---|---|
| collectionNames | Namnen på samlingarna som är tillgängliga för återställning. | string[] |
| databaseName | Namnet på databasen som är tillgänglig för återställning. | sträng |
VirtualNetworkRule
| Name | Beskrivning | Värde |
|---|---|---|
| id | Resurs-ID för ett undernät, till exempel: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | sträng |
| ignoreMissingVNetServiceEndpoint | Skapa brandväggsregel innan VNet-tjänstslutpunkten är aktiverad i det virtuella nätverket. | boolesk |