Databáze Microsoft.DocumentDBAccounts 2021-07-01-preview
- Latest (Nejnovější)
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Definice prostředku Bicep
Typ prostředku databaseAccounts je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení 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í bicep.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-07-01-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'
}
]
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
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
restoreMode: 'PointInTime'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
}
Objekty BackupPolicy
Nastavte vlastnost type a určete typ objektu.
Pro průběžné použijte:
type: 'Continuous'
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 | 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. | 'Žádný' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| 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[] |
| 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í Obnovení (povinné) |
| 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 |
| enableCassandraConnector | Povolí konektor cassandra v účtu C* služby Cosmos DB. | bool |
| enableFreeTier | Příznak označující, jestli je povolená úroveň Free. | bool |
| enableMultipleWriteLocations | Umožňuje účtu psát na více místech. | bool |
| ipRules | Seznam pravidel 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 |
| Umístění | Pole obsahující umístění geografické replikace povolená pro účet služby Cosmos DB. | Umístění[] (povinné) |
| networkAclBypass | Určuje, které služby můžou obejít kontroly brány firewall. | AzureServices 'Žádný' |
| networkAclBypassResourceIds | Pole, které obsahuje ID prostředků pro vynechání 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 virtuální sítě nakonfigurovaných pro účet služby Cosmos DB | 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' |
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é) |
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 |
Zásady konzistence
| Název | Description | Hodnota |
|---|---|---|
| defaultConsistencyLevel | Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB. | 'BoundedStaleness' 'ConsistentPrefix' 'Eventual' (Případný) 'Relace' 'Silný' (povinné) |
| maxIntervalInSeconds | Při použití s úrovní konzistence ohraničené neagreseness představuje tato hodnota množství doby neagrese (v sekundách) tolerované. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Vyžaduje se, pokud je defaultConsistencyPolicy nastavená na 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 | Popište úroveň podrobností, pomocí kterých se mají dotazy protokolovat. | Nepravda 'Žádný' "Pravda" |
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[] |
| 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 |
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 |
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) |
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 se službou SQL Database, Azure Cosmos DB, Azure Search |
Tato šablona zřídí webovou aplikaci, službu SQL Database, Azure Cosmos DB, Azure Search a Application Insights. |
| 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 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í účtu služby Azure CosmosDB |
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 |
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 |
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 |
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 pro 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é 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 DB s privátním koncovým bodem |
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 |
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 |
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 |
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) |
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 |
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ů |
Š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 |
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 |
Tato šablona vytvoří bezserverový účet Azure Cosmos DB pro rozhraní Core (SQL) API. |
| 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 Azure Cosmos s nulovým dotykem a webové aplikace 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 povoleným Microsoft Defenderem |
Pomocí této šablony ARM můžete nasadit účet služby Azure Cosmos DB s povoleným Microsoft Defenderem pro Službu Azure Cosmos DB. Microsoft Defender for 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 Azure Cosmos DB detekuje potenciální injektáže SQL, známé chybné aktéry na základě analýzy hrozeb Microsoftu, podezřelých vzorů přístupu a potenciálního zneužití databáze prostřednictvím ohrožených identit nebo škodlivých insiderů. |
| Nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB |
Nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB |
| Účet služby Azure Cosmos DB s webovou aplikací |
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. 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 pomocí těchto nastavení připojit ke koncovému bodu účtu služby Azure Cosmos DB. |
Definice prostředku šablony ARM
Typ prostředku databaseAccounts je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin 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í kód JSON.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2021-07-01-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"
}
],
"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",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"restoreMode": "PointInTime",
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
}
}
Objekty BackupPolicy
Nastavte vlastnost type a určete typ objektu.
V případě průběžného použijte:
"type": "Continuous"
V případě pravidelného použití:
"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ředku | 2021-07-01-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 |
| 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. Zobrazit značky v šablonách |
| 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 | 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. | 'Žádný' 'SystemAssigned' 'SystemAssigned,UserAssigned' UserAssigned |
| 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 |
| 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 | Funkce[] |
| 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í Obnovení (povinné) |
| 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 |
| enableCassandraConnector | Povolí konektor cassandra v účtu C* služby Cosmos DB. | bool |
| enableFreeTier | Příznak označující, jestli je povolená úroveň Free. | bool |
| enableMultipleWriteLocations | Umožňuje účtu psát na více místech. | bool |
| ipRules | Seznam pravidel 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 |
| Umístění | Pole obsahující umístění geografické replikace povolená pro účet služby Cosmos DB. | Umístění[] (povinné) |
| networkAclBypass | Určuje, které služby můžou obejít kontroly brány firewall. | AzureServices 'Žádný' |
| networkAclBypassResourceIds | Pole, které obsahuje ID prostředků pro vynechání 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' |
| restoreParameters | Parametry označující informace o obnovení. | RestoreParameters |
| virtualNetworkRules | Seznam pravidel seznamu ACL virtuální sítě nakonfigurovaných pro účet Služby Cosmos DB | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Název | Description | Hodnota |
|---|---|---|
| Schematype | Popisuje typy schématu pro analytické úložiště. | "Úplná nevěra" 'WellDefined' |
ApiProperties
| Název | Description | Hodnota |
|---|---|---|
| verze serveru | Popisuje ServerVersion účtu MongoDB. | '3.2' '3.6' '4.0' |
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é) |
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 |
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 | 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 | Popište úroveň podrobností, pomocí kterých se mají dotazy protokolovat. | Nepravda 'Žádný' "Pravda" |
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[] |
| 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 |
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 |
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) |
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 se službou SQL Database, Azure Cosmos DB, Azure Search |
Tato šablona zřídí webovou aplikaci, službu SQL Database, Azure Cosmos DB, Azure Search a Application Insights. |
| 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 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í účtu služby Azure CosmosDB |
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 |
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 |
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 |
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 pro 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é 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 DB s privátním koncovým bodem |
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 |
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 |
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 |
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) |
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 |
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ů |
Š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 |
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 |
Tato šablona vytvoří bezserverový účet Azure Cosmos DB pro rozhraní Core (SQL) API. |
| 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 Azure Cosmos s nulovým dotykem a webové aplikace 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 povoleným Microsoft Defenderem |
Pomocí této šablony ARM můžete nasadit účet služby Azure Cosmos DB s povoleným Microsoft Defenderem pro Službu Azure Cosmos DB. Microsoft Defender for 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 for Azure Cosmos DB detekuje potenciální injektáže 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í Služby Azure Data Explorer DB s připojením ke službě Cosmos DB |
| Účet služby Azure Cosmos DB s webovou aplikací |
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. 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@2021-07-01-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"
}
]
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
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
restoreMode = "PointInTime"
restoreSource = "string"
restoreTimestampInUtc = "string"
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
kind = "string"
})
}
Objekty BackupPolicy
Nastavte vlastnost type a určete typ objektu.
Pro průběžné použijte:
type = "Continuous"
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@2021-07-01-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 | 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. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| 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[] |
| 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í" "Obnovit" (povinné) |
| 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 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 |
| enableCassandraConnector | Povolí konektor cassandra v účtu C* služby Cosmos DB. | bool |
| enableFreeTier | Příznak označující, jestli je povolená úroveň Free. | bool |
| enableMultipleWriteLocations | Umožňuje účtu psát na více místech. | bool |
| ipRules | Seznam pravidel 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 |
| Umístění | Pole obsahující umístění geografické replikace povolená pro účet služby Cosmos DB. | Umístění[] (povinné) |
| networkAclBypass | Určuje, které služby můžou obejít kontroly brány firewall. | "AzureServices" "Žádné" |
| networkAclBypassResourceIds | Pole, které obsahuje ID prostředků pro vynechání 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" |
| restoreParameters | Parametry označující informace o obnovení. | RestoreParameters |
| virtualNetworkRules | Seznam pravidel seznamu ACL virtuální sítě nakonfigurovaných pro účet Služby Cosmos DB | VirtualNetworkRule[] |
AnalyticalStorageConfiguration
| Název | Description | Hodnota |
|---|---|---|
| Schematype | Popisuje typy schématu pro analytické úložiště. | "FullFidelity" "WellDefined" |
ApiProperties
| Název | Description | Hodnota |
|---|---|---|
| verze serveru | Popisuje ServerVersion účtu MongoDB. | "3.2" "3.6" "4.0" |
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 zahájení 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" "Selhalo" "InProgress" "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é) |
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 v minutách mezi dvěma zálohami | int Omezení: Minimální hodnota = 0 |
| backupRetentionIntervalInHours | Celé číslo představující čas (v hodinách), kdy se 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" |
Schopnost
| Název | Description | Hodnota |
|---|---|---|
| name | Název funkce Cosmos DB. Například "name": "EnableCassandra". Mezi aktuální hodnoty patří také "EnableTable" a "EnableGremlin". | řetězec |
Zásady konzistence
| Název | Description | Hodnota |
|---|---|---|
| defaultConsistencyLevel | 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é neagreseness představuje tato hodnota množství doby neagrese (v sekundách) tolerované. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Vyžaduje se, pokud je defaultConsistencyPolicy nastavená na 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 | Popište úroveň podrobností, pomocí kterých se mají dotazy protokolovat. | "False" "Žádné" "Pravda" |
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[] |
| 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 |
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 |
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 |