Dela via

Microsoft.DocumentDB databaseAccounts

  • Artikel

Bicep-resursdefinition

Resurstypen databaseAccounts kan distribueras med åtgärder som mål:

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@2024-12-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  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
    }
    capacityMode: 'string'
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    customerManagedKeyStatus: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    defaultPriorityLevel: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePerRegionPerPartitionAutoscale: bool
    enablePriorityBasedExecution: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'string'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      restoreWithTtlDisabled: bool
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

BackupPolicy-objekt

Ange egenskapen typ för att ange typ av objekt.

För Kontinuerliganvänder du:

{
  continuousModeProperties: {
    tier: 'string'
  }
  type: 'Continuous'
}

För periodiskaanvänder du:

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

Egenskapsvärden

AnalyticalStorageConfiguration

Namn Beskrivning Värde
schemaType Beskriver typerna av schema för analyslagring. "FullFidelity"
"WellDefined"

ApiProperties

Namn Beskrivning Värde
serverVersion Beskriver versionen av MongoDB-kontot. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

BackupPolicy

Namn Beskrivning Värde
migrationState Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. BackupPolicyMigrationState
typ Ange till Kontinuerlig för typen ContinuousModeBackupPolicy. Ange till Periodisk för typ PeriodicModeBackupPolicy. "Kontinuerlig"
"Periodisk" (krävs)

BackupPolicyMigrationState

Namn Beskrivning Värde
startTime Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). sträng
status Beskriver status för migrering mellan principtyper för säkerhetskopiering. "Slutförd"
"Misslyckades"
"InProgress"
"Ogiltigt"
targetType Beskriver målprinciptypen för säkerhetskopieringsprincipen för migreringen av säkerhetskopieringsprinciper. "Kontinuerlig"
"Periodisk"

Förmåga

Namn Beskrivning Värde
Namn Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". sträng

Kapacitet

Namn Beskrivning Värde
totalThroughputLimit Den totala dataflödesgräns som har införts för kontot. Ett totalThroughputLimit på 2000 medför en strikt gräns för maximalt dataflöde som kan etableras på kontot till 2000. Ett totalThroughputLimit av -1 anger inga begränsningar för etablering av dataflöde. Int

Begränsningar:
Minsta värde = -1

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Namn Beskrivning Värde

ConsistencyPolicy

Namn 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 tid då inaktuellhet (i sekunder) 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

ContinuousModeBackupPolicy

Namn Beskrivning Värde
continuousModeProperties Konfigurationsvärden för säkerhetskopiering i kontinuerligt läge ContinuousModeProperties
typ Beskriver läget för säkerhetskopior. "Kontinuerlig" (krävs)

ContinuousModeProperties

Namn Beskrivning Värde
Nivå Uppräkning för att ange typ av Continuos-säkerhetskopieringsläge "Continuous30Days"
"Continuous7Days"

CorsPolicy

Namn 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 om förhandsversionen av ALTERNATIV. Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Namn Beskrivning Värde
analyticalStorageConfiguration Specifika egenskaper för analyslagring. AnalyticalStorageConfiguration
apiProperties API-specifika egenskaper. För närvarande stöds endast för MongoDB API. ApiProperties
backupPolicy Objektet som representerar principen för att ta säkerhetskopior på ett konto. BackupPolicy
Kapacitet Lista över Cosmos DB-funktioner för kontot Kapacitet[]
kapacitet Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto. Kapacitet
capacityMode Anger capacityMode för Cosmos DB-kontot. "Ingen"
"Etablerad"
"Serverlös"
connectorOffer Erbjudandetypen cassandra connector 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"
customerManagedKeyStatus Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning. sträng
databaseAccountOfferType Erbjudandetypen för databasen "Standard" (krävs)
defaultIdentity Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. sträng
defaultPriorityLevel Uppräkning för att ange standardprioritetsnivå för begäran för prioritetsbaserad körning. "Hög"
"Låg"
diagnosticLogSettings Objektet som representerar de olika diagnostiklogginställningarna för Cosmos DB-kontot. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar Bool
disableLocalAuth Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. Bool
enableAnalyticalStorage Flagga för att ange om lagringsanalys ska aktiveras. Bool
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. Bool
enableBurstCapacity Flagga för att ange aktivering/inaktivering av funktionen Burst Capacity Preview på kontot Bool
enableCassandraConnector Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot Bool
enableFreeTier Flagga för att ange om den kostnadsfria nivån är aktiverad. Bool
enableMaterializedViews Flagga för att ange om MaterializedViews ska aktiveras på Cosmos DB-kontot Bool
enableMultipleWriteLocations Gör att kontot kan skriva på flera platser Bool
enablePartitionMerge Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot Bool
enablePerRegionPerPartitionAutoscale Flagga som anger aktivering/inaktivering av Per-Region funktion för automatisk skalning per partition för kontot Bool
enablePriorityBasedExecution Flagga för att ange aktivering/inaktivering av funktionen Förhandsgranskning av prioritetsbaserad körning på kontot Bool
ipRules Lista över IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk. Bool
keyVaultKeyUri URI för nyckelvalvet sträng
Platser En matris som innehåller de georeplikeringsplatser som är aktiverade för Cosmos DB-kontot. Plats[] (krävs)
minimalTlsVersion Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.0, förutom Cassandra och Mongo API: er, som endast fungerar med Tls 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass Anger vilka tjänster som tillåts kringgå brandväggskontroller. "AzureServices"
"Ingen"
networkAclBypassResourceIds En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot. string[]
publicNetworkAccess Om begäranden från offentliga nätverk tillåts "Inaktiverad"
"Aktiverad"
"SecuredByPerimeter"
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[]

DatabaseRestoreResource

Namn 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

DiagnosticLogSettings

Namn Beskrivning Värde
enableFullTextQuery Beskriv detaljnivån för vilka frågor som ska loggas. "Falskt"
"Ingen"
"Sant"

GremlinDatabaseRestoreResource

Namn Beskrivning Värde
databaseName Namnet på den gremlindatabas som är tillgänglig för återställning. sträng
graphNames Namnen på graferna som är tillgängliga för återställning. string[]

IpAddressOrRange

Namn 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

Plats

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). Prioritetsvärden för redundans 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 Bool
locationName Namnet på regionen. sträng

ManagedServiceIdentity

Namn 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"
"UserAssigned"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Microsoft.DocumentDB/databaseAccounts

Namn Beskrivning Värde
identitet Identitet för resursen. ManagedServiceIdentity
sort Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas. "GlobalDocumentDB"
"MongoDB"
"Parsa"
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng

Begränsningar:
Min längd = 3
Maximal längd = 3
Mönster = ^[a-z0-9]+(-[a-z0-9]+)* (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB-databaskonton. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

PeriodicModeBackupPolicy

Namn Beskrivning Värde
periodicModeProperties Konfigurationsvärden för säkerhetskopiering i periodiskt läge PeriodicModeProperties
typ Beskriver läget för säkerhetskopior. "Periodisk" (krävs)

PeriodicModeProperties

Namn 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äkerhetskopieringshem "Geo"
"Lokal"
"Zon"

RestoreParameters

Namn Beskrivning Värde
databasesToRestore Lista över specifika databaser som är tillgängliga för återställning. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista över specifika gremlin-databaser som är tillgängliga för återställning. GremlinDatabaseRestoreResource[]
restoreMode Beskriver återställningsläget. "PointInTime"
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till 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
restoreWithTtlDisabled Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. Bool
sourceBackupLocation Platsen för källsäkerhetskopiering för återställning. sträng
tablesToRestore Lista över specifika tabeller som är tillgängliga för återställning. string[]

Taggar

Namn Beskrivning Värde

VirtualNetworkRule

Namn 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. Bool

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
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 analysarkivet.
Azure Cosmos DB-konto med Web App Den här mallen distribuerar ett Azure Cosmos DB-konto, en App Service-plan och skapar en webbapp i App Service-planen. Den lägger också till två programinställningar i webbappen som refererar till Azure Cosmos DB-kontoslutpunkten. På så sätt kan lösningar som distribueras till webbappen ansluta till Azure Cosmos DB-kontoslutpunkten med hjälp av dessa inställningar.
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-inbyggt 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.
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container.
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) och anger bara de minsta nödvändiga resursegenskaperna.
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 med noll touch och Azure Web App- Den här mallen skapar ett Azure Cosmos-konto, matar in Cosmos DB-slutpunkten och nycklarna i Azure Web App-inställningarna och distribuerar sedan en ASP MVC-webbapp från GitHub.
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 hjälp av både delat och dedikerat autoskalningsdataflöde.
Skapa ett Azure Cosmos-konto för Table 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 autoskalningsdataflöde.
Skapa ett Azure Cosmos DB-konto för Cassandra API Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra API i två regioner med ett nyckelområde och en tabell med dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Core (SQL) API 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.
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 hjälp av 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 autoskalningsdataflöde.
Skapa ett Azure Cosmos DB-konto i flera regioner Den här mallen skapar ett Azure Cosmos DB-konto för valfri databas-API-typ med en primär och sekundär region med val av konsekvensnivå och redundanstyp.
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 autoskalningsdataflöde med flera andra alternativ.
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 SQL-konto med dataplanets RBAC- Den här mallen skapar ett SQL Cosmos-konto, en inbyggt underhållen rolldefinition och en inbyggt underhållen rolltilldelning för en AAD-identitet.
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 Azure Cosmos DB-konto för automatisk skalning för Cassandra API Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra API i två regioner med ett nyckelområde och en tabell med autoskalningsdataflöde.
Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL) 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.
Skapar en Dapr-mikrotjänstapp med containerappar Skapa en Dapr-mikrotjänstapp med containerappar.
Skapar en Dapr pub-sub servicebus-app med containerappar Skapa en Dapr pub-sub servicebus-app med containerappar.
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 kan distribueras med åtgärder som mål:

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": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "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"
    },
    "capacityMode": "string",
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "customerManagedKeyStatus": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "defaultPriorityLevel": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePerRegionPerPartitionAutoscale": "bool",
    "enablePriorityBasedExecution": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "string",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "restoreWithTtlDisabled": "bool",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

BackupPolicy-objekt

Ange egenskapen typ för att ange typ av objekt.

För Kontinuerliganvänder du:

{
  "continuousModeProperties": {
    "tier": "string"
  },
  "type": "Continuous"
}

För periodiskaanvänder du:

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

Egenskapsvärden

AnalyticalStorageConfiguration

Namn Beskrivning Värde
schemaType Beskriver typerna av schema för analyslagring. "FullFidelity"
"WellDefined"

ApiProperties

Namn Beskrivning Värde
serverVersion Beskriver versionen av MongoDB-kontot. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

BackupPolicy

Namn Beskrivning Värde
migrationState Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. BackupPolicyMigrationState
typ Ange till Kontinuerlig för typen ContinuousModeBackupPolicy. Ange till Periodisk för typ PeriodicModeBackupPolicy. "Kontinuerlig"
"Periodisk" (krävs)

BackupPolicyMigrationState

Namn Beskrivning Värde
startTime Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). sträng
status Beskriver status för migrering mellan principtyper för säkerhetskopiering. "Slutförd"
"Misslyckades"
"InProgress"
"Ogiltigt"
targetType Beskriver målprinciptypen för säkerhetskopieringsprincipen för migreringen av säkerhetskopieringsprinciper. "Kontinuerlig"
"Periodisk"

Förmåga

Namn Beskrivning Värde
Namn Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". sträng

Kapacitet

Namn Beskrivning Värde
totalThroughputLimit Den totala dataflödesgräns som har införts för kontot. Ett totalThroughputLimit på 2000 medför en strikt gräns för maximalt dataflöde som kan etableras på kontot till 2000. Ett totalThroughputLimit av -1 anger inga begränsningar för etablering av dataflöde. Int

Begränsningar:
Minsta värde = -1

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Namn Beskrivning Värde

ConsistencyPolicy

Namn 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 tid då inaktuellhet (i sekunder) 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

ContinuousModeBackupPolicy

Namn Beskrivning Värde
continuousModeProperties Konfigurationsvärden för säkerhetskopiering i kontinuerligt läge ContinuousModeProperties
typ Beskriver läget för säkerhetskopior. "Kontinuerlig" (krävs)

ContinuousModeProperties

Namn Beskrivning Värde
Nivå Uppräkning för att ange typ av Continuos-säkerhetskopieringsläge "Continuous30Days"
"Continuous7Days"

CorsPolicy

Namn 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 om förhandsversionen av ALTERNATIV. Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Namn Beskrivning Värde
analyticalStorageConfiguration Specifika egenskaper för analyslagring. AnalyticalStorageConfiguration
apiProperties API-specifika egenskaper. För närvarande stöds endast för MongoDB API. ApiProperties
backupPolicy Objektet som representerar principen för att ta säkerhetskopior på ett konto. BackupPolicy
Kapacitet Lista över Cosmos DB-funktioner för kontot Kapacitet[]
kapacitet Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto. Kapacitet
capacityMode Anger capacityMode för Cosmos DB-kontot. "Ingen"
"Etablerad"
"Serverlös"
connectorOffer Erbjudandetypen cassandra connector 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"
customerManagedKeyStatus Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning. sträng
databaseAccountOfferType Erbjudandetypen för databasen "Standard" (krävs)
defaultIdentity Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. sträng
defaultPriorityLevel Uppräkning för att ange standardprioritetsnivå för begäran för prioritetsbaserad körning. "Hög"
"Låg"
diagnosticLogSettings Objektet som representerar de olika diagnostiklogginställningarna för Cosmos DB-kontot. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar Bool
disableLocalAuth Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. Bool
enableAnalyticalStorage Flagga för att ange om lagringsanalys ska aktiveras. Bool
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. Bool
enableBurstCapacity Flagga för att ange aktivering/inaktivering av funktionen Burst Capacity Preview på kontot Bool
enableCassandraConnector Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot Bool
enableFreeTier Flagga för att ange om den kostnadsfria nivån är aktiverad. Bool
enableMaterializedViews Flagga för att ange om MaterializedViews ska aktiveras på Cosmos DB-kontot Bool
enableMultipleWriteLocations Gör att kontot kan skriva på flera platser Bool
enablePartitionMerge Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot Bool
enablePerRegionPerPartitionAutoscale Flagga som anger aktivering/inaktivering av Per-Region funktion för automatisk skalning per partition för kontot Bool
enablePriorityBasedExecution Flagga för att ange aktivering/inaktivering av funktionen Förhandsgranskning av prioritetsbaserad körning på kontot Bool
ipRules Lista över IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk. Bool
keyVaultKeyUri URI för nyckelvalvet sträng
Platser En matris som innehåller de georeplikeringsplatser som är aktiverade för Cosmos DB-kontot. Plats[] (krävs)
minimalTlsVersion Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.0, förutom Cassandra och Mongo API: er, som endast fungerar med Tls 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass Anger vilka tjänster som tillåts kringgå brandväggskontroller. "AzureServices"
"Ingen"
networkAclBypassResourceIds En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot. string[]
publicNetworkAccess Om begäranden från offentliga nätverk tillåts "Inaktiverad"
"Aktiverad"
"SecuredByPerimeter"
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[]

DatabaseRestoreResource

Namn 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

DiagnosticLogSettings

Namn Beskrivning Värde
enableFullTextQuery Beskriv detaljnivån för vilka frågor som ska loggas. "Falskt"
"Ingen"
"Sant"

GremlinDatabaseRestoreResource

Namn Beskrivning Värde
databaseName Namnet på den gremlindatabas som är tillgänglig för återställning. sträng
graphNames Namnen på graferna som är tillgängliga för återställning. string[]

IpAddressOrRange

Namn 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

Plats

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). Prioritetsvärden för redundans 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 Bool
locationName Namnet på regionen. sträng

ManagedServiceIdentity

Namn 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"
"UserAssigned"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Microsoft.DocumentDB/databaseAccounts

Namn Beskrivning Värde
apiVersion API-versionen "2024-12-01-preview"
identitet Identitet för resursen. ManagedServiceIdentity
sort Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas. "GlobalDocumentDB"
"MongoDB"
"Parsa"
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng

Begränsningar:
Min längd = 3
Maximal längd = 3
Mönster = ^[a-z0-9]+(-[a-z0-9]+)* (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB-databaskonton. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts"

PeriodicModeBackupPolicy

Namn Beskrivning Värde
periodicModeProperties Konfigurationsvärden för säkerhetskopiering i periodiskt läge PeriodicModeProperties
typ Beskriver läget för säkerhetskopior. "Periodisk" (krävs)

PeriodicModeProperties

Namn 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äkerhetskopieringshem "Geo"
"Lokal"
"Zon"

RestoreParameters

Namn Beskrivning Värde
databasesToRestore Lista över specifika databaser som är tillgängliga för återställning. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista över specifika gremlin-databaser som är tillgängliga för återställning. GremlinDatabaseRestoreResource[]
restoreMode Beskriver återställningsläget. "PointInTime"
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till 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
restoreWithTtlDisabled Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. Bool
sourceBackupLocation Platsen för källsäkerhetskopiering för återställning. sträng
tablesToRestore Lista över specifika tabeller som är tillgängliga för återställning. string[]

Taggar

Namn Beskrivning Värde

VirtualNetworkRule

Namn 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. Bool

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
SQL API för Azure Cosmos DB-konto med analysarkiv

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkivet.
Azure Cosmos DB-konto med Web App

Distribuera till Azure 		Den här mallen distribuerar ett Azure Cosmos DB-konto, en App Service-plan och skapar en webbapp i App Service-planen. Den lägger också till två programinställningar i webbappen som refererar till Azure Cosmos DB-kontoslutpunkten. På så sätt kan lösningar som distribueras till webbappen ansluta till Azure Cosmos DB-kontoslutpunkten med hjälp av dessa inställningar.
CI/CD med Jenkins på Azure Container Service (AKS)

Distribuera till Azure 		Containrar gör det mycket enkelt för dig att kontinuerligt skapa och distribuera dina program. Genom att orkestrera 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.
Skapa ett Cosmos DB-konto med Microsoft Defender aktiverat

Distribuera till Azure 		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-inbyggt 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.
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container.
Skapa ett minimalt Azure Cosmos DB-konto för Core (SQL) API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Core-API:et (SQL) och anger bara de minsta nödvändiga resursegenskaperna.
Skapa ett Serverlöst Azure Cosmos DB-konto för SQL API-

Distribuera till Azure 		Den här mallen skapar ett serverlöst Azure Cosmos DB-konto för Core-API:et (SQL).
Skapa ett Azure Cosmos-konto med noll touch och Azure Web App-

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos-konto, matar in Cosmos DB-slutpunkten och nycklarna i Azure Web App-inställningarna och distribuerar sedan en ASP MVC-webbapp från GitHub.
Skapa ett Azure Cosmos-konto för MongoDB API

Distribuera till Azure 		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

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med hjälp av både delat och dedikerat autoskalningsdataflöde.
Skapa ett Azure Cosmos-konto för Table API-

Distribuera till Azure 		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

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Tabell-API i två regioner och en enda tabell med autoskalningsdataflöde.
Skapa ett Azure Cosmos DB-konto för Cassandra API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra API i två regioner med ett nyckelområde och en tabell med dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Core (SQL) API

Distribuera till Azure 		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.
Skapa ett Azure Cosmos DB-konto för Gremlin API-

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med hjälp av dedikerat dataflöde.
Skapa ett Azure Cosmos DB-konto för Autoskalning av Gremlin API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Gremlin API i två regioner med en databas och en graf med autoskalningsdataflöde.
Skapa ett Azure Cosmos DB-konto i flera regioner

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för valfri databas-API-typ med en primär och sekundär region med val av konsekvensnivå och redundanstyp.
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med autoskalningsdataflöde med flera andra alternativ.
Skapa ett Azure Cosmos DB-konto med en privat slutpunkt

Distribuera till Azure 		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 SQL-konto med dataplanets RBAC-

Distribuera till Azure 		Den här mallen skapar ett SQL Cosmos-konto, en inbyggt underhållen rolldefinition och en inbyggt underhållen rolltilldelning för en AAD-identitet.
Skapa ett Azure CosmosDB-konto

Distribuera till Azure 		Den här ARM-mallen har för avsikt att snabbt skapa ett CosmosDB-konto med de minsta nödvändiga värdena
Skapa Azure Cosmos DB-konto för automatisk skalning för Cassandra API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för Cassandra API i två regioner med ett nyckelområde och en tabell med autoskalningsdataflöde.
Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL)

Distribuera till Azure 		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.
Skapa Azure Cosmos med SQL API och flera containrar

Distribuera till Azure 		Mallen skapar en Cosmos-container med ett SQL API och gör det möjligt att lägga till flertrådscontainrar.
Skapar en Dapr-mikrotjänstapp med containerappar

Distribuera till Azure 		Skapa en Dapr-mikrotjänstapp med containerappar.
Skapar en Dapr pub-sub servicebus-app med containerappar

Distribuera till Azure 		Skapa en Dapr pub-sub servicebus-app med containerappar.
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning

Distribuera till Azure 		Distribuera Azure Data Explorer DB med Cosmos DB-anslutning.
webbapp med en SQL Database, Azure Cosmos DB, Azure Search

Distribuera till Azure 		Den här mallen etablerar en webbapp, en SQL Database, Azure Cosmos DB, Azure Search och Application Insights.

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@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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
      }
      capacityMode = "string"
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      customerManagedKeyStatus = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      defaultPriorityLevel = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePerRegionPerPartitionAutoscale = bool
      enablePriorityBasedExecution = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "string"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        restoreWithTtlDisabled = bool
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

BackupPolicy-objekt

Ange egenskapen typ för att ange typ av objekt.

För Kontinuerliganvänder du:

{
  continuousModeProperties = {
    tier = "string"
  }
  type = "Continuous"
}

För periodiskaanvänder du:

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

Egenskapsvärden

AnalyticalStorageConfiguration

Namn Beskrivning Värde
schemaType Beskriver typerna av schema för analyslagring. "FullFidelity"
"WellDefined"

ApiProperties

Namn Beskrivning Värde
serverVersion Beskriver versionen av MongoDB-kontot. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

BackupPolicy

Namn Beskrivning Värde
migrationState Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna. BackupPolicyMigrationState
typ Ange till Kontinuerlig för typen ContinuousModeBackupPolicy. Ange till Periodisk för typ PeriodicModeBackupPolicy. "Kontinuerlig"
"Periodisk" (krävs)

BackupPolicyMigrationState

Namn Beskrivning Värde
startTime Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format). sträng
status Beskriver status för migrering mellan principtyper för säkerhetskopiering. "Slutförd"
"Misslyckades"
"InProgress"
"Ogiltigt"
targetType Beskriver målprinciptypen för säkerhetskopieringsprincipen för migreringen av säkerhetskopieringsprinciper. "Kontinuerlig"
"Periodisk"

Förmåga

Namn Beskrivning Värde
Namn Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin". sträng

Kapacitet

Namn Beskrivning Värde
totalThroughputLimit Den totala dataflödesgräns som har införts för kontot. Ett totalThroughputLimit på 2000 medför en strikt gräns för maximalt dataflöde som kan etableras på kontot till 2000. Ett totalThroughputLimit av -1 anger inga begränsningar för etablering av dataflöde. Int

Begränsningar:
Minsta värde = -1

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Namn Beskrivning Värde

ConsistencyPolicy

Namn 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 tid då inaktuellhet (i sekunder) 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

ContinuousModeBackupPolicy

Namn Beskrivning Värde
continuousModeProperties Konfigurationsvärden för säkerhetskopiering i kontinuerligt läge ContinuousModeProperties
typ Beskriver läget för säkerhetskopior. "Kontinuerlig" (krävs)

ContinuousModeProperties

Namn Beskrivning Värde
Nivå Uppräkning för att ange typ av Continuos-säkerhetskopieringsläge "Continuous30Days"
"Continuous7Days"

CorsPolicy

Namn 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 om förhandsversionen av ALTERNATIV. Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Namn Beskrivning Värde
analyticalStorageConfiguration Specifika egenskaper för analyslagring. AnalyticalStorageConfiguration
apiProperties API-specifika egenskaper. För närvarande stöds endast för MongoDB API. ApiProperties
backupPolicy Objektet som representerar principen för att ta säkerhetskopior på ett konto. BackupPolicy
Kapacitet Lista över Cosmos DB-funktioner för kontot Kapacitet[]
kapacitet Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto. Kapacitet
capacityMode Anger capacityMode för Cosmos DB-kontot. "Ingen"
"Etablerad"
"Serverlös"
connectorOffer Erbjudandetypen cassandra connector 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"
customerManagedKeyStatus Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning. sträng
databaseAccountOfferType Erbjudandetypen för databasen "Standard" (krävs)
defaultIdentity Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera. sträng
defaultPriorityLevel Uppräkning för att ange standardprioritetsnivå för begäran för prioritetsbaserad körning. "Hög"
"Låg"
diagnosticLogSettings Objektet som representerar de olika diagnostiklogginställningarna för Cosmos DB-kontot. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar Bool
disableLocalAuth Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering. Bool
enableAnalyticalStorage Flagga för att ange om lagringsanalys ska aktiveras. Bool
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. Bool
enableBurstCapacity Flagga för att ange aktivering/inaktivering av funktionen Burst Capacity Preview på kontot Bool
enableCassandraConnector Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot Bool
enableFreeTier Flagga för att ange om den kostnadsfria nivån är aktiverad. Bool
enableMaterializedViews Flagga för att ange om MaterializedViews ska aktiveras på Cosmos DB-kontot Bool
enableMultipleWriteLocations Gör att kontot kan skriva på flera platser Bool
enablePartitionMerge Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot Bool
enablePerRegionPerPartitionAutoscale Flagga som anger aktivering/inaktivering av Per-Region funktion för automatisk skalning per partition för kontot Bool
enablePriorityBasedExecution Flagga för att ange aktivering/inaktivering av funktionen Förhandsgranskning av prioritetsbaserad körning på kontot Bool
ipRules Lista över IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk. Bool
keyVaultKeyUri URI för nyckelvalvet sträng
Platser En matris som innehåller de georeplikeringsplatser som är aktiverade för Cosmos DB-kontot. Plats[] (krävs)
minimalTlsVersion Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.0, förutom Cassandra och Mongo API: er, som endast fungerar med Tls 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass Anger vilka tjänster som tillåts kringgå brandväggskontroller. "AzureServices"
"Ingen"
networkAclBypassResourceIds En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot. string[]
publicNetworkAccess Om begäranden från offentliga nätverk tillåts "Inaktiverad"
"Aktiverad"
"SecuredByPerimeter"
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[]

DatabaseRestoreResource

Namn 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

DiagnosticLogSettings

Namn Beskrivning Värde
enableFullTextQuery Beskriv detaljnivån för vilka frågor som ska loggas. "Falskt"
"Ingen"
"Sant"

GremlinDatabaseRestoreResource

Namn Beskrivning Värde
databaseName Namnet på den gremlindatabas som är tillgänglig för återställning. sträng
graphNames Namnen på graferna som är tillgängliga för återställning. string[]

IpAddressOrRange

Namn 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

Plats

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). Prioritetsvärden för redundans 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 Bool
locationName Namnet på regionen. sträng

ManagedServiceIdentity

Namn 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"
"UserAssigned"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Microsoft.DocumentDB/databaseAccounts

Namn Beskrivning Värde
identitet Identitet för resursen. ManagedServiceIdentity
sort Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas. "GlobalDocumentDB"
"MongoDB"
"Parsa"
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng

Begränsningar:
Min längd = 3
Maximal längd = 3
Mönster = ^[a-z0-9]+(-[a-z0-9]+)* (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB-databaskonton. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"

PeriodicModeBackupPolicy

Namn Beskrivning Värde
periodicModeProperties Konfigurationsvärden för säkerhetskopiering i periodiskt läge PeriodicModeProperties
typ Beskriver läget för säkerhetskopior. "Periodisk" (krävs)

PeriodicModeProperties

Namn 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äkerhetskopieringshem "Geo"
"Lokal"
"Zon"

RestoreParameters

Namn Beskrivning Värde
databasesToRestore Lista över specifika databaser som är tillgängliga för återställning. DatabaseRestoreResource[]
gremlinDatabasesToRestore Lista över specifika gremlin-databaser som är tillgängliga för återställning. GremlinDatabaseRestoreResource[]
restoreMode Beskriver återställningsläget. "PointInTime"
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till 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
restoreWithTtlDisabled Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. Bool
sourceBackupLocation Platsen för källsäkerhetskopiering för återställning. sträng
tablesToRestore Lista över specifika tabeller som är tillgängliga för återställning. string[]

Taggar

Namn Beskrivning Värde

VirtualNetworkRule

Namn 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. Bool