Share via

Databáze Microsoft.DocumentDBAccounts 2023-03-15-preview

  • Článek

Definice prostředku Bicep

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

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@2023-03-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    analyticalStorageConfiguration: {
      schemaType: 'string'
    }
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      migrationState: {
        startTime: 'string'
        status: 'string'
        targetType: 'string'
      }
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    connectorOffer: 'Small'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: 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: 'PointInTime'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

Objekty BackupPolicy

Nastavte vlastnost type a určete typ objektu.

Pro průběžné použijte:

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

Jako Periodické použijte:

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

Hodnoty vlastností

databaseAccounts

Název Description Hodnota
name Název prostředku string (povinné)

Limit počtu znaků: 3–44

Platné znaky:
Malá písmena, číslice a pomlčky.

Začíná malým písmenem nebo číslicí.

Název prostředku musí být v rámci Azure jedinečný.
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč nejvýše 128 znaků a hodnotu nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů značek a hodnot. Viz Značky v šablonách
Druhu Označuje typ databázového účtu. To se dá nastavit jenom při vytváření účtu databáze. GlobalDocumentDB
MongoDB
'Parse'
identity Identita prostředku. ManagedServiceIdentity
properties Vlastnosti pro vytváření a aktualizaci databázových účtů služby Azure Cosmos DB DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (povinné)

ManagedServiceIdentity

Název Description Hodnota
typ 'Žádný'
'SystemAssigned'
'SystemAssigned,UserAssigned'
UserAssigned: Typ identity použité 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.
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentity

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Název Description 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
zásady zálohování Objekt představující zásadu pro vytváření záloh na účtu. Zásady zálohování
možnosti Seznam možností služby Cosmos DB pro účet Funkce[]
capacity Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu. Kapacita
connectorOffer Typ nabídky konektoru cassandra pro účet C* databáze Cosmos DB. "Malý"
consistencyPolicy Zásady konzistence pro účet služby Cosmos DB. Zásady konzistence
cors Zásady CORS pro účet databáze Cosmos DB. CorsPolicy[]
createMode Výčet označující režim vytváření účtu. Výchozí
PointInTimeRestore
'Obnovit'
databaseAccountOfferType Typ nabídky pro databázi "Standard" (povinné)
defaultIdentity Výchozí identita pro přístup k trezoru klíčů používaná 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
diagnosticLogSettings Objekt představující různá nastavení diagnostického protokolu pro účet služby 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 místní ověřování a zajistěte, aby pro ověřování bylo možné používat výhradně jenom MSI a AAD. bool
enableAnalyticalStorage Příznak označující, jestli se má povolit analýza úložiště. bool
enableAutomaticFailover Povolí automatické převzetí služeb při selhání oblasti zápisu ve vzácném případě, kdy je oblast nedostupná z důvodu výpadku. Automatické převzetí služeb při selhání způsobí 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 Shlukové kapacity 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á povolit MaterializedViews v účtu služby Cosmos DB bool
enableMultipleWriteLocations Umožňuje účtu psát na více místech. bool
enablePartitionMerge Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu bool
ipRules Seznam pravidel IpRules IpAddressOrRange[]
isVirtualNetworkFilterEnabled Příznak označující, jestli se mají povolit nebo zakázat Virtual Network pravidla seznamu ACL. bool
keyVaultKeyUri Identifikátor URI trezoru klíčů řetězec
Umístění Pole, které obsahuje umístění geografické replikace povolená pro účet služby 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 rozhraní API Cassandra a Mongo, která fungují pouze s protokolem TLS 1.2. Tls
Tls11
Tls12
networkAclBypass AzureServices
"Žádné": Označuje, které služby můžou obejít kontroly brány firewall.
networkAclBypassResourceIds Pole, které obsahuje ID prostředků pro obejití seznamu ACL sítě pro účet služby Cosmos DB. string[]
publicNetworkAccess Jestli jsou povolené požadavky z veřejné sítě Zakázáno
Povoleno
obnoveníParameters Parametry označující informace o obnovení. Parametry obnovení
virtualNetworkRules Seznam pravidel seznamu ACL nakonfigurovaných pro účet služby Cosmos DB Virtual Network VirtualNetworkRule[]

AnalyticalStorageConfiguration

Název Description Hodnota
Schematype Popisuje typy schématu pro analytické úložiště. 'Úplná nevěra'
"Dobře definovaný"

Vlastnosti rozhraní API

Název Description Hodnota
Verze serveru Popisuje ServerVersion účtu MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

Zásady zálohování

Název Description Hodnota
migrationState Objekt představující stav migrace mezi zásadami zálohování. BackupPolicyMigrationState
typ Nastavení typu objektu Průběžné
Pravidelné (povinné)

BackupPolicyMigrationState

Název Description Hodnota
startTime Čas, kdy byla zahájena migrace zásad zálohování (formát ISO-8601). řetězec
status Popisuje stav migrace mezi typy zásad zálohování. Dokončeno
Chyba
"Probíhající"
'Neplatné'
Targettype Popisuje typ cílové zásady zálohování migrace zásad zálohování. 'Nepřetržitý'
'Periodický'

ContinuousModeBackupPolicy

Název Description Hodnota
typ Popisuje režim zálohování. Nepřetržitý (povinné)
continuousModeVlastnosti Hodnoty konfigurace pro průběžné zálohování ContinuousModeProperties

ContinuousModeProperties

Název Description Hodnota
tier Výčet označující typ režimu zálohování Continuos 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Název Description Hodnota
typ Popisuje režim zálohování. 'Periodický' (povinné)
periodicModeProperties Hodnoty konfigurace pro zálohování v pravidelném režimu PeriodicModeProperties

PeriodicModeProperties

Název Description Hodnota
backupIntervalInMinutes Celé číslo představující interval mezi dvěma zálohami v minutách int

Omezení:
Minimální hodnota = 0
backupRetentionIntervalInHours Celé číslo představující čas (v hodinách), kdy se jednotlivé zálohy uchovávají int

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

Schopnost

Název Description Hodnota
name Název funkce Cosmos DB Například "name": "EnableCassandra". Aktuální hodnoty také zahrnují EnableTable a EnableGremlin. řetězec

Capacity

Název Description Hodnota
totalThroughputLimit Celkový limit propustnosti stanovený pro účet. TotalThroughputLimit 2000 ukládá striktní limit maximální propustnosti, který se dá pro tento účet zřídit na 2000. Hodnota totalThroughputLimit -1 znamená, že zřizování propustnosti není nijak omezené. int

Zásady konzistence

Název Description Hodnota
výchozí úroveň konzistence Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Případný'
Relace
'Silná' (povinné)
maxIntervalInSeconds Při použití s úrovní konzistence Ohraničená nestarost představuje tato hodnota dobu neschválnosti (v sekundách) tolerovanou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Vyžaduje se, pokud je vlastnost defaultConsistencyPolicy nastavená na hodnotu BoundedStaleness. int

Omezení:
Minimální hodnota = 5
Maximální hodnota = 86400
maxStalenessPrefix Při použití s úrovní konzistence Omezená nestarost představuje tato hodnota počet tolerovaných zastaralých požadavků. Akceptovaná oblast pro tuto hodnotu je 1 –2 147 483 647. Vyžaduje se, pokud je vlastnost defaultConsistencyPolicy nastavená na hodnotu BoundedStaleness. int

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

CorsPolicy

Název Description Hodnota
allowedHeaders Hlavičky požadavku, které může původní doména zadat v požadavku CORS. řetězec
allowedMethods Metody (příkazy požadavku HTTP), které může původní doména používat pro požadavek CORS. řetězec
allowedOrigins Zdrojové 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 požadavek CORS a zpřístupněny prohlížečem vystaviteli požadavku. řetězec
maxAgeInSeconds Maximální doba, po kterou by měl prohlížeč uložit do mezipaměti předběžný požadavek OPTIONS. int

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

DiagnosticLogSettings

Název Description Hodnota
enableFullTextQuery Nepravda
'Žádný'
Pravda: Popište úroveň podrobností, se kterými se mají dotazy protokolovat.

IpAddressOrRange

Název Description Hodnota
ipAddressOrRange Jedna IPv4 adresa nebo jeden rozsah IPv4 adres ve formátu CIDR. Za předpokladu, že IP adresy musí být správně naformátované a nemůžou být obsažené 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 je filtr IP adres neumožňuje vynutit. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8". řetězec

Umístění

Název Description 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 oblast, ve které existuje účet databáze. int

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

Parametry obnovení

Název Description Hodnota
databasesToRestore Seznam konkrétních databází, které jsou k dispozici pro obnovení DatabaseRestoreResource[]
gremlinDatabasesToRestore Seznam konkrétních databází Gremlin, které jsou k dispozici pro obnovení GremlinDatabaseRestoreResource[]
režim obnovení Popisuje režim obnovení. PointInTime
obnovitzdroj ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec
sourceBackupLocation Umístění zdrojové zálohy pro obnovení. řetězec
tablesToRestore Seznam konkrétních tabulek, které jsou k dispozici pro obnovení string[]

DatabaseRestoreResource

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

GremlinDatabaseRestoreResource

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

VirtualNetworkRule

Název Description 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ředtím, než bude mít virtuální síť povolený koncový bod služby virtuální sítě. bool

Šablony pro rychlý start

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

Template (Šablona) Description
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 vašeho nasazení.
Webová aplikace s SQL Database, Azure Cosmos DB, Azure Search

Nasazení do Azure		 Tato šablona zřídí webovou aplikaci, SQL Database, Azure Cosmos DB, Azure Search a Application Insights.
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 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í účtu služby Azure Cosmos DB

Nasazení do Azure		 Cílem této šablony ARM je rychle vytvořit účet Cosmos DB s minimálními požadovanými hodnotami.
Vytvoření účtu služby Azure Cosmos DB v několika 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 volbou úrovně konzistence a typu převzetí služeb při selhání.
Vytvoření účtu služby Azure Cosmos DB úrovně Free

Nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
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 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 s využitím 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 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ý účet Cosmos vystaví virtuální síti.
Vytvoření účtu služby Azure Cosmos DB pro rozhraní Core (SQL) API

Nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem s propustností s několika dalšími možnostmi.
Rozhraní SQL API účtu služby Azure Cosmos DB s analytickým úložištěm

Nasazení do Azure		 Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
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 Služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
Vytvoření uložených procedur rozhraní API 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í 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ň určí pouze minimální požadované vlastnosti prostředku.
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ávat kontejnery s proměnlivou funkcí.
Vytvoření účtu SQL služby Azure Cosmos DB s využitím 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í bezserverového účtu služby Azure Cosmos DB pro rozhraní SQL API

Nasazení do Azure		 Tato šablona vytvoří bezserverový účet Azure Cosmos DB pro rozhraní Core (SQL) API.
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 Azure Cosmos s nulovým dotykem a webové aplikace Azure

Nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos, 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 Cosmos DB s povolenou Microsoft Defender

Nasazení do Azure		 Pomocí této šablony ARM můžete nasadit účet služby Azure Cosmos DB s povoleným Microsoft Defender pro Službu Azure Cosmos DB. Microsoft Defender pro Azure Cosmos DB je vrstva zabezpečení nativní pro Azure, která detekuje pokusy o zneužití databází ve vašich účtech Azure Cosmos DB. Microsoft Defender pro Službu Azure Cosmos DB detekuje potenciální injekty SQL, známé špatné aktéry na základě analýzy hrozeb Microsoftu, podezřelé vzory přístupu a potenciální zneužití databáze prostřednictvím ohrožených identit nebo škodlivých účastníků programu Insider.
Nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB

Nasazení do Azure		 Nasazení Azure Data Explorer DB s připojením ke službě Cosmos DB
Účet služby Azure Cosmos DB s webovou aplikací

Nasazení do Azure		 Tato šablona nasadí účet služby Azure Cosmos DB, plán App Service a vytvoří webovou aplikaci v plánu App Service. Do webové aplikace se také přidají dvě nastavení aplikace, která odkazují na koncový bod účtu služby Azure Cosmos DB. Řešení nasazená do webové aplikace se tak můžou připojit ke koncovému bodu účtu služby Azure Cosmos DB pomocí těchto nastavení.

Definice prostředku šablony ARM

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

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": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "analyticalStorageConfiguration": {
      "schemaType": "string"
    },
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "migrationState": {
        "startTime": "string",
        "status": "string",
        "targetType": "string"
      },
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "connectorOffer": "Small",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "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": "PointInTime",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

Objekty BackupPolicy

Nastavte vlastnost type a určete typ objektu.

Pro průběžné použijte:

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

Jako Periodické použijte:

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

Hodnoty vlastností

databaseAccounts

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts
apiVersion Verze rozhraní API prostředků '2023-03-15-preview'
name Název prostředku string (povinné)

Limit počtu znaků: 3–44

Platné znaky:
Malá písmena, číslice a pomlčky.

Začíná malým písmenem nebo číslicí.

Název prostředku musí být v rámci Azure jedinečný.
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč nejvýše 128 znaků a hodnotu nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů značek a hodnot. Viz Značky v šablonách
Druhu Označuje typ databázového účtu. To se dá nastavit jenom při vytváření účtu databáze. GlobalDocumentDB
MongoDB
'Parse'
identity Identita prostředku. ManagedServiceIdentity
properties Vlastnosti pro vytváření a aktualizaci databázových účtů služby Azure Cosmos DB DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (povinné)

ManagedServiceIdentity

Název Description Hodnota
typ 'Žádný'
'SystemAssigned'
'SystemAssigned,UserAssigned'
UserAssigned: Typ identity použité 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.
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentity

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Název Description 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
zásady zálohování Objekt představující zásadu pro vytváření záloh na účtu. Zásady zálohování
možnosti Seznam možností služby Cosmos DB pro účet Funkce[]
capacity Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu. Kapacita
connectorOffer Typ nabídky konektoru cassandra pro účet C* databáze Cosmos DB. "Malý"
consistencyPolicy Zásady konzistence pro účet služby Cosmos DB. Zásady konzistence
cors Zásady CORS pro účet databáze Cosmos DB. CorsPolicy[]
createMode Výčet označující režim vytváření účtu. Výchozí
PointInTimeRestore
'Obnovit'
databaseAccountOfferType Typ nabídky pro databázi "Standard" (povinné)
defaultIdentity Výchozí identita pro přístup k trezoru klíčů používaná 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
diagnosticLogSettings Objekt představující různá nastavení diagnostického protokolu pro účet služby 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 místní ověřování a zajistěte, aby pro ověřování bylo možné používat výhradně jenom MSI a AAD. bool
enableAnalyticalStorage Příznak označující, jestli se má povolit analýza úložiště. bool
enableAutomaticFailover Povolí automatické převzetí služeb při selhání oblasti zápisu ve vzácném případě, kdy je oblast nedostupná z důvodu výpadku. Automatické převzetí služeb při selhání způsobí 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 Shlukové kapacity Preview v účtu bool
enableCassandraConnector Povolí konektor Cassandra v účtu Cosmos DB C* 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 psát na více místech. bool
enablePartitionMerge Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu bool
pravidla ipRules Seznam pravidel IpRules IpAddressOrRange[]
isVirtualNetworkFilterEnabled Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL Virtual Network. bool
keyVaultKeyUri Identifikátor URI trezoru klíčů řetězec
Umístění Pole, které obsahuje umístění geografické replikace povolená pro účet služby 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 rozhraní API Cassandra a Mongo, která fungují pouze s protokolem TLS 1.2. Tls
Tls11
Tls12
networkAclBypass AzureServices
"Žádné": Označuje, které služby můžou obejít kontroly brány firewall.
networkAclBypassResourceIds Pole, které obsahuje ID prostředků pro obejití seznamu ACL sítě pro účet služby Cosmos DB. string[]
publicNetworkAccess Jestli jsou povolené požadavky z veřejné sítě Zakázáno
Povoleno
obnoveníParameters Parametry označující informace o obnovení. Parametry obnovení
virtualNetworkRules Seznam pravidel seznamu ACL nakonfigurovaných pro účet služby Cosmos DB Virtual Network VirtualNetworkRule[]

AnalyticalStorageConfiguration

Název Description Hodnota
Schematype Popisuje typy schématu pro analytické úložiště. 'Úplná nevěra'
"Dobře definovaný"

Vlastnosti rozhraní API

Název Description Hodnota
Verze serveru Popisuje ServerVersion účtu MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

Zásady zálohování

Název Description Hodnota
migrationState Objekt představující stav migrace mezi zásadami zálohování. BackupPolicyMigrationState
typ Nastavení typu objektu Průběžné
Pravidelné (povinné)

BackupPolicyMigrationState

Název Description Hodnota
startTime Čas, kdy byla zahájena migrace zásad zálohování (formát ISO-8601). řetězec
status Popisuje stav migrace mezi typy zásad zálohování. Dokončeno
Chyba
"Probíhající"
'Neplatné'
Targettype Popisuje typ cílové zásady zálohování migrace zásad zálohování. 'Nepřetržitý'
'Periodický'

ContinuousModeBackupPolicy

Název Description Hodnota
typ Popisuje režim zálohování. Nepřetržitý (povinné)
continuousModeVlastnosti Hodnoty konfigurace pro průběžné zálohování ContinuousModeProperties

ContinuousModeProperties

Název Description Hodnota
tier Výčet označující typ režimu zálohování Continuos 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Název Description Hodnota
typ Popisuje režim zálohování. 'Periodický' (povinné)
periodicModeProperties Hodnoty konfigurace pro zálohování v pravidelném režimu PeriodicModeProperties

PeriodicModeProperties

Název Description Hodnota
backupIntervalInMinutes Celé číslo představující interval mezi dvěma zálohami v minutách int

Omezení:
Minimální hodnota = 0
backupRetentionIntervalInHours Celé číslo představující čas (v hodinách), kdy se jednotlivé zálohy uchovávají int

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

Schopnost

Název Description Hodnota
name Název funkce Cosmos DB Například "name": "EnableCassandra". Aktuální hodnoty také zahrnují EnableTable a EnableGremlin. řetězec

Capacity

Název Description Hodnota
totalThroughputLimit Celkový limit propustnosti stanovený pro účet. TotalThroughputLimit 2000 ukládá striktní limit maximální propustnosti, který se dá pro tento účet zřídit na 2000. Hodnota totalThroughputLimit -1 znamená, že zřizování propustnosti není nijak omezené. int

Zásady konzistence

Název Description Hodnota
výchozí úroveň konzistence Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Případný'
Relace
'Silná' (povinné)
maxIntervalInSeconds Při použití s úrovní konzistence Ohraničená nestarost představuje tato hodnota dobu neschválnosti (v sekundách) tolerovanou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Vyžaduje se, pokud je vlastnost defaultConsistencyPolicy nastavená na hodnotu BoundedStaleness. int

Omezení:
Minimální hodnota = 5
Maximální hodnota = 86400
maxStalenessPrefix Při použití s úrovní konzistence Omezená nestarost představuje tato hodnota počet tolerovaných zastaralých požadavků. Akceptovaná oblast pro tuto hodnotu je 1 –2 147 483 647. Vyžaduje se, pokud je vlastnost defaultConsistencyPolicy nastavená na hodnotu BoundedStaleness. int

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

CorsPolicy

Název Description Hodnota
allowedHeaders Hlavičky požadavku, které může původní doména zadat v požadavku CORS. řetězec
allowedMethods Metody (příkazy požadavku HTTP), které může původní doména používat pro požadavek CORS. řetězec
allowedOrigins Zdrojové 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 požadavek CORS a zpřístupněny prohlížečem vystaviteli požadavku. řetězec
maxAgeInSeconds Maximální doba, po kterou by měl prohlížeč uložit do mezipaměti předběžný požadavek OPTIONS. int

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

DiagnosticLogSettings

Název Description Hodnota
enableFullTextQuery Nepravda
'Žádný'
"True": Popište úroveň podrobností, pomocí kterých se mají dotazy protokolovat.

IpAddressOrRange

Název Description Hodnota
ipAddressOrRange Jedna IPv4 adresa nebo jeden rozsah IPv4 adres ve formátu CIDR. Za předpokladu, že IP adresy musí být správně formátované a nesmí být obsaženy v některém 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 vynucovány filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8". řetězec

Umístění

Název Description Hodnota
failoverPriority Priorita převzetí služeb při selhání pro oblast. 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 oblast, ve které existuje účet databáze. 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

RestoreParameters

Název Description Hodnota
databasesToRestore Seznam konkrétních databází, které jsou k dispozici pro obnovení DatabaseRestoreResource[]
gremlinDatabasesToRestore Seznam konkrétních databází gremlin, které jsou k dispozici pro obnovení GremlinDatabaseRestoreResource[]
restoreMode Popisuje režim obnovení. PointInTime
restoreSource ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec
sourceBackupLocation Umístění zdrojové zálohy pro obnovení. řetězec
tablesToRestore Seznam konkrétních tabulek, které jsou k dispozici pro obnovení string[]

DatabaseRestoreResource

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

GremlinDatabaseRestoreResource

Název Description Hodnota
databaseName Název databáze gremlin, která je k dispozici pro obnovení. řetězec
graphNames Názvy grafů dostupných k obnovení string[]

VirtualNetworkRule

Název Description 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ředtím, než má virtuální síť povolený koncový bod služby virtuální sítě. bool

Šablony pro rychlý start

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

Template (Šablona) Description
CI/CD pomocí 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 sestavování pro vytváření imagí kontejnerů a orchestrace můžete zvýšit rychlost a spolehlivost nasazení.
Webová aplikace s SQL Database, Azure Cosmos DB, Azure Search

Nasazení do Azure		 Tato šablona zřídí webovou aplikaci, SQL Database, Azure Cosmos DB, Azure Search a Application Insights.
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 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í účtu služby Azure CosmosDB

Nasazení do Azure		 Cílem této šablony ARM je rychle vytvořit účet CosmosDB s minimálními požadovanými hodnotami.
Vytvoření účtu služby Azure Cosmos DB v několika 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 volbou úrovně konzistence a typu převzetí služeb při selhání.
Vytvoření účtu Služby Azure Cosmos DB úrovně Free

Nasazení do Azure		 Tato šablona vytvoří účet Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
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 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 s využitím 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 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ý účet Cosmos vystaví virtuální síti.
Vytvoření účtu služby Azure Cosmos DB pro rozhraní Core (SQL) API

Nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem s propustností s několika dalšími možnostmi.
Rozhraní SQL API účtu služby Azure Cosmos DB s analytickým úložištěm

Nasazení do Azure		 Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
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 Služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
Vytvoření uložených procedur rozhraní API 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í 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ň určí pouze minimální požadované vlastnosti prostředku.
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ávat kontejnery s proměnlivou funkcí.
Vytvoření účtu SQL služby Azure Cosmos DB s využitím 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í bezserverového účtu služby Azure Cosmos DB pro rozhraní SQL API

Nasazení do Azure		 Tato šablona vytvoří bezserverový účet Azure Cosmos DB pro rozhraní Core (SQL) API.
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 Azure Cosmos s nulovým dotykem a webové aplikace Azure

Nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos, 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 Cosmos DB s povolenou Microsoft Defender

Nasazení do Azure		 Pomocí této šablony ARM můžete nasadit účet služby Azure Cosmos DB s povoleným Microsoft Defender pro Službu Azure Cosmos DB. Microsoft Defender pro Azure Cosmos DB je vrstva zabezpečení nativní pro Azure, která detekuje pokusy o zneužití databází ve vašich účtech Azure Cosmos DB. Microsoft Defender pro Službu Azure Cosmos DB detekuje potenciální injekty SQL, známé špatné aktéry na základě analýzy hrozeb Microsoftu, podezřelé vzory přístupu a potenciální zneužití databáze prostřednictvím ohrožených identit nebo škodlivých účastníků programu Insider.
Nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB

Nasazení do Azure		 Nasazení Azure Data Explorer DB s připojením ke službě Cosmos DB
Účet služby Azure Cosmos DB s webovou aplikací

Nasazení do Azure		 Tato šablona nasadí účet služby Azure Cosmos DB, plán App Service a vytvoří webovou aplikaci v plánu App Service. Do webové aplikace se také přidají dvě nastavení aplikace, která odkazují na koncový bod účtu služby Azure Cosmos DB. Řešení nasazená do webové aplikace se tak můžou připojit ke koncovému bodu účtu služby Azure Cosmos DB pomocí těchto nastavení.

Definice prostředku Terraformu (zprostředkovatele AzAPI)

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

  • 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@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      connectorOffer = "Small"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = 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 = "PointInTime"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

Objekty BackupPolicy

Nastavte vlastnost type a určete typ objektu.

Pro průběžné použijte:

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

Jako Periodické použijte:

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

Hodnoty vlastností

databaseAccounts

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts@2023-03-15-preview
name Název prostředku string (povinné)

Omezení počtu znaků: 3–44

Platné znaky:
Malá písmena, číslice a pomlčky.

Začíná malým písmenem nebo číslicí.

Název prostředku musí být v rámci Azure jedinečný.
location Umístění skupiny prostředků, do které prostředek patří. řetězec
parent_id K nasazení do skupiny prostředků použijte ID této skupiny prostředků. string (povinné)
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek.
Druhu Označuje typ databázového účtu. Tuto možnost je možné nastavit pouze při vytváření účtu databáze. "GlobalDocumentDB"
"MongoDB"
"Parsovat"
identity Identita prostředku. Identita spravované služby
properties Vlastnosti pro vytvoření a aktualizaci účtů databáze Azure Cosmos DB DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (povinné)

Identita spravované služby

Název Description Hodnota
typ "SystemAssigned"
"SystemAssigned,UserAssigned"
UserAssigned: Typ identity použité 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.
identity_ids Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Pole ID identit uživatelů

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Název Description Hodnota
analyticalStorageConfiguration Vlastnosti specifické pro analytické úložiště. AnalyticalStorageConfiguration
apiVlastnosti Vlastnosti specifické pro rozhraní API. V současné době se podporuje pouze pro rozhraní MongoDB API. Vlastnosti rozhraní API
zásady zálohování Objekt představující zásadu pro vytváření záloh na účtu. Zásady zálohování
možnosti Seznam možností služby Cosmos DB pro účet Schopnost[]
capacity Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu. Kapacita
connectorOffer Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB. "Small"
consistencyPolicy Zásady konzistence pro účet služby Cosmos DB. Zásady konzistence
cors Zásady CORS pro účet databáze Cosmos DB. CorsPolicy[]
createMode Výčet označující režim vytváření účtu. "Výchozí"
"PointInTimeRestore"
"Obnovit"
databaseAccountOfferType Typ nabídky pro databázi "Standard" (povinné)
výchozí identita Výchozí identita pro přístup k trezoru klíčů používaná 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
diagnosticLogSettings Objekt představující různá nastavení diagnostického protokolu pro účet služby Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Zakázání operací zápisu prostředků metadat (databází, kontejnerů, propustnosti) prostřednictvím klíčů účtu bool
disableLocalAuth Odhlaste místní ověřování a zajistěte, aby k ověřování bylo možné používat výhradně jenom MSI a AAD. bool
enableAnalyticalStorage Příznak označující, jestli se má povolit analýza úložiště. bool
enableAutomaticFailover Povolí automatické převzetí služeb při selhání oblasti zápisu ve výjimečném případě, kdy je oblast nedostupná z důvodu 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 Kapacity shlukového škálování ve verzi Preview na účtu bool
enableCassandraConnector Povolí konektor Cassandra v účtu Cosmos DB C* 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 psát na více místech. bool
enablePartitionMerge Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu bool
pravidla ipRules Seznam pravidel IpRules IpAddressOrRange[]
isVirtualNetworkFilterEnabled Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL Virtual Network. bool
keyVaultKeyUri Identifikátor URI trezoru klíčů řetězec
Umístění Pole, které obsahuje umístění geografické replikace povolená pro účet služby 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 rozhraní API Cassandra a Mongo, která fungují pouze s protokolem TLS 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass "AzureServices"
"None": Označuje, které služby můžou obejít kontroly brány firewall.
networkAclBypassResourceIds Pole, které obsahuje ID prostředků pro obejití seznamu ACL sítě pro účet služby Cosmos DB. string[]
publicNetworkAccess Jestli jsou povolené požadavky z veřejné sítě "Zakázáno"
"Povoleno"
obnoveníParameters Parametry označující informace o obnovení. Parametry obnovení
virtualNetworkRules Seznam pravidel seznamu ACL nakonfigurovaných pro účet služby Cosmos DB Virtual Network VirtualNetworkRule[]

AnalyticalStorageConfiguration

Název Description Hodnota
Schematype Popisuje typy schématu pro analytické úložiště. "Úplná nevěra"
"WellDefined"

Vlastnosti rozhraní API

Název Description Hodnota
Verze serveru Popisuje ServerVersion účtu MongoDB. "3.2"
"3.6"
"4.0"
"4.2"

Zásady zálohování

Název Description Hodnota
migrationState Objekt představující stav migrace mezi zásadami zálohování. BackupPolicyMigrationState
typ Nastavení typu objektu Průběžné
Pravidelné (povinné)

BackupPolicyMigrationState

Název Description Hodnota
startTime Čas, kdy byla zahájena migrace zásad zálohování (formát ISO-8601). řetězec
status Popisuje stav migrace mezi typy zásad zálohování. "Dokončeno"
Chyba
"Probíhající"
"Neplatné"
Targettype Popisuje typ cílové zásady zálohování migrace zásad zálohování. "Nepřetržitý"
"Periodické"

ContinuousModeBackupPolicy

Název Description Hodnota
typ Popisuje režim zálohování. "Nepřetržitý" (povinné)
continuousModeVlastnosti Hodnoty konfigurace pro průběžné zálohování ContinuousModeProperties

ContinuousModeProperties

Název Description Hodnota
tier Výčet označující typ režimu zálohování Continuos "Continuous30Days"
"Continuous7Days"

PeriodicModeBackupPolicy

Název Description Hodnota
typ Popisuje režim zálohování. "Periodické" (povinné)
periodicModeProperties Hodnoty konfigurace pro zálohování v pravidelném režimu PeriodicModeProperties

PeriodicModeProperties

Název Description Hodnota
backupIntervalInMinutes Celé číslo představující interval mezi dvěma zálohami v minutách int

Omezení:
Minimální hodnota = 0
backupRetentionIntervalInHours Celé číslo představující čas (v hodinách), kdy se jednotlivé zálohy uchovávají int

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

Schopnost

Název Description Hodnota
name Název funkce Cosmos DB Například "name": "EnableCassandra". Aktuální hodnoty také zahrnují EnableTable a EnableGremlin. řetězec

Capacity

Název Description Hodnota
totalThroughputLimit Celkový limit propustnosti stanovený pro účet. TotalThroughputLimit 2000 ukládá striktní limit maximální propustnosti, který se dá pro tento účet zřídit na 2000. Hodnota totalThroughputLimit -1 znamená, že zřizování propustnosti není nijak omezené. int

Zásady konzistence

Název Description Hodnota
výchozí úroveň konzistence Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"Relace"
"Silná" (povinné)
maxIntervalInSeconds Při použití s úrovní konzistence Ohraničená nestarost představuje tato hodnota dobu neschválnosti (v sekundách) tolerovanou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Vyžaduje se, pokud je vlastnost defaultConsistencyPolicy nastavená na hodnotu BoundedStaleness. int

Omezení:
Minimální hodnota = 5
Maximální hodnota = 86400
maxStalenessPrefix Při použití s úrovní konzistence omezené nestaralosti představuje tato hodnota počet tolerovaných zastaralých požadavků. Akceptovaná oblast pro tuto hodnotu je 1 – 2 147 483 647. Vyžaduje se, pokud je defaultConsistencyPolicy nastavená na BoundedStaleness. int

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

CorsPolicy

Název Description Hodnota
allowedHeaders Hlavičky požadavku, které může původní doména zadat v požadavku CORS. řetězec
allowedMethods Metody (příkazy požadavku HTTP), které může původní doména používat pro požadavek CORS. řetězec
allowedOrigins Původní domény, které mají povoleno 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 požadavek CORS a zpřístupněny prohlížečem vystaviteli požadavku. řetězec
maxAgeInSeconds Maximální doba, po kterou by měl prohlížeč uložit do mezipaměti předběžný požadavek OPTIONS. int

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

DiagnosticLogSettings

Název Description Hodnota
enableFullTextQuery "False"
"Žádné"
"True": Popište úroveň podrobností, pomocí kterých se mají dotazy protokolovat.

IpAddressOrRange

Název Description Hodnota
ipAddressOrRange Jedna IPv4 adresa nebo jeden rozsah IPv4 adres ve formátu CIDR. Za předpokladu, že IP adresy musí být správně formátované a nesmí být obsaženy v některém 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 vynucovány filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8". řetězec

Umístění

Název Description Hodnota
failoverPriority Priorita převzetí služeb při selhání pro oblast. 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 oblast, ve které existuje účet databáze. 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

RestoreParameters

Název Description Hodnota
databasesToRestore Seznam konkrétních databází, které jsou k dispozici pro obnovení DatabaseRestoreResource[]
gremlinDatabasesToRestore Seznam konkrétních databází gremlin, které jsou k dispozici pro obnovení GremlinDatabaseRestoreResource[]
restoreMode Popisuje režim obnovení. "PointInTime"
restoreSource ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec
sourceBackupLocation Umístění zdrojové zálohy pro obnovení. řetězec
tablesToRestore Seznam konkrétních tabulek, které jsou k dispozici pro obnovení string[]

DatabaseRestoreResource

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

GremlinDatabaseRestoreResource

Název Description Hodnota
databaseName Název databáze gremlin, která je k dispozici pro obnovení. řetězec
graphNames Názvy grafů dostupných k obnovení string[]

VirtualNetworkRule

Název Description 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ředtím, než má virtuální síť povolený koncový bod služby virtuální sítě. bool