Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts

  • Článek

Definice prostředku Bicep

Typ prostředku databaseAccounts je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts, přidejte do šablony následující bicep.

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'
  }
}

Objekty BackupPolicy

Nastavte typ vlastnost určit typ objektu.

Pro continuouspoužijte:

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

Pro periodicképoužijte:

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

Hodnoty vlastností

AnalyticalStorageConfiguration

Jméno Popis Hodnota
schemaType Popisuje typy schématu analytického úložiště. "Úplná nevěra"
"WellDefined"

ApiProperties

Jméno Popis Hodnota
serverVersion Popisuje verzi účtu MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

Zásady zálohování

Jméno Popis Hodnota
migrationState Objekt představující stav migrace mezi zásadami zálohování. BackupPolicyMigrationState
typ Pro typ ContinuousModeBackupPolicy nastavte hodnotu ContinuousModeBackupPolicy. Pro typ PeriodicModeBackupPolicyna hodnotu Periodická. "Nepřetržitě"
Periodické (povinné)

BackupPolicyMigrationState

Jméno Popis Hodnota
startTime Čas zahájení migrace zásad zálohování (formát ISO-8601). řetězec
stav Popisuje stav migrace mezi typy zásad zálohování. Dokončeno
Chyba
InProgress
Neplatné
targetType Popisuje typ zásady cílového zálohování migrace zásad zálohování. "Nepřetržitě"
"Periodická"

Schopnost

Jméno Popis Hodnota
Jméno Název funkce Cosmos DB Například "name": "EnableCassandra". Mezi aktuální hodnoty patří také EnableTable a EnableGremlin. řetězec

Kapacita

Jméno Popis Hodnota
totalThroughputLimit Celkový limit propustnosti uložený pro účet. TotalThroughputLimit z roku 2000 ukládá striktní limit maximální propustnosti, kterou je možné zřídit na daném účtu na 2000. Hodnota totalThroughputLimit -1 indikuje žádné limity zřizování propustnosti. Int

Omezení:
Minimální hodnota = -1

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

ConsistencyPolicy

Jméno Popis Hodnota
defaultConsistencyLevel Výchozí úroveň konzistence a nastavení konfigurace účtu cosmos DB. "BoundedStaleness"
'ConsistentPrefix'
"Případná"
Relace
Strong (povinné)
maxIntervalInSeconds Při použití s úrovní konzistence ohraničené nestarosti představuje tato hodnota časovou prodlevu (v sekundách) snášenou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness. Int

Omezení:
Minimální hodnota = 5
Maximální hodnota = 86400
maxStalenessPrefix Pokud se používá s úrovní konzistence konzistence s ohraničenou nestarostí, představuje tato hodnota počet zastaralých požadavků, které jsou tolerovány. Přijatý rozsah pro tuto hodnotu je 1 –2 147 483 647. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2147483647

ContinuousModeBackupPolicy

Jméno Popis Hodnota
continuousModeProperties Hodnoty konfigurace pro průběžné zálohování v režimu continuousModeProperties
typ Popisuje režim zálohování. Průběžné (povinné)

ContinuousModeProperties

Jméno Popis Hodnota
úroveň Výčet označující typ režimu zálohování Continuos Continuous30Days
Continuous7Days

CorsPolicy

Jméno Popis Hodnota
AllowedHeaders Hlavičky požadavku, které může původní doména zadat pro požadavek CORS. řetězec
allowedMethods Metody (příkazy požadavku HTTP), které může původní doména použít pro požadavek CORS. řetězec
allowedOrigins Původní domény, které mají oprávnění podat žádost o službu prostřednictvím CORS. string (povinné)
exposedHeaders Hlavičky odpovědi, které mohou být odeslány v odpovědi na žádost CORS a zpřístupněny prohlížečem vystaviteli požadavku. řetězec
maxAgeInSeconds Maximální doba, po kterou má prohlížeč ukládat předběžný požadavek OPTIONS do mezipaměti. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Jméno Popis Hodnota
analyticalStorageConfiguration Vlastnosti specifické pro analytické úložiště AnalyticalStorageConfiguration
ApiProperties Vlastnosti specifické pro rozhraní API V současné době se podporuje jenom pro rozhraní MongoDB API. apiProperties
backupPolicy Objekt představující zásadu pro zálohování účtu. BackupPolicy
schopnosti Seznam možností služby Cosmos DB pro účet schopností[]
kapacita Objekt, který představuje všechny vlastnosti související s vynucení kapacity u účtu. kapacity
capacityMode Označuje kapacituMode účtu Cosmos DB. None (Žádný)
Zřízeno
Bezserverová
connectorOffer Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB. "Malý"
consistencyPolicy Zásady konzistence pro účet Cosmos DB. ConsistencyPolicy
cors Zásady CORS pro účet databáze Cosmos DB. CorsPolicy[]
createMode Výčet označující režim vytváření účtu. Výchozí
Obnovit
customerManagedKeyStatus Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží. řetězec
databaseAccountOfferType Typ nabídky pro databázi Standard (povinné)
defaultIdentity Výchozí identita pro přístup k trezoru klíčů používaným ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další. řetězec
defaultPriorityLevel Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority. "Vysoká"
"Nízká"
diagnosticLogSettings Objekt představující různá nastavení diagnostického protokolu pro účet Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu Bool
disableLocalAuth Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD. Bool
enableAnalyticalStorage Příznak označující, jestli se má povolit analýza úložiště. Bool
enableAutomaticFailover Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet. Bool
enableBurstCapacity Příznak označující povolení nebo zakázání funkce Burst Capacity Preview v účtu Bool
enableCassandraConnector Povolí konektor Cassandra v účtu C* služby Cosmos DB. Bool
enableFreeTier Příznak označující, jestli je povolená úroveň Free. Bool
enableMaterializedViews Příznak označující, jestli se má v účtu Cosmos DB povolit MaterializedViews Bool
enableMultipleWriteLocations Umožňuje účtu zapisovat do více umístění. Bool
enablePartitionMerge Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu Bool
enablePerRegionPerPartitionAutoscale Příznak označující povolení nebo zakázání Per-Region funkce automatického škálování jednotlivých oddílů v účtu Bool
enablePriorityBasedExecution Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu Bool
IpRules Seznam iprules IpAddressOrRange[]
isVirtualNetworkFilterEnabled Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě. Bool
keyVaultKeyUri Identifikátor URI trezoru klíčů řetězec
Místa Pole obsahující umístění geografického odstranění duplicitních dat povolená pro účet Cosmos DB. umístění[] (povinné)
minimalTlsVersion Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.0 s výjimkou Cassandra a Mongo API, které fungují jenom s protokolem Tls 1.2. Tls
Tls11
Tls12
networkAclBypass Označuje, které služby mají povoleno obejít kontroly brány firewall. AzureServices
None (Žádný)
networkAclBypassResourceIds Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB. string[]
publicNetworkAccess Jestli jsou povolené požadavky z veřejné sítě Zakázáno
Povoleno
SecuredByPerimeter
restoreParameters Parametry označující informace o obnovení RestoreParameters
VirtualNetworkRules Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB VirtualNetworkRule[]

DatabaseRestoreResource

Jméno Popis Hodnota
collectionNames Názvy kolekcí, které jsou k dispozici k obnovení. string[]
databaseName Název databáze, která je k dispozici k obnovení. řetězec

DiagnosticLogSettings

Jméno Popis Hodnota
enableFullTextQuery Popište úroveň podrobností, se kterými dotazy se mají protokolovat. "Nepravda"
None (Žádný)
Pravda

GremlinDatabaseRestoreResource

Jméno Popis Hodnota
databaseName Název databáze Gremlin, která je k dispozici k obnovení. řetězec
graphNames Názvy grafů, které jsou k dispozici pro obnovení. string[]

IpAddressOrRange

Jméno Popis Hodnota
ipAddressOrRange Jedna adresa IPv4 nebo jeden rozsah adres IPv4 ve formátu CIDR. Zadané IP adresy musí být dobře naformátované a nesmí být obsaženy v jednom z následujících rozsahů: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, protože tyto adresy nejsou vynucovatelné filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8". řetězec

Umístění

Jméno Popis Hodnota
failoverPriority Priorita převzetí služeb při selhání oblasti. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet. Int

Omezení:
Minimální hodnota = 0
isZoneRedundant Příznak označující, jestli je tato oblast oblastí AvailabilityZone nebo ne Bool
locationName Název oblasti. řetězec

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts

Jméno Popis Hodnota
identita Identita prostředku ManagedServiceIdentity
laskavý Určuje typ databázového účtu. To lze nastavit pouze při vytváření účtu databáze. GlobalDocumentDB
MongoDB
Parsování
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-z0-9]+(-[a-z0-9]+)* (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci účtů databáze Azure Cosmos DB DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

PeriodicModeBackupPolicy

Jméno Popis Hodnota
periodicModeProperties Hodnoty konfigurace pro pravidelné zálohování v režimu periodicModeProperties
typ Popisuje režim zálohování. Periodické (povinné)

PeriodicModeProperties

Jméno Popis Hodnota
backupIntervalInMinutes Celé číslo představující interval v minutách mezi dvěma zálohami Int

Omezení:
Minimální hodnota = 0
backupRetentionIntervalInHours Celé číslo představující čas (v hodinách), který každá záloha uchovává Int

Omezení:
Minimální hodnota = 0
backupStorageRedundancy Výčet označující typ rezidence zálohování "Geo"
Místní
Zóna

RestoreParameters

Jméno Popis Hodnota
databasesToRestore Seznam konkrétních databází, které jsou k dispozici k obnovení DatabaseRestoreResource[]
gremlinDatabasesToRestore Seznam konkrétních databází Gremlin, které jsou k dispozici k obnovení GremlinDatabaseRestoreResource[]
restoreMode Popisuje režim obnovení. PointInTime
restoreSource ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool
sourceBackupLocation Zdrojové umístění zálohy pro obnovení. řetězec
tablesToRestore Seznam konkrétních tabulek, které jsou k dispozici pro obnovení string[]

Visačky

Jméno Popis Hodnota

VirtualNetworkRule

Jméno Popis Hodnota
id ID prostředku podsítě, například :/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. řetězec
ignoreMissingVNetServiceEndpoint Vytvořte pravidlo brány firewall před povolením koncového bodu služby virtuální sítě. Bool

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ prostředku.

Soubor Bicep Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní API core (SQL) s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
účtu služby Azure Cosmos DB s webové aplikace Tato šablona nasadí účet služby Azure Cosmos DB, plán služby App Service a vytvoří webovou aplikaci v plánu služby App Service. Přidá také dvě nastavení aplikace do webové aplikace, která odkazují na koncový bod účtu služby Azure Cosmos DB. Tímto způsobem se řešení nasazená do webové aplikace můžou pomocí těchto nastavení připojit ke koncovému bodu účtu služby Azure Cosmos DB.
vytvoření účtu cosmos DB s povoleným v programu Microsoft Defender Pomocí této šablony ARM můžete nasadit účet služby Azure Cosmos DB s povoleným programem Microsoft Defender pro službu Azure Cosmos DB. Microsoft Defender pro Azure Cosmos DB je nativní vrstva zabezpečení Azure, která zjišťuje pokusy o zneužití databází v účtech Azure Cosmos DB. Microsoft Defender for Azure Cosmos DB detekuje potenciální injektáže SQL, známé špatné aktéry na základě analýzy hrozeb Microsoftu, vzorů podezřelého přístupu a potenciálního zneužití vaší databáze prostřednictvím ohrožených identit nebo škodlivých účastníků programu Insider.
Vytvoření účtu služby Azure Cosmos DB úrovně Free Tato šablona vytvoří účet služby Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
vytvoření minimálního účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a zároveň zadá jenom minimální požadované vlastnosti prostředku.
vytvoření bezserverového účtu služby Azure Cosmos DB pro rozhraní SQL API Tato šablona vytvoří bezserverový účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API.
Vytvoření účtu Azure Cosmos Cosmos a služby Azure Web App Tato šablona vytvoří účet Azure Cosmos DB, vloží koncový bod a klíče služby Cosmos DB do nastavení webové aplikace Azure a pak nasadí webovou aplikaci ASP MVC z GitHubu.
vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech pomocí sdílené a vyhrazené propustnosti se dvěma kolekcemi.
Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování.
Vytvoření účtu Služby Azure Cosmos pro rozhraní TABLE API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní TABLE API ve dvou oblastech a jednu tabulku se zřízenou propustností.
Vytvoření účtu Služby Azure Cosmos pro rozhraní Table API s automatickým škálováním Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní TABLE API ve dvou oblastech a jednu tabulku s propustností automatického škálování.
vytvoření účtu služby Azure Cosmos DB pro rozhraní API Cassandra Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní API Cassandra ve dvou oblastech s prostorem klíčů a tabulkou s vyhrazenou propustností.
vytvoření účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
vytvoření účtu služby Azure Cosmos DB pro rozhraní Gremlin API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s vyhrazenou propustností.
Vytvoření účtu služby Azure Cosmos DB pro automatické škálování rozhraní Gremlin API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s využitím propustnosti automatického škálování.
vytvoření účtu služby Azure Cosmos DB ve více oblastech Tato šablona vytvoří účet služby Azure Cosmos DB pro libovolný typ rozhraní API databáze s primární a sekundární oblastí s výběrem úrovně konzistence a typu převzetí služeb při selhání.
Vytvoření rozhraní SQL API účtu služby Azure Cosmos DB s automatickým škálováním Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
Vytvoření účtu služby Azure Cosmos DB s privátním koncovým bodem Tato šablona vytvoří účet Cosmos, virtuální síť a privátní koncový bod, který zpřístupňuje účet Cosmos do virtuální sítě.
vytvoření účtu SQL služby Azure Cosmos DB s RBAC roviny dat Tato šablona vytvoří účet SLUŽBY SQL Cosmos, nativně udržovanou definici role a nativně udržované přiřazení role pro identitu AAD.
vytvoření účtu služby Azure CosmosDB Tato šablona ARM má záměr rychle vytvořit účet CosmosDB s minimálními požadovanými hodnotami.
Vytvoření účtu služby Azure Cosmos DB s automatickým škálováním pro rozhraní API Cassandra Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní API Cassandra ve dvou oblastech s prostorem klíčů a tabulkou s propustností automatického škálování.
vytvoření uložených procedur rozhraní API služby Azure Cosmos DB Core (SQL) Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a kontejner s uloženou procedurou, triggerem a uživatelem definovanou funkcí.
vytvoří aplikaci mikroslužeb Dapr pomocí služby Container Apps Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps Vytvořte aplikaci Dapr pub-sub servicebus pomocí Container Apps.
nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB Nasaďte databázi Azure Data Exploreru s připojením ke službě Cosmos DB.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts, přidejte do šablony následující KÓD JSON.

{
  "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"
  }
}

Objekty BackupPolicy

Nastavte typ vlastnost určit typ objektu.

Pro continuouspoužijte:

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

Pro periodicképoužijte:

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

Hodnoty vlastností

AnalyticalStorageConfiguration

Jméno Popis Hodnota
schemaType Popisuje typy schématu analytického úložiště. "Úplná nevěra"
"WellDefined"

ApiProperties

Jméno Popis Hodnota
serverVersion Popisuje verzi účtu MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

Zásady zálohování

Jméno Popis Hodnota
migrationState Objekt představující stav migrace mezi zásadami zálohování. BackupPolicyMigrationState
typ Pro typ ContinuousModeBackupPolicy nastavte hodnotu ContinuousModeBackupPolicy. Pro typ PeriodicModeBackupPolicyna hodnotu Periodická. "Nepřetržitě"
Periodické (povinné)

BackupPolicyMigrationState

Jméno Popis Hodnota
startTime Čas zahájení migrace zásad zálohování (formát ISO-8601). řetězec
stav Popisuje stav migrace mezi typy zásad zálohování. Dokončeno
Chyba
InProgress
Neplatné
targetType Popisuje typ zásady cílového zálohování migrace zásad zálohování. "Nepřetržitě"
"Periodická"

Schopnost

Jméno Popis Hodnota
Jméno Název funkce Cosmos DB Například "name": "EnableCassandra". Mezi aktuální hodnoty patří také EnableTable a EnableGremlin. řetězec

Kapacita

Jméno Popis Hodnota
totalThroughputLimit Celkový limit propustnosti uložený pro účet. TotalThroughputLimit z roku 2000 ukládá striktní limit maximální propustnosti, kterou je možné zřídit na daném účtu na 2000. Hodnota totalThroughputLimit -1 indikuje žádné limity zřizování propustnosti. Int

Omezení:
Minimální hodnota = -1

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

ConsistencyPolicy

Jméno Popis Hodnota
defaultConsistencyLevel Výchozí úroveň konzistence a nastavení konfigurace účtu cosmos DB. "BoundedStaleness"
'ConsistentPrefix'
"Případná"
Relace
Strong (povinné)
maxIntervalInSeconds Při použití s úrovní konzistence ohraničené nestarosti představuje tato hodnota časovou prodlevu (v sekundách) snášenou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness. Int

Omezení:
Minimální hodnota = 5
Maximální hodnota = 86400
maxStalenessPrefix Pokud se používá s úrovní konzistence konzistence s ohraničenou nestarostí, představuje tato hodnota počet zastaralých požadavků, které jsou tolerovány. Přijatý rozsah pro tuto hodnotu je 1 –2 147 483 647. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2147483647

ContinuousModeBackupPolicy

Jméno Popis Hodnota
continuousModeProperties Hodnoty konfigurace pro průběžné zálohování v režimu continuousModeProperties
typ Popisuje režim zálohování. Průběžné (povinné)

ContinuousModeProperties

Jméno Popis Hodnota
úroveň Výčet označující typ režimu zálohování Continuos Continuous30Days
Continuous7Days

CorsPolicy

Jméno Popis Hodnota
AllowedHeaders Hlavičky požadavku, které může původní doména zadat pro požadavek CORS. řetězec
allowedMethods Metody (příkazy požadavku HTTP), které může původní doména použít pro požadavek CORS. řetězec
allowedOrigins Původní domény, které mají oprávnění podat žádost o službu prostřednictvím CORS. string (povinné)
exposedHeaders Hlavičky odpovědi, které mohou být odeslány v odpovědi na žádost CORS a zpřístupněny prohlížečem vystaviteli požadavku. řetězec
maxAgeInSeconds Maximální doba, po kterou má prohlížeč ukládat předběžný požadavek OPTIONS do mezipaměti. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Jméno Popis Hodnota
analyticalStorageConfiguration Vlastnosti specifické pro analytické úložiště AnalyticalStorageConfiguration
ApiProperties Vlastnosti specifické pro rozhraní API V současné době se podporuje jenom pro rozhraní MongoDB API. apiProperties
backupPolicy Objekt představující zásadu pro zálohování účtu. BackupPolicy
schopnosti Seznam možností služby Cosmos DB pro účet schopností[]
kapacita Objekt, který představuje všechny vlastnosti související s vynucení kapacity u účtu. kapacity
capacityMode Označuje kapacituMode účtu Cosmos DB. None (Žádný)
Zřízeno
Bezserverová
connectorOffer Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB. "Malý"
consistencyPolicy Zásady konzistence pro účet Cosmos DB. ConsistencyPolicy
cors Zásady CORS pro účet databáze Cosmos DB. CorsPolicy[]
createMode Výčet označující režim vytváření účtu. Výchozí
Obnovit
customerManagedKeyStatus Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží. řetězec
databaseAccountOfferType Typ nabídky pro databázi Standard (povinné)
defaultIdentity Výchozí identita pro přístup k trezoru klíčů používaným ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další. řetězec
defaultPriorityLevel Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority. "Vysoká"
"Nízká"
diagnosticLogSettings Objekt představující různá nastavení diagnostického protokolu pro účet Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu Bool
disableLocalAuth Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD. Bool
enableAnalyticalStorage Příznak označující, jestli se má povolit analýza úložiště. Bool
enableAutomaticFailover Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet. Bool
enableBurstCapacity Příznak označující povolení nebo zakázání funkce Burst Capacity Preview v účtu Bool
enableCassandraConnector Povolí konektor Cassandra v účtu C* služby Cosmos DB. Bool
enableFreeTier Příznak označující, jestli je povolená úroveň Free. Bool
enableMaterializedViews Příznak označující, jestli se má v účtu Cosmos DB povolit MaterializedViews Bool
enableMultipleWriteLocations Umožňuje účtu zapisovat do více umístění. Bool
enablePartitionMerge Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu Bool
enablePerRegionPerPartitionAutoscale Příznak označující povolení nebo zakázání Per-Region funkce automatického škálování jednotlivých oddílů v účtu Bool
enablePriorityBasedExecution Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu Bool
IpRules Seznam iprules IpAddressOrRange[]
isVirtualNetworkFilterEnabled Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě. Bool
keyVaultKeyUri Identifikátor URI trezoru klíčů řetězec
Místa Pole obsahující umístění geografického odstranění duplicitních dat povolená pro účet Cosmos DB. umístění[] (povinné)
minimalTlsVersion Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.0 s výjimkou Cassandra a Mongo API, které fungují jenom s protokolem Tls 1.2. Tls
Tls11
Tls12
networkAclBypass Označuje, které služby mají povoleno obejít kontroly brány firewall. AzureServices
None (Žádný)
networkAclBypassResourceIds Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB. string[]
publicNetworkAccess Jestli jsou povolené požadavky z veřejné sítě Zakázáno
Povoleno
SecuredByPerimeter
restoreParameters Parametry označující informace o obnovení RestoreParameters
VirtualNetworkRules Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB VirtualNetworkRule[]

DatabaseRestoreResource

Jméno Popis Hodnota
collectionNames Názvy kolekcí, které jsou k dispozici k obnovení. string[]
databaseName Název databáze, která je k dispozici k obnovení. řetězec

DiagnosticLogSettings

Jméno Popis Hodnota
enableFullTextQuery Popište úroveň podrobností, se kterými dotazy se mají protokolovat. "Nepravda"
None (Žádný)
Pravda

GremlinDatabaseRestoreResource

Jméno Popis Hodnota
databaseName Název databáze Gremlin, která je k dispozici k obnovení. řetězec
graphNames Názvy grafů, které jsou k dispozici pro obnovení. string[]

IpAddressOrRange

Jméno Popis Hodnota
ipAddressOrRange Jedna adresa IPv4 nebo jeden rozsah adres IPv4 ve formátu CIDR. Zadané IP adresy musí být dobře naformátované a nesmí být obsaženy v jednom z následujících rozsahů: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, protože tyto adresy nejsou vynucovatelné filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8". řetězec

Umístění

Jméno Popis Hodnota
failoverPriority Priorita převzetí služeb při selhání oblasti. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet. Int

Omezení:
Minimální hodnota = 0
isZoneRedundant Příznak označující, jestli je tato oblast oblastí AvailabilityZone nebo ne Bool
locationName Název oblasti. řetězec

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2024-12-01-preview
identita Identita prostředku ManagedServiceIdentity
laskavý Určuje typ databázového účtu. To lze nastavit pouze při vytváření účtu databáze. GlobalDocumentDB
MongoDB
Parsování
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-z0-9]+(-[a-z0-9]+)* (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci účtů databáze Azure Cosmos DB DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

Jméno Popis Hodnota
periodicModeProperties Hodnoty konfigurace pro pravidelné zálohování v režimu periodicModeProperties
typ Popisuje režim zálohování. Periodické (povinné)

PeriodicModeProperties

Jméno Popis Hodnota
backupIntervalInMinutes Celé číslo představující interval v minutách mezi dvěma zálohami Int

Omezení:
Minimální hodnota = 0
backupRetentionIntervalInHours Celé číslo představující čas (v hodinách), který každá záloha uchovává Int

Omezení:
Minimální hodnota = 0
backupStorageRedundancy Výčet označující typ rezidence zálohování "Geo"
Místní
Zóna

RestoreParameters

Jméno Popis Hodnota
databasesToRestore Seznam konkrétních databází, které jsou k dispozici k obnovení DatabaseRestoreResource[]
gremlinDatabasesToRestore Seznam konkrétních databází Gremlin, které jsou k dispozici k obnovení GremlinDatabaseRestoreResource[]
restoreMode Popisuje režim obnovení. PointInTime
restoreSource ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool
sourceBackupLocation Zdrojové umístění zálohy pro obnovení. řetězec
tablesToRestore Seznam konkrétních tabulek, které jsou k dispozici pro obnovení string[]

Visačky

Jméno Popis Hodnota

VirtualNetworkRule

Jméno Popis Hodnota
id ID prostředku podsítě, například :/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. řetězec
ignoreMissingVNetServiceEndpoint Vytvořte pravidlo brány firewall před povolením koncového bodu služby virtuální sítě. Bool

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště

nasazení do Azure		 Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní API core (SQL) s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
účtu služby Azure Cosmos DB s webové aplikace

nasazení do Azure		 Tato šablona nasadí účet služby Azure Cosmos DB, plán služby App Service a vytvoří webovou aplikaci v plánu služby App Service. Přidá také dvě nastavení aplikace do webové aplikace, která odkazují na koncový bod účtu služby Azure Cosmos DB. Tímto způsobem se řešení nasazená do webové aplikace můžou pomocí těchto nastavení připojit ke koncovému bodu účtu služby Azure Cosmos DB.
CI/CD s využitím Jenkinse ve službě Azure Container Service (AKS)

nasazení do Azure		 Kontejnery usnadňují průběžné sestavování a nasazování aplikací. Orchestrací nasazení těchto kontejnerů pomocí Kubernetes ve službě Azure Container Service můžete dosáhnout replikovatelných a spravovatelných clusterů kontejnerů. Nastavením průběžného sestavení pro vytváření imagí kontejnerů a orchestrace můžete zvýšit rychlost a spolehlivost nasazení.
vytvoření účtu cosmos DB s povoleným v programu Microsoft Defender

nasazení do Azure		 Pomocí této šablony ARM můžete nasadit účet služby Azure Cosmos DB s povoleným programem Microsoft Defender pro službu Azure Cosmos DB. Microsoft Defender pro Azure Cosmos DB je nativní vrstva zabezpečení Azure, která zjišťuje pokusy o zneužití databází v účtech Azure Cosmos DB. Microsoft Defender for Azure Cosmos DB detekuje potenciální injektáže SQL, známé špatné aktéry na základě analýzy hrozeb Microsoftu, vzorů podezřelého přístupu a potenciálního zneužití vaší databáze prostřednictvím ohrožených identit nebo škodlivých účastníků programu Insider.
Vytvoření účtu služby Azure Cosmos DB úrovně Free

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
vytvoření minimálního účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a zároveň zadá jenom minimální požadované vlastnosti prostředku.
vytvoření bezserverového účtu služby Azure Cosmos DB pro rozhraní SQL API

nasazení do Azure		 Tato šablona vytvoří bezserverový účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API.
Vytvoření účtu Azure Cosmos Cosmos a služby Azure Web App

nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos DB, vloží koncový bod a klíče služby Cosmos DB do nastavení webové aplikace Azure a pak nasadí webovou aplikaci ASP MVC z GitHubu.
vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech pomocí sdílené a vyhrazené propustnosti se dvěma kolekcemi.
Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování.
Vytvoření účtu Služby Azure Cosmos pro rozhraní TABLE API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní TABLE API ve dvou oblastech a jednu tabulku se zřízenou propustností.
Vytvoření účtu Služby Azure Cosmos pro rozhraní Table API s automatickým škálováním

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní TABLE API ve dvou oblastech a jednu tabulku s propustností automatického škálování.
vytvoření účtu služby Azure Cosmos DB pro rozhraní API Cassandra

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní API Cassandra ve dvou oblastech s prostorem klíčů a tabulkou s vyhrazenou propustností.
vytvoření účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API

nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
vytvoření účtu služby Azure Cosmos DB pro rozhraní Gremlin API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s vyhrazenou propustností.
Vytvoření účtu služby Azure Cosmos DB pro automatické škálování rozhraní Gremlin API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní Gremlin API ve dvou oblastech s jednou databází a jedním grafem s využitím propustnosti automatického škálování.
vytvoření účtu služby Azure Cosmos DB ve více oblastech

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro libovolný typ rozhraní API databáze s primární a sekundární oblastí s výběrem úrovně konzistence a typu převzetí služeb při selhání.
Vytvoření rozhraní SQL API účtu služby Azure Cosmos DB s automatickým škálováním

nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
Vytvoření účtu služby Azure Cosmos DB s privátním koncovým bodem

nasazení do Azure		 Tato šablona vytvoří účet Cosmos, virtuální síť a privátní koncový bod, který zpřístupňuje účet Cosmos do virtuální sítě.
vytvoření účtu SQL služby Azure Cosmos DB s RBAC roviny dat

nasazení do Azure		 Tato šablona vytvoří účet SLUŽBY SQL Cosmos, nativně udržovanou definici role a nativně udržované přiřazení role pro identitu AAD.
vytvoření účtu služby Azure CosmosDB

nasazení do Azure		 Tato šablona ARM má záměr rychle vytvořit účet CosmosDB s minimálními požadovanými hodnotami.
Vytvoření účtu služby Azure Cosmos DB s automatickým škálováním pro rozhraní API Cassandra

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní API Cassandra ve dvou oblastech s prostorem klíčů a tabulkou s propustností automatického škálování.
vytvoření uložených procedur rozhraní API služby Azure Cosmos DB Core (SQL)

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a kontejner s uloženou procedurou, triggerem a uživatelem definovanou funkcí.
vytvoření služby Azure Cosmos s využitím rozhraní SQL API a několika kontejnerů

nasazení do Azure		 Šablona vytvoří kontejner Cosmos s rozhraním SQL API a umožňuje přidávání mulitple kontejnerů.
vytvoří aplikaci mikroslužeb Dapr pomocí služby Container Apps

nasazení do Azure		 Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps

nasazení do Azure		 Vytvořte aplikaci Dapr pub-sub servicebus pomocí Container Apps.
nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB

nasazení do Azure		 Nasaďte databázi Azure Data Exploreru s připojením ke službě Cosmos DB.
webovou aplikaci se službou SQL Database, Azure Cosmos DB, službou Azure Search

nasazení do Azure		 Tato šablona zřídí webovou aplikaci, službu SQL Database, Azure Cosmos DB, Azure Search a Application Insights.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts, přidejte do šablony následující Terraform.

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
        }
      ]
    }
  })
}

Objekty BackupPolicy

Nastavte typ vlastnost určit typ objektu.

Pro continuouspoužijte:

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

Pro periodicképoužijte:

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

Hodnoty vlastností

AnalyticalStorageConfiguration

Jméno Popis Hodnota
schemaType Popisuje typy schématu analytického úložiště. "Úplná nevěra"
"WellDefined"

ApiProperties

Jméno Popis Hodnota
serverVersion Popisuje verzi účtu MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

Zásady zálohování

Jméno Popis Hodnota
migrationState Objekt představující stav migrace mezi zásadami zálohování. BackupPolicyMigrationState
typ Pro typ ContinuousModeBackupPolicy nastavte hodnotu ContinuousModeBackupPolicy. Pro typ PeriodicModeBackupPolicyna hodnotu Periodická. "Nepřetržitě"
Periodické (povinné)

BackupPolicyMigrationState

Jméno Popis Hodnota
startTime Čas zahájení migrace zásad zálohování (formát ISO-8601). řetězec
stav Popisuje stav migrace mezi typy zásad zálohování. Dokončeno
Chyba
InProgress
Neplatné
targetType Popisuje typ zásady cílového zálohování migrace zásad zálohování. "Nepřetržitě"
"Periodická"

Schopnost

Jméno Popis Hodnota
Jméno Název funkce Cosmos DB Například "name": "EnableCassandra". Mezi aktuální hodnoty patří také EnableTable a EnableGremlin. řetězec

Kapacita

Jméno Popis Hodnota
totalThroughputLimit Celkový limit propustnosti uložený pro účet. TotalThroughputLimit z roku 2000 ukládá striktní limit maximální propustnosti, kterou je možné zřídit na daném účtu na 2000. Hodnota totalThroughputLimit -1 indikuje žádné limity zřizování propustnosti. Int

Omezení:
Minimální hodnota = -1

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

ConsistencyPolicy

Jméno Popis Hodnota
defaultConsistencyLevel Výchozí úroveň konzistence a nastavení konfigurace účtu cosmos DB. "BoundedStaleness"
'ConsistentPrefix'
"Případná"
Relace
Strong (povinné)
maxIntervalInSeconds Při použití s úrovní konzistence ohraničené nestarosti představuje tato hodnota časovou prodlevu (v sekundách) snášenou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness. Int

Omezení:
Minimální hodnota = 5
Maximální hodnota = 86400
maxStalenessPrefix Pokud se používá s úrovní konzistence konzistence s ohraničenou nestarostí, představuje tato hodnota počet zastaralých požadavků, které jsou tolerovány. Přijatý rozsah pro tuto hodnotu je 1 –2 147 483 647. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2147483647

ContinuousModeBackupPolicy

Jméno Popis Hodnota
continuousModeProperties Hodnoty konfigurace pro průběžné zálohování v režimu continuousModeProperties
typ Popisuje režim zálohování. Průběžné (povinné)

ContinuousModeProperties

Jméno Popis Hodnota
úroveň Výčet označující typ režimu zálohování Continuos Continuous30Days
Continuous7Days

CorsPolicy

Jméno Popis Hodnota
AllowedHeaders Hlavičky požadavku, které může původní doména zadat pro požadavek CORS. řetězec
allowedMethods Metody (příkazy požadavku HTTP), které může původní doména použít pro požadavek CORS. řetězec
allowedOrigins Původní domény, které mají oprávnění podat žádost o službu prostřednictvím CORS. string (povinné)
exposedHeaders Hlavičky odpovědi, které mohou být odeslány v odpovědi na žádost CORS a zpřístupněny prohlížečem vystaviteli požadavku. řetězec
maxAgeInSeconds Maximální doba, po kterou má prohlížeč ukládat předběžný požadavek OPTIONS do mezipaměti. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Jméno Popis Hodnota
analyticalStorageConfiguration Vlastnosti specifické pro analytické úložiště AnalyticalStorageConfiguration
ApiProperties Vlastnosti specifické pro rozhraní API V současné době se podporuje jenom pro rozhraní MongoDB API. apiProperties
backupPolicy Objekt představující zásadu pro zálohování účtu. BackupPolicy
schopnosti Seznam možností služby Cosmos DB pro účet schopností[]
kapacita Objekt, který představuje všechny vlastnosti související s vynucení kapacity u účtu. kapacity
capacityMode Označuje kapacituMode účtu Cosmos DB. None (Žádný)
Zřízeno
Bezserverová
connectorOffer Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB. "Malý"
consistencyPolicy Zásady konzistence pro účet Cosmos DB. ConsistencyPolicy
cors Zásady CORS pro účet databáze Cosmos DB. CorsPolicy[]
createMode Výčet označující režim vytváření účtu. Výchozí
Obnovit
customerManagedKeyStatus Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží. řetězec
databaseAccountOfferType Typ nabídky pro databázi Standard (povinné)
defaultIdentity Výchozí identita pro přístup k trezoru klíčů používaným ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další. řetězec
defaultPriorityLevel Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority. "Vysoká"
"Nízká"
diagnosticLogSettings Objekt představující různá nastavení diagnostického protokolu pro účet Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu Bool
disableLocalAuth Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD. Bool
enableAnalyticalStorage Příznak označující, jestli se má povolit analýza úložiště. Bool
enableAutomaticFailover Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet. Bool
enableBurstCapacity Příznak označující povolení nebo zakázání funkce Burst Capacity Preview v účtu Bool
enableCassandraConnector Povolí konektor Cassandra v účtu C* služby Cosmos DB. Bool
enableFreeTier Příznak označující, jestli je povolená úroveň Free. Bool
enableMaterializedViews Příznak označující, jestli se má v účtu Cosmos DB povolit MaterializedViews Bool
enableMultipleWriteLocations Umožňuje účtu zapisovat do více umístění. Bool
enablePartitionMerge Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu Bool
enablePerRegionPerPartitionAutoscale Příznak označující povolení nebo zakázání Per-Region funkce automatického škálování jednotlivých oddílů v účtu Bool
enablePriorityBasedExecution Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu Bool
IpRules Seznam iprules IpAddressOrRange[]
isVirtualNetworkFilterEnabled Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě. Bool
keyVaultKeyUri Identifikátor URI trezoru klíčů řetězec
Místa Pole obsahující umístění geografického odstranění duplicitních dat povolená pro účet Cosmos DB. umístění[] (povinné)
minimalTlsVersion Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.0 s výjimkou Cassandra a Mongo API, které fungují jenom s protokolem Tls 1.2. Tls
Tls11
Tls12
networkAclBypass Označuje, které služby mají povoleno obejít kontroly brány firewall. AzureServices
None (Žádný)
networkAclBypassResourceIds Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB. string[]
publicNetworkAccess Jestli jsou povolené požadavky z veřejné sítě Zakázáno
Povoleno
SecuredByPerimeter
restoreParameters Parametry označující informace o obnovení RestoreParameters
VirtualNetworkRules Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB VirtualNetworkRule[]

DatabaseRestoreResource

Jméno Popis Hodnota
collectionNames Názvy kolekcí, které jsou k dispozici k obnovení. string[]
databaseName Název databáze, která je k dispozici k obnovení. řetězec

DiagnosticLogSettings

Jméno Popis Hodnota
enableFullTextQuery Popište úroveň podrobností, se kterými dotazy se mají protokolovat. "Nepravda"
None (Žádný)
Pravda

GremlinDatabaseRestoreResource

Jméno Popis Hodnota
databaseName Název databáze Gremlin, která je k dispozici k obnovení. řetězec
graphNames Názvy grafů, které jsou k dispozici pro obnovení. string[]

IpAddressOrRange

Jméno Popis Hodnota
ipAddressOrRange Jedna adresa IPv4 nebo jeden rozsah adres IPv4 ve formátu CIDR. Zadané IP adresy musí být dobře naformátované a nesmí být obsaženy v jednom z následujících rozsahů: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, protože tyto adresy nejsou vynucovatelné filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8". řetězec

Umístění

Jméno Popis Hodnota
failoverPriority Priorita převzetí služeb při selhání oblasti. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet. Int

Omezení:
Minimální hodnota = 0
isZoneRedundant Příznak označující, jestli je tato oblast oblastí AvailabilityZone nebo ne Bool
locationName Název oblasti. řetězec

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts

Jméno Popis Hodnota
identita Identita prostředku ManagedServiceIdentity
laskavý Určuje typ databázového účtu. To lze nastavit pouze při vytváření účtu databáze. GlobalDocumentDB
MongoDB
Parsování
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-z0-9]+(-[a-z0-9]+)* (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci účtů databáze Azure Cosmos DB DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview

PeriodicModeBackupPolicy

Jméno Popis Hodnota
periodicModeProperties Hodnoty konfigurace pro pravidelné zálohování v režimu periodicModeProperties
typ Popisuje režim zálohování. Periodické (povinné)

PeriodicModeProperties

Jméno Popis Hodnota
backupIntervalInMinutes Celé číslo představující interval v minutách mezi dvěma zálohami Int

Omezení:
Minimální hodnota = 0
backupRetentionIntervalInHours Celé číslo představující čas (v hodinách), který každá záloha uchovává Int

Omezení:
Minimální hodnota = 0
backupStorageRedundancy Výčet označující typ rezidence zálohování "Geo"
Místní
Zóna

RestoreParameters

Jméno Popis Hodnota
databasesToRestore Seznam konkrétních databází, které jsou k dispozici k obnovení DatabaseRestoreResource[]
gremlinDatabasesToRestore Seznam konkrétních databází Gremlin, které jsou k dispozici k obnovení GremlinDatabaseRestoreResource[]
restoreMode Popisuje režim obnovení. PointInTime
restoreSource ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool
sourceBackupLocation Zdrojové umístění zálohy pro obnovení. řetězec
tablesToRestore Seznam konkrétních tabulek, které jsou k dispozici pro obnovení string[]

Visačky

Jméno Popis Hodnota

VirtualNetworkRule

Jméno Popis Hodnota
id ID prostředku podsítě, například :/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. řetězec
ignoreMissingVNetServiceEndpoint Vytvořte pravidlo brány firewall před povolením koncového bodu služby virtuální sítě. Bool