Database Microsoft.DocumentDBAccounts 2021-03-01-preview

Definisi sumber daya Bicep

Jenis sumber daya databaseAccounts dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Contoh Penggunaan

Sampel Bicep

Contoh dasar penerapan Akun CosmosDB (secara resmi DocumentDB).

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'BoundedStaleness'
      maxIntervalInSeconds: 10
      maxStalenessPrefix: 200
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

Modul Terverifikasi Azure

Modul Terverifikasi Azure berikut dapat digunakan untuk menyebarkan jenis sumber daya ini.

Module Description
Akun Database Cosmos DB Modul Sumber Daya AVM untuk Akun Database Cosmos DB

Sampel Mulai Cepat Azure

Templat Mulai Cepat Azure berikut berisi sampel Bicep untuk menyebarkan jenis sumber daya ini.

File Bisep Description
Azure API SQL akun Cosmos DB dengan penyimpanan analitik Templat ini membuat akun Azure Cosmos untuk API Inti (SQL) dengan database dan kontainer yang dikonfigurasi dengan penyimpanan analitik.
Azure Akun Cosmos DB dengan Aplikasi Web Templat ini menyebarkan akun Azure Cosmos DB, Paket App Service, dan membuat Aplikasi Web di Paket App Service. Ini juga menambahkan dua pengaturan Aplikasi ke Aplikasi Web yang mereferensikan titik akhir akun Azure Cosmos DB. Dengan cara ini, solusi yang disebarkan ke Aplikasi Web dapat terhubung ke titik akhir akun Azure Cosmos DB menggunakan pengaturan tersebut.
Buat akun Cosmos DB dengan Microsoft Defender diaktifkan Dengan menggunakan templat ARM ini, Anda dapat menyebarkan akun Azure Cosmos DB dengan Microsoft Defender untuk Azure Cosmos DB diaktifkan. Microsoft Defender untuk Azure Cosmos DB adalah lapisan keamanan asli Azure yang mendeteksi upaya untuk mengeksploitasi database di akun Azure Cosmos DB Anda. Microsoft Defender Azure Cosmos DB mendeteksi potensi injeksi SQL, aktor jahat yang diketahui berdasarkan Microsoft Threat Intelligence, pola access yang mencurigakan, dan potensi eksploitasi database Anda melalui identitas yang disusupi atau orang dalam yang berbahaya.
Buat akun Cosmos DB tingkat gratis Azure Templat ini membuat akun Azure Cosmos DB tingkat bebas untuk SQL API dengan database dengan throughput dan kontainer bersama.
Buat akun Cosmos DB Azure minimal untuk Core (SQL) API Templat ini membuat akun Azure Cosmos DB untuk API Inti (SQL) sambil hanya menentukan properti sumber daya minimal yang diperlukan.
Buat akun Cosmos DB Azure Nirserver untuk SQL API Templat ini membuat akun Azure Cosmos DB tanpa server untuk API Inti (SQL).
Buat akun Cosmos tanpa sentuhan Azure dan Azure Web App Templat ini membuat akun Azure Cosmos, menyuntikkan titik akhir dan kunci Cosmos DB ke dalam pengaturan Aplikasi Web Azure, lalu menyebarkan aplikasi web ASP MVC dari GitHub.
Buat akun Cosmos Azure untuk MongoDB API Templat ini membuat akun Azure Cosmos DB untuk MongoDB API 4.2 di dua wilayah menggunakan throughput bersama dan khusus dengan dua koleksi.
Buat akun Cosmos Azure untuk skala otomatis API MongoDB Templat ini membuat akun Azure Cosmos DB untuk MongoDB API 4.2 di dua wilayah menggunakan throughput skala otomatis bersama dan khusus.
Buat akun Cosmos Azure untuk Table API Templat ini membuat akun Azure Cosmos DB untuk Table API di dua wilayah dan satu tabel dengan throughput yang disediakan.
Membuat akun Cosmos Azure untuk Table API dengan skala otomatis Templat ini membuat akun Azure Cosmos DB untuk Table API di dua wilayah dan satu tabel dengan throughput skala otomatis.
Buat akun Cosmos DB Azure untuk Cassandra API Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan ruang kunci dan tabel dengan throughput khusus.
Buat akun Cosmos DB Azure untuk Core (SQL) API Templat ini membuat akun Azure Cosmos untuk API Inti (SQL) dengan database dan kontainer dengan throughput dengan beberapa opsi lainnya.
Buat akun Cosmos DB Azure untuk Gremlin API Templat ini membuat akun Azure Cosmos DB untuk Gremlin API di dua wilayah dengan satu database dan satu grafik menggunakan throughput khusus.
Buat akun Cosmos DB Azure untuk skala otomatis API Gremlin Templat ini membuat akun Azure Cosmos DB untuk Gremlin API di dua wilayah dengan satu database dan satu grafik menggunakan throughput skala otomatis.
Buat akun Cosmos DB Azure di beberapa wilayah Templat ini membuat akun Azure Cosmos DB untuk jenis API database apa pun dengan wilayah primer dan sekunder dengan pilihan tingkat konsistensi dan jenis failover.
Buat API SQL akun Cosmos DB Azure dengan skala otomatis Templat ini membuat akun Azure Cosmos untuk API Inti (SQL) dengan database dan kontainer dengan throughput skala otomatis dengan beberapa opsi lainnya.
Buat Akun Cosmos DB Azure dengan titik akhir privat Templat ini akan membuat akun Cosmos, virtual network, dan titik akhir privat yang mengekspos akun Cosmos ke virtual network.
Membuat Akun SQL Cosmos DB Azure dengan bidang data RBAC Templat ini akan membuat akun SQL Cosmos, Definisi Peran yang dikelola secara asli, dan Penetapan Peran yang dikelola secara asli untuk identitas AAD.
Buat Akun CosmosDB Azure Templat ARM ini dimaksudkan untuk membuat Akun CosmosDB dengan cepat dengan nilai minimal yang diperlukan
Buat skala otomatis Azure akun Cosmos DB untuk Cassandra API Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan ruang kunci dan tabel dengan throughput skala otomatis.
Buat Azure prosedur tersimpan API Cosmos DB Core (SQL) Templat ini membuat akun Azure Cosmos DB untuk API Inti (SQL) dan kontainer dengan prosedur tersimpan, pemicu, dan fungsi yang ditentukan pengguna.
Membuat aplikasi layanan mikro Dapr menggunakan Aplikasi Kontainer Buat aplikasi layanan mikro Dapr menggunakan Aplikasi Kontainer.
Membuat aplikasi servicebus pub-sub Dapr menggunakan Aplikasi Kontainer Buat aplikasi dapr pub-sub servicebus menggunakan Container Apps.
Deploy DB Azure Data Explorer dengan koneksi Cosmos DB Menyebarkan Azure Data Explorer DB dengan koneksi Cosmos DB.

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-03-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    databaseAccountOfferType: 'Standard'
    disableKeyBasedMetadataWriteAccess: 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'
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
    createMode: 'string'
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  }
  tags: {
    {customized property}: 'string'
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Atur properti createMode untuk menentukan jenis objek.

UntukDefault , gunakan:

{
  createMode: 'Default'
}

Untuk Pemulihan, gunakan:

{
  createMode: 'Restore'
  restoreParameters: {
    databasesToRestore: [
      {
        collectionNames: [
          'string'
        ]
        databaseName: 'string'
      }
    ]
    restoreMode: 'string'
    restoreSource: 'string'
    restoreTimestampInUtc: 'string'
  }
}

Objek BackupPolicy

Atur properti jenis untuk menentukan jenis objek.

UntukBerkelanjutan , gunakan:

{
  type: 'Continuous'
}

Untukberkala , gunakan:

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

Nilai Properti

Microsoft.DocumentDB/databaseAccounts

Name Description Value
identitas Identitas untuk sumber daya. ManagedServiceIdentity
kind Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database. 'GlobalDocumentDB'
'MongoDB'
'Parse'
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
name Nama sumber daya string

Constraints:
Panjang min = 3
Panjang maksimum = 50
Pola = ^[a-z0-9]+(-[a-z0-9]+)* (diperlukan)
properties Properti untuk membuat dan memperbarui akun database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (wajib)
tags Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat

ApiProperties

Name Description Value
serverVersion Menjelaskan ServerVersion dari akun MongoDB. '3.2'
'3.6'
'4.0'

BackupPolicy

Name Description Value
jenis Atur ke 'Berkelanjutan' untuk jenis ContinuousModeBackupPolicy. Atur ke 'Periodic' untuk jenis PeriodicModeBackupPolicy. 'Continuous'
'Berkala' (wajib)

Capability

Name Description Value
name Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga menyertakan "EnableTable" dan "EnableGremlin". string

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

ConsistencyPolicy

Name Description Value
defaultConsistencyLevel Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Kuat' (wajib)
maxIntervalInSeconds Ketika digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini mewakili jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Constraints:
Nilai min = 5
Nilai maks = 86400
maxStalenessPrefix Ketika digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini menunjukkan jumlah permintaan kedaluarsa yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 1 – 2.147.483.647. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Constraints:
Nilai min = 1
Nilai maks = 2147483647

ContinuousModeBackupPolicy

Name Description Value
jenis Menjelaskan mode pencadangan. 'Kontinu' (wajib)

CorsPolicy

Name Description Value
allowedHeaders Header permintaan yang dapat ditentukan domain asal pada permintaan CORS. string
allowedMethods Metode (kata kerja permintaan HTTP) yang dapat digunakan domain asal untuk permintaan CORS. string
allowedOrigins Domain asal yang diizinkan untuk membuat permintaan terhadap layanan melalui CORS. string (diperlukan)
exposedHeaders Header respons yang mungkin dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan. string
maxAgeInSeconds Jumlah maksimum waktu browser harus menyimpan cache permintaan OPSI preflight. int

Constraints:
Nilai min = 1
Nilai maks = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Description Value
apiProperties Properti khusus API. Saat ini, hanya didukung untuk MongoDB API. ApiProperties
backupPolicy Objek yang mewakili kebijakan untuk mengambil cadangan pada akun. BackupPolicy
capabilities Daftar kemampuan Cosmos DB untuk akun Capability[]
connectorOffer Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB. 'Small'
consistencyPolicy Kebijakan konsistensi untuk akun Cosmos DB. ConsistencyPolicy
cors Kebijakan CORS untuk akun database Cosmos DB. CorsPolicy[]
createMode Atur ke 'Default' untuk jenis DefaultRequestDatabaseAccountCreateUpdateProperties. Atur ke 'Restore' untuk jenis RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Default'
'Pulihkan' (wajib)
databaseAccountOfferType Jenis penawaran untuk database 'Standar' (diperlukan)
disableKeyBasedMetadataWriteAccess Nonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun bool
enableAnalyticalStorage Tandai untuk menunjukkan apakah akan mengaktifkan storage analytics. bool
enableAutomaticFailover Mengaktifkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun. bool
enableCassandraConnector Mengaktifkan konektor cassandra pada akun Cosmos DB C* bool
enableFreeTier Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan. bool
enableMultipleWriteLocations Memungkinkan akun menulis di beberapa lokasi bool
ipRules Daftar IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network. bool
keyVaultKeyUri URI key vault string
locations Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB. Lokasi[] (wajib)
networkAclBypass Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB. string[]
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Disabled'
'Enabled'
virtualNetworkRules Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

Name Description Value
collectionNames Nama koleksi yang tersedia untuk dipulihkan. string[]
databaseName Nama database yang tersedia untuk dipulihkan. string

DefaultRequestDatabaseAccountCreateUpdateProperties

Name Description Value
createMode Enum untuk menunjukkan mode pembuatan akun. 'Default' (diperlukan)

IpAddressOrRange

Name Description Value
ipAddressOrRange Satu alamat IPv4 atau satu rentang alamat IPv4 dalam format CIDR. IP yang disediakan harus diformat dengan baik dan tidak dapat dimuat dalam salah satu rentang berikut: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, karena ini tidak dapat diberlakukan oleh filter alamat IP. Contoh input yang valid: "23.40.210.245" atau "23.40.210.0/8". string

Location

Name Description Value
failoverPriority Prioritas failover wilayah. Prioritas failover 0 menunjukkan wilayah tulis. Nilai maksimum untuk prioritas failover = (jumlah total wilayah - 1). Nilai prioritas failover harus unik untuk setiap wilayah tempat akun database berada. int

Constraints:
Nilai min = 0
isZoneRedundant Bendera untuk menunjukkan apakah wilayah ini adalah wilayah AvailabilityZone atau tidak bool
locationName Nama wilayah. string

ManagedServiceIdentity

Name Description Value
jenis Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

PeriodicModeBackupPolicy

Name Description Value
periodicModeProperties Nilai konfigurasi untuk pencadangan mode berkala PeriodicModeProperties
jenis Menjelaskan mode pencadangan. 'Berkala' (wajib)

PeriodicModeProperties

Name Description Value
backupIntervalInMinutes Bilangan bulat yang mewakili interval dalam menit di antara dua cadangan int

Constraints:
Nilai min = 0
backupRetentionIntervalInHours Bilangan bulat yang mewakili waktu (dalam jam) setiap cadangan dipertahankan int

Constraints:
Nilai min = 0
backupStorageRedundancy Enum untuk menunjukkan jenis residensi cadangan 'Geo'
'Local'
'Zone'

RestoreParameters

Name Description Value
databasesToRestore Daftar database tertentu yang tersedia untuk dipulihkan. DatabaseRestoreResource[]
restoreMode Menjelaskan mode pemulihan. 'PointInTime'
restoreSource Id akun database yang dapat dipulihkan tempat pemulihan harus dimulai. Misalnya: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Waktu di mana akun harus dipulihkan (format ISO-8601). string

RestoreReqeustDatabaseAccountCreateUpdateProperties

Name Description Value
createMode Enum untuk menunjukkan mode pembuatan akun. 'Pulihkan' (wajib)
restoreParameters Parameter untuk menunjukkan informasi tentang pemulihan. RestoreParameters

Tags

Name Description Value

VirtualNetworkRule

Name Description Value
id ID sumber daya subnet, misalnya: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. string
ignoreMissingVNetServiceEndpoint Buat aturan firewall sebelum virtual network mengaktifkan titik akhir layanan vnet. bool

Definisi sumber daya templat ARM

Jenis sumber daya databaseAccounts dapat disebarkan dengan operasi yang menargetkan:

Contoh Penggunaan

Templat Mulai Cepat Azure

Templat Mulai Cepat Azure berikut menyebarkan jenis sumber daya ini.

Template Description
Azure API SQL akun Cosmos DB dengan penyimpanan analitik

Deploy ke Azure
Templat ini membuat akun Azure Cosmos untuk API Inti (SQL) dengan database dan kontainer yang dikonfigurasi dengan penyimpanan analitik.
Azure Akun Cosmos DB dengan Aplikasi Web

Deploy ke Azure
Templat ini menyebarkan akun Azure Cosmos DB, Paket App Service, dan membuat Aplikasi Web di Paket App Service. Ini juga menambahkan dua pengaturan Aplikasi ke Aplikasi Web yang mereferensikan titik akhir akun Azure Cosmos DB. Dengan cara ini, solusi yang disebarkan ke Aplikasi Web dapat terhubung ke titik akhir akun Azure Cosmos DB menggunakan pengaturan tersebut.
CI/CD menggunakan Jenkins di Azure Container Service (AKS)

Deploy ke Azure
Kontainer memudahkan Anda untuk terus membangun dan menyebarkan aplikasi Anda. Dengan mengatur penyebaran kontainer tersebut menggunakan Kubernetes di Azure Container Service, Anda dapat mencapai kluster kontainer yang dapat direplikasi dan dikelola. Dengan menyiapkan build berkelanjutan untuk menghasilkan gambar dan orkestrasi kontainer, Anda dapat meningkatkan kecepatan dan keandalan penyebaran Anda.
Buat akun Cosmos DB dengan Microsoft Defender diaktifkan

Deploy ke Azure
Dengan menggunakan templat ARM ini, Anda dapat menyebarkan akun Azure Cosmos DB dengan Microsoft Defender untuk Azure Cosmos DB diaktifkan. Microsoft Defender untuk Azure Cosmos DB adalah lapisan keamanan asli Azure yang mendeteksi upaya untuk mengeksploitasi database di akun Azure Cosmos DB Anda. Microsoft Defender Azure Cosmos DB mendeteksi potensi injeksi SQL, aktor jahat yang diketahui berdasarkan Microsoft Threat Intelligence, pola access yang mencurigakan, dan potensi eksploitasi database Anda melalui identitas yang disusupi atau orang dalam yang berbahaya.
Buat akun Cosmos DB tingkat gratis Azure

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB tingkat bebas untuk SQL API dengan database dengan throughput dan kontainer bersama.
Buat akun Cosmos DB Azure minimal untuk Core (SQL) API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk API Inti (SQL) sambil hanya menentukan properti sumber daya minimal yang diperlukan.
Buat akun Cosmos DB Azure Nirserver untuk SQL API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB tanpa server untuk API Inti (SQL).
Buat akun Cosmos tanpa sentuhan Azure dan Azure Web App

Deploy ke Azure
Templat ini membuat akun Azure Cosmos, menyuntikkan titik akhir dan kunci Cosmos DB ke dalam pengaturan Aplikasi Web Azure, lalu menyebarkan aplikasi web ASP MVC dari GitHub.
Buat akun Cosmos Azure untuk MongoDB API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk MongoDB API 4.2 di dua wilayah menggunakan throughput bersama dan khusus dengan dua koleksi.
Buat akun Cosmos Azure untuk skala otomatis API MongoDB

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk MongoDB API 4.2 di dua wilayah menggunakan throughput skala otomatis bersama dan khusus.
Buat akun Cosmos Azure untuk Table API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Table API di dua wilayah dan satu tabel dengan throughput yang disediakan.
Membuat akun Cosmos Azure untuk Table API dengan skala otomatis

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Table API di dua wilayah dan satu tabel dengan throughput skala otomatis.
Buat akun Cosmos DB Azure untuk Cassandra API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan ruang kunci dan tabel dengan throughput khusus.
Buat akun Cosmos DB Azure untuk Core (SQL) API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos untuk API Inti (SQL) dengan database dan kontainer dengan throughput dengan beberapa opsi lainnya.
Buat akun Cosmos DB Azure untuk Gremlin API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Gremlin API di dua wilayah dengan satu database dan satu grafik menggunakan throughput khusus.
Buat akun Cosmos DB Azure untuk skala otomatis API Gremlin

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Gremlin API di dua wilayah dengan satu database dan satu grafik menggunakan throughput skala otomatis.
Buat akun Cosmos DB Azure di beberapa wilayah

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk jenis API database apa pun dengan wilayah primer dan sekunder dengan pilihan tingkat konsistensi dan jenis failover.
Buat API SQL akun Cosmos DB Azure dengan skala otomatis

Deploy ke Azure
Templat ini membuat akun Azure Cosmos untuk API Inti (SQL) dengan database dan kontainer dengan throughput skala otomatis dengan beberapa opsi lainnya.
Buat Akun Cosmos DB Azure dengan titik akhir privat

Deploy ke Azure
Templat ini akan membuat akun Cosmos, virtual network, dan titik akhir privat yang mengekspos akun Cosmos ke virtual network.
Membuat Akun SQL Cosmos DB Azure dengan bidang data RBAC

Deploy ke Azure
Templat ini akan membuat akun SQL Cosmos, Definisi Peran yang dikelola secara asli, dan Penetapan Peran yang dikelola secara asli untuk identitas AAD.
Buat Akun CosmosDB Azure

Deploy ke Azure
Templat ARM ini dimaksudkan untuk membuat Akun CosmosDB dengan cepat dengan nilai minimal yang diperlukan
Buat skala otomatis Azure akun Cosmos DB untuk Cassandra API

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan ruang kunci dan tabel dengan throughput skala otomatis.
Buat Azure prosedur tersimpan API Cosmos DB Core (SQL)

Deploy ke Azure
Templat ini membuat akun Azure Cosmos DB untuk API Inti (SQL) dan kontainer dengan prosedur tersimpan, pemicu, dan fungsi yang ditentukan pengguna.
Buat Azure Cosmos dengan SQL API dan beberapa kontainer

Deploy ke Azure
Templat membuat kontainer Cosmos dengan SQL API dan memungkinkan penambahan kontainer mulitple.
Membuat aplikasi layanan mikro Dapr menggunakan Aplikasi Kontainer

Deploy ke Azure
Buat aplikasi layanan mikro Dapr menggunakan Aplikasi Kontainer.
Membuat aplikasi servicebus pub-sub Dapr menggunakan Aplikasi Kontainer

Deploy ke Azure
Buat aplikasi dapr pub-sub servicebus menggunakan Container Apps.
Deploy DB Azure Data Explorer dengan koneksi Cosmos DB

Deploy ke Azure
Menyebarkan Azure Data Explorer DB dengan koneksi Cosmos DB.
Aplikasi Web dengan SQL Database, Azure Cosmos DB, Azure Search

Deploy ke Azure
Templat ini menyediakan Aplikasi Web, SQL Database, Azure Cosmos DB, Azure Search, dan Application Insights.

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": "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",
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ],
    "createMode": "string"
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Atur properti createMode untuk menentukan jenis objek.

UntukDefault , gunakan:

{
  "createMode": "Default"
}

Untuk Pemulihan, gunakan:

{
  "createMode": "Restore",
  "restoreParameters": {
    "databasesToRestore": [
      {
        "collectionNames": [ "string" ],
        "databaseName": "string"
      }
    ],
    "restoreMode": "string",
    "restoreSource": "string",
    "restoreTimestampInUtc": "string"
  }
}

Objek BackupPolicy

Atur properti jenis untuk menentukan jenis objek.

UntukBerkelanjutan , gunakan:

{
  "type": "Continuous"
}

Untukberkala , gunakan:

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

Nilai Properti

Microsoft.DocumentDB/databaseAccounts

Name Description Value
apiVersion Versi api '2021-03-01-preview'
identitas Identitas untuk sumber daya. ManagedServiceIdentity
kind Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database. 'GlobalDocumentDB'
'MongoDB'
'Parse'
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
name Nama sumber daya string

Constraints:
Panjang min = 3
Panjang maksimum = 50
Pola = ^[a-z0-9]+(-[a-z0-9]+)* (diperlukan)
properties Properti untuk membuat dan memperbarui akun database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (wajib)
tags Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
jenis Jenis sumber daya 'Microsoft.DocumentDB/databaseAccounts'

ApiProperties

Name Description Value
serverVersion Menjelaskan ServerVersion dari akun MongoDB. '3.2'
'3.6'
'4.0'

BackupPolicy

Name Description Value
jenis Atur ke 'Berkelanjutan' untuk jenis ContinuousModeBackupPolicy. Atur ke 'Periodic' untuk jenis PeriodicModeBackupPolicy. 'Continuous'
'Berkala' (wajib)

Capability

Name Description Value
name Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga menyertakan "EnableTable" dan "EnableGremlin". string

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

ConsistencyPolicy

Name Description Value
defaultConsistencyLevel Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Kuat' (wajib)
maxIntervalInSeconds Ketika digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini mewakili jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Constraints:
Nilai min = 5
Nilai maks = 86400
maxStalenessPrefix Ketika digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini menunjukkan jumlah permintaan kedaluarsa yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 1 – 2.147.483.647. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Constraints:
Nilai min = 1
Nilai maks = 2147483647

ContinuousModeBackupPolicy

Name Description Value
jenis Menjelaskan mode pencadangan. 'Kontinu' (wajib)

CorsPolicy

Name Description Value
allowedHeaders Header permintaan yang dapat ditentukan domain asal pada permintaan CORS. string
allowedMethods Metode (kata kerja permintaan HTTP) yang dapat digunakan domain asal untuk permintaan CORS. string
allowedOrigins Domain asal yang diizinkan untuk membuat permintaan terhadap layanan melalui CORS. string (diperlukan)
exposedHeaders Header respons yang mungkin dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan. string
maxAgeInSeconds Jumlah maksimum waktu browser harus menyimpan cache permintaan OPSI preflight. int

Constraints:
Nilai min = 1
Nilai maks = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Description Value
apiProperties Properti khusus API. Saat ini, hanya didukung untuk MongoDB API. ApiProperties
backupPolicy Objek yang mewakili kebijakan untuk mengambil cadangan pada akun. BackupPolicy
capabilities Daftar kemampuan Cosmos DB untuk akun Capability[]
connectorOffer Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB. 'Small'
consistencyPolicy Kebijakan konsistensi untuk akun Cosmos DB. ConsistencyPolicy
cors Kebijakan CORS untuk akun database Cosmos DB. CorsPolicy[]
createMode Atur ke 'Default' untuk jenis DefaultRequestDatabaseAccountCreateUpdateProperties. Atur ke 'Restore' untuk jenis RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Default'
'Pulihkan' (wajib)
databaseAccountOfferType Jenis penawaran untuk database 'Standar' (diperlukan)
disableKeyBasedMetadataWriteAccess Nonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun bool
enableAnalyticalStorage Tandai untuk menunjukkan apakah akan mengaktifkan storage analytics. bool
enableAutomaticFailover Mengaktifkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun. bool
enableCassandraConnector Mengaktifkan konektor cassandra pada akun Cosmos DB C* bool
enableFreeTier Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan. bool
enableMultipleWriteLocations Memungkinkan akun menulis di beberapa lokasi bool
ipRules Daftar IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network. bool
keyVaultKeyUri URI key vault string
locations Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB. Lokasi[] (wajib)
networkAclBypass Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB. string[]
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Disabled'
'Enabled'
virtualNetworkRules Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

Name Description Value
collectionNames Nama koleksi yang tersedia untuk dipulihkan. string[]
databaseName Nama database yang tersedia untuk dipulihkan. string

DefaultRequestDatabaseAccountCreateUpdateProperties

Name Description Value
createMode Enum untuk menunjukkan mode pembuatan akun. 'Default' (diperlukan)

IpAddressOrRange

Name Description Value
ipAddressOrRange Satu alamat IPv4 atau satu rentang alamat IPv4 dalam format CIDR. IP yang disediakan harus diformat dengan baik dan tidak dapat dimuat dalam salah satu rentang berikut: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, karena ini tidak dapat diberlakukan oleh filter alamat IP. Contoh input yang valid: "23.40.210.245" atau "23.40.210.0/8". string

Location

Name Description Value
failoverPriority Prioritas failover wilayah. Prioritas failover 0 menunjukkan wilayah tulis. Nilai maksimum untuk prioritas failover = (jumlah total wilayah - 1). Nilai prioritas failover harus unik untuk setiap wilayah tempat akun database berada. int

Constraints:
Nilai min = 0
isZoneRedundant Bendera untuk menunjukkan apakah wilayah ini adalah wilayah AvailabilityZone atau tidak bool
locationName Nama wilayah. string

ManagedServiceIdentity

Name Description Value
jenis Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

PeriodicModeBackupPolicy

Name Description Value
periodicModeProperties Nilai konfigurasi untuk pencadangan mode berkala PeriodicModeProperties
jenis Menjelaskan mode pencadangan. 'Berkala' (wajib)

PeriodicModeProperties

Name Description Value
backupIntervalInMinutes Bilangan bulat yang mewakili interval dalam menit di antara dua cadangan int

Constraints:
Nilai min = 0
backupRetentionIntervalInHours Bilangan bulat yang mewakili waktu (dalam jam) setiap cadangan dipertahankan int

Constraints:
Nilai min = 0
backupStorageRedundancy Enum untuk menunjukkan jenis residensi cadangan 'Geo'
'Local'
'Zone'

RestoreParameters

Name Description Value
databasesToRestore Daftar database tertentu yang tersedia untuk dipulihkan. DatabaseRestoreResource[]
restoreMode Menjelaskan mode pemulihan. 'PointInTime'
restoreSource Id akun database yang dapat dipulihkan tempat pemulihan harus dimulai. Misalnya: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Waktu di mana akun harus dipulihkan (format ISO-8601). string

RestoreReqeustDatabaseAccountCreateUpdateProperties

Name Description Value
createMode Enum untuk menunjukkan mode pembuatan akun. 'Pulihkan' (wajib)
restoreParameters Parameter untuk menunjukkan informasi tentang pemulihan. RestoreParameters

Tags

Name Description Value

VirtualNetworkRule

Name Description Value
id ID sumber daya subnet, misalnya: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. string
ignoreMissingVNetServiceEndpoint Buat aturan firewall sebelum virtual network mengaktifkan titik akhir layanan vnet. bool

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya databaseAccounts dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Contoh Penggunaan

Sampel Terraform

Contoh dasar penerapan Akun CosmosDB (secara resmi DocumentDB).

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2021-03-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      databaseAccountOfferType = "Standard"
      disableKeyBasedMetadataWriteAccess = 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"
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
      createMode = "string"
      // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
    }
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Atur properti createMode untuk menentukan jenis objek.

UntukDefault , gunakan:

{
  createMode = "Default"
}

Untuk Pemulihan, gunakan:

{
  createMode = "Restore"
  restoreParameters = {
    databasesToRestore = [
      {
        collectionNames = [
          "string"
        ]
        databaseName = "string"
      }
    ]
    restoreMode = "string"
    restoreSource = "string"
    restoreTimestampInUtc = "string"
  }
}

Objek BackupPolicy

Atur properti jenis untuk menentukan jenis objek.

UntukBerkelanjutan , gunakan:

{
  type = "Continuous"
}

Untukberkala , gunakan:

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

Nilai Properti

Microsoft.DocumentDB/databaseAccounts

Name Description Value
identitas Identitas untuk sumber daya. ManagedServiceIdentity
kind Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database. 'GlobalDocumentDB'
'MongoDB'
'Parse'
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
name Nama sumber daya string

Constraints:
Panjang min = 3
Panjang maksimum = 50
Pola = ^[a-z0-9]+(-[a-z0-9]+)* (diperlukan)
properties Properti untuk membuat dan memperbarui akun database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (wajib)
tags Tag sumber daya Kamus nama dan nilai tag.
jenis Jenis sumber daya "Microsoft.DocumentDB/databaseAccounts@2021-03-01-preview"

ApiProperties

Name Description Value
serverVersion Menjelaskan ServerVersion dari akun MongoDB. '3.2'
'3.6'
'4.0'

BackupPolicy

Name Description Value
jenis Atur ke 'Berkelanjutan' untuk jenis ContinuousModeBackupPolicy. Atur ke 'Periodic' untuk jenis PeriodicModeBackupPolicy. 'Continuous'
'Berkala' (wajib)

Capability

Name Description Value
name Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga menyertakan "EnableTable" dan "EnableGremlin". string

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

ConsistencyPolicy

Name Description Value
defaultConsistencyLevel Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Kuat' (wajib)
maxIntervalInSeconds Ketika digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini mewakili jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Constraints:
Nilai min = 5
Nilai maks = 86400
maxStalenessPrefix Ketika digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini menunjukkan jumlah permintaan kedaluarsa yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 1 – 2.147.483.647. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Constraints:
Nilai min = 1
Nilai maks = 2147483647

ContinuousModeBackupPolicy

Name Description Value
jenis Menjelaskan mode pencadangan. 'Kontinu' (wajib)

CorsPolicy

Name Description Value
allowedHeaders Header permintaan yang dapat ditentukan domain asal pada permintaan CORS. string
allowedMethods Metode (kata kerja permintaan HTTP) yang dapat digunakan domain asal untuk permintaan CORS. string
allowedOrigins Domain asal yang diizinkan untuk membuat permintaan terhadap layanan melalui CORS. string (diperlukan)
exposedHeaders Header respons yang mungkin dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan. string
maxAgeInSeconds Jumlah maksimum waktu browser harus menyimpan cache permintaan OPSI preflight. int

Constraints:
Nilai min = 1
Nilai maks = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Description Value
apiProperties Properti khusus API. Saat ini, hanya didukung untuk MongoDB API. ApiProperties
backupPolicy Objek yang mewakili kebijakan untuk mengambil cadangan pada akun. BackupPolicy
capabilities Daftar kemampuan Cosmos DB untuk akun Capability[]
connectorOffer Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB. 'Small'
consistencyPolicy Kebijakan konsistensi untuk akun Cosmos DB. ConsistencyPolicy
cors Kebijakan CORS untuk akun database Cosmos DB. CorsPolicy[]
createMode Atur ke 'Default' untuk jenis DefaultRequestDatabaseAccountCreateUpdateProperties. Atur ke 'Restore' untuk jenis RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Default'
'Pulihkan' (wajib)
databaseAccountOfferType Jenis penawaran untuk database 'Standar' (diperlukan)
disableKeyBasedMetadataWriteAccess Nonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun bool
enableAnalyticalStorage Tandai untuk menunjukkan apakah akan mengaktifkan storage analytics. bool
enableAutomaticFailover Mengaktifkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun. bool
enableCassandraConnector Mengaktifkan konektor cassandra pada akun Cosmos DB C* bool
enableFreeTier Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan. bool
enableMultipleWriteLocations Memungkinkan akun menulis di beberapa lokasi bool
ipRules Daftar IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network. bool
keyVaultKeyUri URI key vault string
locations Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB. Lokasi[] (wajib)
networkAclBypass Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB. string[]
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Disabled'
'Enabled'
virtualNetworkRules Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

Name Description Value
collectionNames Nama koleksi yang tersedia untuk dipulihkan. string[]
databaseName Nama database yang tersedia untuk dipulihkan. string

DefaultRequestDatabaseAccountCreateUpdateProperties

Name Description Value
createMode Enum untuk menunjukkan mode pembuatan akun. 'Default' (diperlukan)

IpAddressOrRange

Name Description Value
ipAddressOrRange Satu alamat IPv4 atau satu rentang alamat IPv4 dalam format CIDR. IP yang disediakan harus diformat dengan baik dan tidak dapat dimuat dalam salah satu rentang berikut: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, karena ini tidak dapat diberlakukan oleh filter alamat IP. Contoh input yang valid: "23.40.210.245" atau "23.40.210.0/8". string

Location

Name Description Value
failoverPriority Prioritas failover wilayah. Prioritas failover 0 menunjukkan wilayah tulis. Nilai maksimum untuk prioritas failover = (jumlah total wilayah - 1). Nilai prioritas failover harus unik untuk setiap wilayah tempat akun database berada. int

Constraints:
Nilai min = 0
isZoneRedundant Bendera untuk menunjukkan apakah wilayah ini adalah wilayah AvailabilityZone atau tidak bool
locationName Nama wilayah. string

ManagedServiceIdentity

Name Description Value
jenis Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

PeriodicModeBackupPolicy

Name Description Value
periodicModeProperties Nilai konfigurasi untuk pencadangan mode berkala PeriodicModeProperties
jenis Menjelaskan mode pencadangan. 'Berkala' (wajib)

PeriodicModeProperties

Name Description Value
backupIntervalInMinutes Bilangan bulat yang mewakili interval dalam menit di antara dua cadangan int

Constraints:
Nilai min = 0
backupRetentionIntervalInHours Bilangan bulat yang mewakili waktu (dalam jam) setiap cadangan dipertahankan int

Constraints:
Nilai min = 0
backupStorageRedundancy Enum untuk menunjukkan jenis residensi cadangan 'Geo'
'Local'
'Zone'

RestoreParameters

Name Description Value
databasesToRestore Daftar database tertentu yang tersedia untuk dipulihkan. DatabaseRestoreResource[]
restoreMode Menjelaskan mode pemulihan. 'PointInTime'
restoreSource Id akun database yang dapat dipulihkan tempat pemulihan harus dimulai. Misalnya: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Waktu di mana akun harus dipulihkan (format ISO-8601). string

RestoreReqeustDatabaseAccountCreateUpdateProperties

Name Description Value
createMode Enum untuk menunjukkan mode pembuatan akun. 'Pulihkan' (wajib)
restoreParameters Parameter untuk menunjukkan informasi tentang pemulihan. RestoreParameters

Tags

Name Description Value

VirtualNetworkRule

Name Description Value
id ID sumber daya subnet, misalnya: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. string
ignoreMissingVNetServiceEndpoint Buat aturan firewall sebelum virtual network mengaktifkan titik akhir layanan vnet. bool