DatabaseAccounts Microsoft.DocumentDB

Definisi sumber daya Bicep

Jenis sumber daya databaseAccounts dapat disebarkan dengan operasi yang menargetkan:

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

Format sumber daya

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    analyticalStorageConfiguration: {
      schemaType: 'string'
    }
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      migrationState: {
        startTime: 'string'
        status: 'string'
        targetType: 'string'
      }
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    connectorOffer: 'Small'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    customerManagedKeyStatus: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    defaultPriorityLevel: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePerRegionPerPartitionAutoscale: bool
    enablePriorityBasedExecution: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'PointInTime'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      restoreWithTtlDisabled: bool
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

Objek BackupPolicy

Atur properti jenis untuk menentukan jenis objek.

Untuk Berkelanjutan, gunakan:

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

Untuk Berkala, gunakan:

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

Nilai properti

databaseAccounts

Nama Deskripsi Nilai
nama Nama sumber daya string (diperlukan)

Batas karakter: 3-44

Karakter yang valid:
Huruf kecil, angka, dan tanda hubung.

Mulai dengan huruf kecil atau angka.

Nama sumber daya harus unik di seluruh Azure.
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
tag Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". Kamus nama dan nilai tag. Lihat Tag dalam templat
jenis Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database. 'GlobalDocumentDB'
'MongoDB'
'Uraikan'
identitas Identitas untuk sumber daya. ManagedServiceIdentity
properti Properti untuk membuat dan memperbarui akun database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (diperlukan)

ManagedServiceIdentity

Nama Deskripsi Nilai
jenis 'Tidak Ada'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.
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

Nama Deskripsi Nilai
{customized property} Komponen1Jq1T4ISchemasManagedserviceidentityProper...

Komponen1Jq1T4ISchemasManagedserviceidentityProper...

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nama Deskripsi Nilai
analyticalStorageConfiguration Properti khusus penyimpanan analitis. AnalyticalStorageConfiguration
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 Kapabilitas[]
kapasitas Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun. Kapasitas
connectorOffer Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB. 'Kecil'
consistencyPolicy Kebijakan konsistensi untuk akun Cosmos DB. ConsistencyPolicy
cors Kebijakan CORS untuk akun database Cosmos DB. CorsPolicy[]
createMode Enum untuk menunjukkan mode pembuatan akun. 'Default'
'PointInTimeRestore'
'Pulihkan'
customerManagedKeyStatus Menunjukkan status fitur Kunci yang Dikelola Pelanggan pada akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah. string
databaseAccountOfferType Jenis penawaran untuk database 'Standar' (diperlukan)
defaultIdentity Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi. string
defaultPriorityLevel Enum untuk menunjukkan Tingkat Prioritas default permintaan untuk Eksekusi Berbasis Prioritas. 'Tinggi'
'Rendah'
diagnosticLogSettings Objek yang mewakili pengaturan log Diagnostik yang berbeda untuk Akun Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Menonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun bool
disableLocalAuth Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi. bool
enableAnalyticalStorage Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan. bool
enableAutomaticFailover Mengaktifkan failover otomatis wilayah tulis jika wilayah tersebut tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun tersebut. bool
enableBurstCapacity Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Kapasitas Burst pada akun bool
enableCassandraConnector Mengaktifkan konektor cassandra pada akun Cosmos DB C* bool
enableFreeTier Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan. bool
enableMaterializedViews Bendera untuk menunjukkan apakah akan mengaktifkan MaterializedViews pada akun Cosmos DB bool
enableMultipleWriteLocations Mengaktifkan akun untuk menulis di beberapa lokasi bool
enablePartitionMerge Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Gabungan Partisi pada akun bool
enablePerRegionPerPartitionAutoscale Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau skala otomatis Per-Region Per partisi pada akun bool
enablePriorityBasedExecution Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau Eksekusi Berbasis Prioritas pada akun bool
ipRules Daftar IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network. bool
keyVaultKeyUri URI brankas kunci string
locations Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB. Location[] (wajib)
minimalTlsVersion Menunjukkan versi Tls minimum yang diizinkan. Defaultnya adalah Tls 1.0, kecuali Cassandra dan Mongo API, yang hanya berfungsi dengan Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass 'AzureServices'
'None': Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
networkAclBypassResourceIds Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB. string[]
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Dinonaktifkan'
'Diaktifkan'
'SecuredByPerimeter'
restoreParameters Parameter untuk menunjukkan informasi tentang pemulihan. RestoreParameters
virtualNetworkRules Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nama Deskripsi Nilai
schemaType Menjelaskan jenis skema untuk penyimpanan analitis. 'FullFidelity'
'WellDefined'

ApiProperties

Nama Deskripsi Nilai
serverVersion Menjelaskan ServerVersion dari akun MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

Nama Deskripsi Nilai
migrationState Objek yang mewakili status migrasi antara kebijakan pencadangan. BackupPolicyMigrationState
jenis Mengatur jenis objek Berkelanjutan
Berkala (diperlukan)

BackupPolicyMigrationState

Nama Deskripsi Nilai
startTime Waktu di mana migrasi kebijakan cadangan dimulai (format ISO-8601). string
status Menjelaskan status migrasi antar jenis kebijakan pencadangan. 'Selesai'
'Gagal'
'InProgress'
'Tidak valid'
targetType Menjelaskan jenis kebijakan pencadangan target dari migrasi kebijakan pencadangan. 'Berkelanjutan'
'Berkala'

ContinuousModeBackupPolicy

Nama Deskripsi Nilai
jenis Menjelaskan mode pencadangan. 'Berkelanjutan' (diperlukan)
continuousModeProperties Nilai konfigurasi untuk pencadangan mode berkelanjutan ContinuousModeProperties

ContinuousModeProperties

Nama Deskripsi Nilai
Tier Enum untuk menunjukkan jenis mode pencadangan Continuos 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Nama Deskripsi Nilai
jenis Menjelaskan mode pencadangan. 'Berkala' (diperlukan)
periodicModeProperties Nilai konfigurasi untuk pencadangan mode berkala PeriodicModeProperties

PeriodicModeProperties

Nama Deskripsi Nilai
backupIntervalInMinutes Bilangan bulat yang mewakili interval dalam hitungan menit di antara dua cadangan int

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

Batasan:
Nilai min = 0
backupStorageRedundancy Enum untuk menunjukkan jenis residensi cadangan 'Geo'
'Lokal'
'Zona'

Kemampuan

Nama Deskripsi Nilai
nama Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga termasuk "EnableTable" dan "EnableGremlin". string

Kapasitas

Nama Deskripsi Nilai
totalThroughputLimit Batas throughput total yang diberlakukan pada akun. TotalThroughputLimit 2000 memberlakukan batas throughput maks yang ketat yang dapat disediakan pada akun tersebut menjadi 2000. TotalThroughputLimit -1 menunjukkan tidak ada batasan penyediaan throughput. int

ConsistencyPolicy

Nama Deskripsi Nilai
defaultConsistencyLevel Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Akhirnya'
'Sesi'
'Kuat' (diperlukan)
maxIntervalInSeconds Ketika digunakan dengan tingkat konsistensi Keusangan Terikat, nilai ini menunjukkan jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Batasan:
Nilai min = 5
Nilai maks = 86400
maxStalenessPrefix Saat 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

Batasan:
Nilai min = 1
Nilai maks = 2147483647

CorsPolicy

Nama Deskripsi Nilai
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 dapat dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan. string
maxAgeInSeconds Jumlah waktu maksimum browser harus menyimpan cache permintaan OPTIONS preflight. int

Batasan:
Nilai min = 1
Nilai maks = 2147483647

DiagnosticLogSettings

Nama Deskripsi Nilai
enableFullTextQuery 'False'
'Tidak Ada'
'True': Menjelaskan tingkat detail kueri mana yang akan dicatat.

IpAddressOrRange

Nama Deskripsi Nilai
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

Lokasi

Nama Deskripsi Nilai
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

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

RestoreParameters

Nama Deskripsi Nilai
databaseToRestore Daftar database tertentu yang tersedia untuk dipulihkan. DatabaseRestoreResource[]
gremlinDatabasesToRestore Daftar database gremlin tertentu yang tersedia untuk dipulihkan. GremlinDatabaseRestoreResource[]
restoreMode Menjelaskan mode pemulihan. 'PointInTime'
restoreSource Id akun database yang dapat dipulihkan dari mana 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
restoreWithTtlDisabled Menentukan apakah akun yang dipulihkan akan menonaktifkan Time-To-Live setelah pemulihan berhasil. bool
sourceBackupLocation Lokasi pencadangan sumber untuk pemulihan. string
tablesToRestore Daftar tabel tertentu yang tersedia untuk dipulihkan. string[]

DatabaseRestoreResource

Nama Deskripsi Nilai
collectionNames Nama koleksi yang tersedia untuk dipulihkan. string[]
databaseName Nama database yang tersedia untuk dipulihkan. string

GremlinDatabaseRestoreResource

Nama Deskripsi Nilai
databaseName Nama database gremlin yang tersedia untuk dipulihkan. string
graphNames Nama grafik yang tersedia untuk dipulihkan. string[]

VirtualNetworkRule

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

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
CI/CD menggunakan Jenkins di Azure Container Service (AKS)

Sebarkan 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 dapat dikelola. Dengan menyiapkan build berkelanjutan untuk menghasilkan gambar dan orkestrasi kontainer Anda, Anda dapat meningkatkan kecepatan dan keandalan penyebaran Anda.
Aplikasi Web dengan SQL Database, Azure Cosmos DB, Azure Search

Sebarkan ke Azure
Templat ini menyediakan Aplikasi Web, SQL Database, Azure Cosmos DB, Azure Search, dan Application Insights.
Membuat akun Azure Cosmos DB untuk Cassandra API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan keyspace dan tabel dengan throughput khusus.
Membuat akun Azure Cosmos DB skala otomatis untuk Cassandra API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan keyspace dan tabel dengan throughput skala otomatis.
Membuat Akun Azure CosmosDB

Sebarkan ke Azure
Templat ARM ini dimaksudkan untuk membuat Akun CosmosDB dengan cepat dengan nilai minimal yang diperlukan
Membuat akun Azure Cosmos DB di beberapa wilayah

Sebarkan 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.
Membuat akun Azure Cosmos DB tingkat gratis

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB tingkat gratis untuk SQL API dengan database dengan throughput dan kontainer bersama.
Membuat akun Azure Cosmos DB untuk Gremlin API

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

Sebarkan 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.
Membuat akun Azure Cosmos untuk MongoDB API

Sebarkan 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.
Membuat akun Azure Cosmos untuk skala otomatis MongoDB API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk MongoDB API 4.2 di dua wilayah menggunakan throughput skala otomatis bersama dan khusus.
Membuat Akun Azure Cosmos DB dengan titik akhir privat

Sebarkan ke Azure
Templat ini akan membuat akun Cosmos, jaringan virtual, dan titik akhir privat yang mengekspos akun Cosmos ke jaringan virtual.
Membuat akun Azure Cosmos DB untuk CORE (SQL) API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput dengan beberapa opsi lainnya.
SQL API akun Azure Cosmos DB dengan penyimpanan analitis

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer yang dikonfigurasi dengan penyimpanan analitis.
Membuat SQL API akun Azure Cosmos DB dengan skala otomatis

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput skala otomatis dengan beberapa opsi lainnya.
Membuat prosedur tersimpan API Azure Cosmos DB Core (SQL)

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk CORE (SQL) API dan kontainer dengan prosedur tersimpan, pemicu, dan fungsi yang ditentukan pengguna.
Membuat akun Azure Cosmos DB minimal untuk CORE (SQL) API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk API Core (SQL) sambil hanya menentukan properti sumber daya minimal yang diperlukan.
Membuat Azure Cosmos dengan SQL API dan beberapa kontainer

Sebarkan ke Azure
Templat membuat kontainer Cosmos dengan API SQL dan memungkinkan penambahan kontainer mulitple.
Membuat Akun SQL Azure Cosmos DB dengan data plane RBAC

Sebarkan ke Azure
Templat ini akan membuat akun SQL Cosmos, Definisi Peran yang dipertahankan secara asli, dan Penetapan Peran yang dikelola secara asli untuk identitas AAD.
Membuat akun Azure Cosmos DB tanpa server untuk SQL API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB tanpa server untuk API Core (SQL).
Membuat akun Azure Cosmos untuk Table API

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

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Table API di dua wilayah dan satu tabel dengan throughput skala otomatis.
Membuat akun Azure Cosmos dan Azure Web App tanpa sentuhan

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos, menyuntikkan titik akhir dan kunci Cosmos DB ke pengaturan Azure Web App, lalu menyebarkan aplikasi web ASP MVC dari GitHub.
Membuat akun Cosmos DB dengan Microsoft Defender diaktifkan

Sebarkan 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 merupakan lapisan keamanan Azure yang dapat mendeteksi upaya mengeksploitasi database pada akun Azure Cosmos DB Anda. Microsoft Defender untuk Azure Cosmos DB mendeteksi potensi injeksi SQL, pelaku jahat yang dikenal berdasarkan Inteligensi Ancaman Microsoft, pola akses yang mencurigakan, dan eksploitasi potensial database Anda melalui identitas yang disusupi atau orang dalam yang berbahaya.
Menyebarkan Azure Data Explorer DB dengan koneksi Cosmos DB

Sebarkan ke Azure
Sebarkan Azure Data Explorer DB dengan koneksi Cosmos DB.
Akun Azure Cosmos DB dengan Aplikasi Web

Sebarkan 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.

Definisi sumber daya templat ARM

Jenis sumber daya databaseAccounts dapat disebarkan dengan operasi yang menargetkan:

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

Format sumber daya

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "analyticalStorageConfiguration": {
      "schemaType": "string"
    },
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "migrationState": {
        "startTime": "string",
        "status": "string",
        "targetType": "string"
      },
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "connectorOffer": "Small",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "customerManagedKeyStatus": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "defaultPriorityLevel": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePerRegionPerPartitionAutoscale": "bool",
    "enablePriorityBasedExecution": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "PointInTime",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "restoreWithTtlDisabled": "bool",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

Objek BackupPolicy

Atur properti jenis untuk menentukan jenis objek.

Untuk Berkelanjutan, gunakan:

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

Untuk Berkala, gunakan:

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

Nilai properti

databaseAccounts

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.DocumentDB/databaseAccounts'
apiVersion Versi api sumber daya '2024-02-15-preview'
nama Nama sumber daya string (diperlukan)

Batas karakter: 3-44

Karakter yang valid:
Huruf kecil, angka, dan tanda hubung.

Mulai dengan huruf kecil atau angka.

Nama sumber daya harus unik di seluruh Azure.
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
tag Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam menampilkan dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". Kamus nama dan nilai tag. Lihat Tag dalam templat
jenis Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database. 'GlobalDocumentDB'
'MongoDB'
'Uraikan'
identitas Identitas untuk sumber daya. ManagedServiceIdentity
properti Properti untuk membuat dan memperbarui akun database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (diperlukan)

ManagedServiceIdentity

Nama Deskripsi Nilai
jenis 'Tidak Ada'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.
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

Nama Deskripsi Nilai
{properti yang disesuaikan} Komponen1Jq1T4ISchemasManagedserviceidentityProper...

Komponen1Jq1T4ISchemasManagedserviceidentityProper...

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nama Deskripsi Nilai
analyticalStorageConfiguration Properti khusus penyimpanan analitis. AnalyticalStorageConfiguration
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 Kapabilitas[]
kapasitas Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun. Kapasitas
connectorOffer Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB. 'Kecil'
consistencyPolicy Kebijakan konsistensi untuk akun Cosmos DB. ConsistencyPolicy
cors Kebijakan CORS untuk akun database Cosmos DB. CorsPolicy[]
createMode Enum untuk menunjukkan mode pembuatan akun. 'Default'
'PointInTimeRestore'
'Pulihkan'
customerManagedKeyStatus Menunjukkan status fitur Kunci yang Dikelola Pelanggan di akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah. string
databaseAccountOfferType Jenis penawaran untuk database 'Standar' (diperlukan)
defaultIdentity Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi. string
defaultPriorityLevel Enum untuk menunjukkan Tingkat Prioritas default permintaan untuk Eksekusi Berbasis Prioritas. 'Tinggi'
'Rendah'
diagnosticLogSettings Objek yang mewakili pengaturan log Diagnostik yang berbeda untuk Akun Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Menonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun bool
disableLocalAuth Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi. bool
enableAnalyticalStorage Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan. bool
enableAutomaticFailover Memungkinkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tersebut tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun tersebut. bool
enableBurstCapacity Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau Kapasitas Burst pada akun bool
enableCassandraConnector Mengaktifkan konektor cassandra pada akun Cosmos DB C* bool
enableFreeTier Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan. bool
enableMaterializedViews Bendera untuk menunjukkan apakah akan mengaktifkan MaterializedViews pada akun Cosmos DB bool
enableMultipleWriteLocations Mengaktifkan akun untuk menulis di beberapa lokasi bool
enablePartitionMerge Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Penggabungan Partisi pada akun bool
enablePerRegionPerPartitionAutoscale Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau skala otomatis Per-Region Per partisi pada akun bool
enablePriorityBasedExecution Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau Eksekusi Berbasis Prioritas pada akun bool
ipRules Daftar IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network. bool
keyVaultKeyUri URI brankas kunci string
locations Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB. Location[] (wajib)
minimalTlsVersion Menunjukkan versi Tls minimum yang diizinkan. Defaultnya adalah Tls 1.0, kecuali Cassandra dan Mongo API, yang hanya berfungsi dengan Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass 'AzureServices'
'None': Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
networkAclBypassResourceIds Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB. string[]
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan 'Dinonaktifkan'
'Diaktifkan'
'SecuredByPerimeter'
restoreParameters Parameter untuk menunjukkan informasi tentang pemulihan. RestoreParameters
virtualNetworkRules Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nama Deskripsi Nilai
schemaType Menjelaskan jenis skema untuk penyimpanan analitis. 'FullFidelity'
'WellDefined'

ApiProperties

Nama Deskripsi Nilai
serverVersion Menjelaskan ServerVersion dari akun MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

Nama Deskripsi Nilai
migrationState Objek yang mewakili status migrasi antara kebijakan pencadangan. BackupPolicyMigrationState
jenis Mengatur jenis objek Berkelanjutan
Berkala (diperlukan)

BackupPolicyMigrationState

Nama Deskripsi Nilai
startTime Waktu dimulainya migrasi kebijakan pencadangan (format ISO-8601). string
status Menjelaskan status migrasi antar jenis kebijakan pencadangan. 'Selesai'
'Gagal'
'InProgress'
'Tidak Valid'
targetType Menjelaskan jenis kebijakan pencadangan target dari migrasi kebijakan pencadangan. 'Berkelanjutan'
'Berkala'

ContinuousModeBackupPolicy

Nama Deskripsi Nilai
jenis Menjelaskan mode pencadangan. 'Berkelanjutan' (diperlukan)
continuousModeProperties Nilai konfigurasi untuk pencadangan mode berkelanjutan ContinuousModeProperties

ContinuousModeProperties

Nama Deskripsi Nilai
Tier Enum untuk menunjukkan jenis mode pencadangan Continuos 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Nama Deskripsi Nilai
jenis Menjelaskan mode pencadangan. 'Berkala' (diperlukan)
periodicModeProperties Nilai konfigurasi untuk pencadangan mode berkala PeriodicModeProperties

PeriodicModeProperties

Nama Deskripsi Nilai
backupIntervalInMinutes Bilangan bulat yang mewakili interval dalam hitungan menit di antara dua cadangan int

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

Batasan:
Nilai min = 0
backupStorageRedundancy Enum untuk menunjukkan jenis residensi cadangan 'Geo'
'Lokal'
'Zona'

Kemampuan

Nama Deskripsi Nilai
nama Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga termasuk "EnableTable" dan "EnableGremlin". string

Kapasitas

Nama Deskripsi Nilai
totalThroughputLimit Batas throughput total yang diberlakukan pada akun. TotalThroughputLimit 2000 memberlakukan batas throughput maks yang ketat yang dapat disediakan pada akun tersebut menjadi 2000. TotalThroughputLimit -1 menunjukkan tidak ada batasan penyediaan throughput. int

ConsistencyPolicy

Nama Deskripsi Nilai
defaultConsistencyLevel Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Akhirnya'
'Sesi'
'Kuat' (diperlukan)
maxIntervalInSeconds Ketika digunakan dengan tingkat konsistensi Keusangan Terikat, nilai ini menunjukkan jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Batasan:
Nilai min = 5
Nilai maks = 86400
maxStalenessPrefix Saat 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

Batasan:
Nilai min = 1
Nilai maks = 2147483647

CorsPolicy

Nama Deskripsi Nilai
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 dapat dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan. string
maxAgeInSeconds Jumlah waktu maksimum browser harus menyimpan cache permintaan OPTIONS preflight. int

Batasan:
Nilai min = 1
Nilai maks = 2147483647

DiagnosticLogSettings

Nama Deskripsi Nilai
enableFullTextQuery 'False'
'Tidak Ada'
'True': Menjelaskan tingkat detail kueri mana yang akan dicatat.

IpAddressOrRange

Nama Deskripsi Nilai
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

Lokasi

Nama Deskripsi Nilai
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

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

RestoreParameters

Nama Deskripsi Nilai
databaseToRestore Daftar database tertentu yang tersedia untuk dipulihkan. DatabaseRestoreResource[]
gremlinDatabasesToRestore Daftar database gremlin tertentu yang tersedia untuk dipulihkan. GremlinDatabaseRestoreResource[]
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
restoreWithTtlDisabled Menentukan apakah akun yang dipulihkan akan menonaktifkan Time-To-Live setelah pemulihan berhasil. bool
sourceBackupLocation Lokasi pencadangan sumber untuk pemulihan. string
tablesToRestore Daftar tabel tertentu yang tersedia untuk dipulihkan. string[]

DatabaseRestoreResource

Nama Deskripsi Nilai
collectionNames Nama koleksi yang tersedia untuk dipulihkan. string[]
databaseName Nama database yang tersedia untuk dipulihkan. string

GremlinDatabaseRestoreResource

Nama Deskripsi Nilai
databaseName Nama database gremlin yang tersedia untuk dipulihkan. string
graphNames Nama grafik yang tersedia untuk dipulihkan. string[]

VirtualNetworkRule

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

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
CI/CD menggunakan Jenkins di Azure Container Service (AKS)

Sebarkan 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 dapat dikelola. Dengan menyiapkan build berkelanjutan untuk menghasilkan gambar dan orkestrasi kontainer Anda, Anda dapat meningkatkan kecepatan dan keandalan penyebaran Anda.
Aplikasi Web dengan SQL Database, Azure Cosmos DB, Azure Search

Sebarkan ke Azure
Templat ini menyediakan Aplikasi Web, SQL Database, Azure Cosmos DB, Azure Search, dan Application Insights.
Membuat akun Azure Cosmos DB untuk Cassandra API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan keyspace dan tabel dengan throughput khusus.
Membuat akun Azure Cosmos DB skala otomatis untuk Cassandra API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Cassandra API di dua wilayah dengan keyspace dan tabel dengan throughput skala otomatis.
Membuat Akun Azure CosmosDB

Sebarkan ke Azure
Templat ARM ini dimaksudkan untuk membuat Akun CosmosDB dengan cepat dengan nilai minimal yang diperlukan
Membuat akun Azure Cosmos DB di beberapa wilayah

Sebarkan 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.
Membuat akun Azure Cosmos DB tingkat gratis

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB tingkat gratis untuk SQL API dengan database dengan throughput dan kontainer bersama.
Membuat akun Azure Cosmos DB untuk Gremlin API

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

Sebarkan 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.
Membuat akun Azure Cosmos untuk MongoDB API

Sebarkan 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.
Membuat akun Azure Cosmos untuk skala otomatis MongoDB API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk MongoDB API 4.2 di dua wilayah menggunakan throughput skala otomatis bersama dan khusus.
Membuat Akun Azure Cosmos DB dengan titik akhir privat

Sebarkan ke Azure
Templat ini akan membuat akun Cosmos, jaringan virtual, dan titik akhir privat yang mengekspos akun Cosmos ke jaringan virtual.
Membuat akun Azure Cosmos DB untuk CORE (SQL) API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput dengan beberapa opsi lainnya.
SQL API akun Azure Cosmos DB dengan penyimpanan analitis

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer yang dikonfigurasi dengan penyimpanan analitis.
Membuat SQL API akun Azure Cosmos DB dengan skala otomatis

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput skala otomatis dengan beberapa opsi lainnya.
Membuat prosedur tersimpan API Azure Cosmos DB Core (SQL)

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk CORE (SQL) API dan kontainer dengan prosedur tersimpan, pemicu, dan fungsi yang ditentukan pengguna.
Membuat akun Azure Cosmos DB minimal untuk CORE (SQL) API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk API Core (SQL) sambil hanya menentukan properti sumber daya minimal yang diperlukan.
Membuat Azure Cosmos dengan SQL API dan beberapa kontainer

Sebarkan ke Azure
Templat membuat kontainer Cosmos dengan API SQL dan memungkinkan penambahan kontainer mulitple.
Membuat Akun SQL Azure Cosmos DB dengan data plane RBAC

Sebarkan ke Azure
Templat ini akan membuat akun SQL Cosmos, Definisi Peran yang dipertahankan secara asli, dan Penetapan Peran yang dikelola secara asli untuk identitas AAD.
Membuat akun Azure Cosmos DB Tanpa Server untuk SQL API

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB tanpa server untuk API Core (SQL).
Membuat akun Azure Cosmos untuk Table API

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

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos DB untuk Table API di dua wilayah dan satu tabel dengan throughput skala otomatis.
Membuat akun Azure Cosmos dan Azure Web App tanpa sentuhan

Sebarkan ke Azure
Templat ini membuat akun Azure Cosmos, menyuntikkan titik akhir dan kunci Cosmos DB ke pengaturan Azure Web App, lalu menyebarkan aplikasi web ASP MVC dari GitHub.
Membuat akun Cosmos DB dengan Microsoft Defender diaktifkan

Sebarkan 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 merupakan lapisan keamanan Azure yang dapat mendeteksi upaya mengeksploitasi database pada akun Azure Cosmos DB Anda. Microsoft Defender untuk Azure Cosmos DB mendeteksi potensi injeksi SQL, aktor jahat yang diketahui berdasarkan Inteligensi Ancaman Microsoft, pola akses yang mencurigakan, dan potensi eksploitasi database Anda melalui identitas yang disusupi atau orang dalam yang berbahaya.
Menyebarkan Azure Data Explorer DB dengan koneksi Cosmos DB

Sebarkan ke Azure
Sebarkan Azure Data Explorer DB dengan koneksi Cosmos DB.
Akun Azure Cosmos DB dengan Aplikasi Web

Sebarkan 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.

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 mengubah log.

Format sumber daya

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      connectorOffer = "Small"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      customerManagedKeyStatus = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      defaultPriorityLevel = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePerRegionPerPartitionAutoscale = bool
      enablePriorityBasedExecution = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "PointInTime"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        restoreWithTtlDisabled = bool
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

Objek BackupPolicy

Atur properti jenis untuk menentukan jenis objek.

Untuk Berkelanjutan, gunakan:

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

Untuk Berkala, gunakan:

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

Nilai properti

databaseAccounts

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.DocumentDB/databaseAccounts@2024-02-15-preview"
nama Nama sumber daya string (diperlukan)

Batas karakter: 3-44

Karakter yang valid:
Huruf kecil, angka, dan tanda hubung.

Mulai dengan huruf kecil atau angka.

Nama sumber daya harus unik di seluruh Azure.
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
parent_id Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut. string (diperlukan)
tag Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam menampilkan dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". Kamus nama dan nilai tag.
jenis Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database. "GlobalDocumentDB"
"MongoDB"
"Uraikan"
identitas Identitas untuk sumber daya. ManagedServiceIdentity
properti Properti untuk membuat dan memperbarui akun database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (diperlukan)

ManagedServiceIdentity

Nama Deskripsi Nilai
jenis "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Jenis identitas yang digunakan untuk sumber daya. Jenis "SystemAssigned,UserAssigned" mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis "Tidak Ada" akan menghapus identitas apa pun dari layanan.
identity_ids 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}'. Array ID identitas pengguna.

ManagedServiceIdentityUserAssignedIdentities

Nama Deskripsi Nilai
{properti yang disesuaikan} Komponen1Jq1T4ISchemasManagedserviceidentityProper...

Komponen1Jq1T4ISchemasManagedserviceidentityProper...

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nama Deskripsi Nilai
analyticalStorageConfiguration Properti khusus penyimpanan analitis. AnalyticalStorageConfiguration
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 Kapabilitas[]
kapasitas Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun. Kapasitas
connectorOffer Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB. "Kecil"
consistencyPolicy Kebijakan konsistensi untuk akun Cosmos DB. ConsistencyPolicy
cors Kebijakan CORS untuk akun database Cosmos DB. CorsPolicy[]
createMode Enum untuk menunjukkan mode pembuatan akun. "Default"
"PointInTimeRestore"
"Pulihkan"
customerManagedKeyStatus Menunjukkan status fitur Kunci yang Dikelola Pelanggan pada akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah. string
databaseAccountOfferType Jenis penawaran untuk database "Standar" (diperlukan)
defaultIdentity Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi. string
defaultPriorityLevel Enum untuk menunjukkan Tingkat Prioritas default permintaan untuk Eksekusi Berbasis Prioritas. "Tinggi"
"Rendah"
diagnosticLogSettings Objek yang mewakili pengaturan log Diagnostik yang berbeda untuk Akun Cosmos DB. DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess Menonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun bool
disableLocalAuth Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi. bool
enableAnalyticalStorage Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan. bool
enableAutomaticFailover Mengaktifkan failover otomatis wilayah tulis jika wilayah tersebut tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun tersebut. bool
enableBurstCapacity Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Kapasitas Burst pada akun bool
enableCassandraConnector Mengaktifkan konektor cassandra pada akun Cosmos DB C* bool
enableFreeTier Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan. bool
enableMaterializedViews Bendera untuk menunjukkan apakah akan mengaktifkan MaterializedViews pada akun Cosmos DB bool
enableMultipleWriteLocations Mengaktifkan akun untuk menulis di beberapa lokasi bool
enablePartitionMerge Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Gabungan Partisi pada akun bool
enablePerRegionPerPartitionAutoscale Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau skala otomatis Per-Region Per partisi pada akun bool
enablePriorityBasedExecution Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Eksekusi Berbasis Prioritas pada akun bool
ipRules Daftar IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network. bool
keyVaultKeyUri URI brankas kunci string
locations Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB. Location[] (diperlukan)
minimalTlsVersion Menunjukkan versi Tls minimum yang diizinkan. Defaultnya adalah Tls 1.0, kecuali Cassandra dan Mongo API, yang hanya berfungsi dengan Tls 1.2. "Tls"
"Tls11"
"Tls12"
networkAclBypass "AzureServices"
"None": Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
networkAclBypassResourceIds Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB. string[]
publicNetworkAccess Apakah permintaan dari Jaringan Publik diizinkan "Dinonaktifkan"
"Diaktifkan"
"SecuredByPerimeter"
restoreParameters Parameter untuk menunjukkan informasi tentang pemulihan. RestoreParameters
virtualNetworkRules Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nama Deskripsi Nilai
schemaType Menjelaskan jenis skema untuk penyimpanan analitis. "FullFidelity"
"WellDefined"

ApiProperties

Nama Deskripsi Nilai
serverVersion Menjelaskan ServerVersion dari akun MongoDB. "3.2"
"3.6"
"4.0"
"4.2"

BackupPolicy

Nama Deskripsi Nilai
migrationState Objek yang mewakili status migrasi antara kebijakan pencadangan. BackupPolicyMigrationState
jenis Mengatur jenis objek Berkelanjutan
Berkala (diperlukan)

BackupPolicyMigrationState

Nama Deskripsi Nilai
startTime Waktu dimulainya migrasi kebijakan pencadangan (format ISO-8601). string
status Menjelaskan status migrasi antar jenis kebijakan pencadangan. "Selesai"
"Gagal"
"InProgress"
"Tidak Valid"
targetType Menjelaskan jenis kebijakan pencadangan target dari migrasi kebijakan pencadangan. "Berkelanjutan"
"Berkala"

ContinuousModeBackupPolicy

Nama Deskripsi Nilai
jenis Menjelaskan mode pencadangan. "Berkelanjutan" (diperlukan)
continuousModeProperties Nilai konfigurasi untuk pencadangan mode berkelanjutan ContinuousModeProperties

ContinuousModeProperties

Nama Deskripsi Nilai
Tier Enum untuk menunjukkan jenis mode pencadangan Continuos "Continuous30Days"
"Continuous7Days"

PeriodicModeBackupPolicy

Nama Deskripsi Nilai
jenis Menjelaskan mode pencadangan. "Berkala" (diperlukan)
periodicModeProperties Nilai konfigurasi untuk pencadangan mode berkala PeriodicModeProperties

PeriodicModeProperties

Nama Deskripsi Nilai
backupIntervalInMinutes Bilangan bulat yang mewakili interval dalam hitungan menit di antara dua cadangan int

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

Batasan:
Nilai min = 0
backupStorageRedundancy Enum untuk menunjukkan jenis residensi cadangan "Geo"
"Lokal"
"Zona"

Kemampuan

Nama Deskripsi Nilai
nama Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga termasuk "EnableTable" dan "EnableGremlin". string

Kapasitas

Nama Deskripsi Nilai
totalThroughputLimit Batas throughput total yang diberlakukan pada akun. TotalThroughputLimit 2000 memberlakukan batas throughput maks yang ketat yang dapat disediakan pada akun tersebut menjadi 2000. TotalThroughputLimit -1 menunjukkan tidak ada batasan penyediaan throughput. int

ConsistencyPolicy

Nama Deskripsi Nilai
defaultConsistencyLevel Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Akhirnya"
"Sesi"
"Kuat" (diperlukan)
maxIntervalInSeconds Ketika digunakan dengan tingkat konsistensi Keusangan Terikat, nilai ini menunjukkan jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'. int

Batasan:
Nilai min = 5
Nilai maks = 86400
maxStalenessPrefix Saat 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

Batasan:
Nilai min = 1
Nilai maks = 2147483647

CorsPolicy

Nama Deskripsi Nilai
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 dapat dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan. string
maxAgeInSeconds Jumlah waktu maksimum browser harus menyimpan cache permintaan OPTIONS preflight. int

Batasan:
Nilai min = 1
Nilai maks = 2147483647

DiagnosticLogSettings

Nama Deskripsi Nilai
enableFullTextQuery "False"
"Tidak Ada"
"True": Menjelaskan tingkat detail kueri mana yang akan dicatat.

IpAddressOrRange

Nama Deskripsi Nilai
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

Lokasi

Nama Deskripsi Nilai
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

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

RestoreParameters

Nama Deskripsi Nilai
databaseToRestore Daftar database tertentu yang tersedia untuk dipulihkan. DatabaseRestoreResource[]
gremlinDatabasesToRestore Daftar database gremlin tertentu yang tersedia untuk dipulihkan. GremlinDatabaseRestoreResource[]
restoreMode Menjelaskan mode pemulihan. "PointInTime"
restoreSource Id akun database yang dapat dipulihkan dari mana 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
restoreWithTtlDisabled Menentukan apakah akun yang dipulihkan akan menonaktifkan Time-To-Live setelah pemulihan berhasil. bool
sourceBackupLocation Lokasi pencadangan sumber untuk pemulihan. string
tablesToRestore Daftar tabel tertentu yang tersedia untuk dipulihkan. string[]

DatabaseRestoreResource

Nama Deskripsi Nilai
collectionNames Nama koleksi yang tersedia untuk dipulihkan. string[]
databaseName Nama database yang tersedia untuk dipulihkan. string

GremlinDatabaseRestoreResource

Nama Deskripsi Nilai
databaseName Nama database gremlin yang tersedia untuk dipulihkan. string
graphNames Nama grafik yang tersedia untuk dipulihkan. string[]

VirtualNetworkRule

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