Share via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers

  • Makale

Bicep kaynak tanımı

databaseAccounts/sqlDatabases/containers kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          {
            order: 'string'
            path: 'string'
          }
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Özellik değerleri

databaseAccounts/sqlDatabases/containers

Ad Açıklama Değer
name Kaynak adı

Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
location Kaynağın ait olduğu kaynak grubunun konumu. string
etiketler Etiketler, kaynağı açıklayan anahtar-değer çiftlerinin listesidir. Bu etiketler, bu kaynağı (kaynak grupları arasında) görüntüleme ve gruplandırma işlemlerinde kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri "Tablo", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir. Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler
Üst Bicep'te alt kaynak için üst kaynağı belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak.		 Kaynak türü için sembolik ad: sqlDatabases
identity Kaynağın kimliği. ManagedServiceIdentity
properties Azure Cosmos DB kapsayıcısı oluşturma ve güncelleştirme özellikleri. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (gerekli)

ManagedServiceIdentity

Ad Açıklama Değer
tür 'Yok'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': Kaynak için kullanılan kimlik türü. 'SystemAssigned,UserAssigned' türü hem örtük olarak oluşturulmuş bir kimlik hem de kullanıcı tarafından atanan kimlikler kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.
userAssignedIdentities Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Ad Açıklama Değer
{özelleştirilmiş özellik} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermiyor. Tüm özellikler ReadOnly'dır.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Ad Açıklama Değer
seçenekler İstek için uygulanacak bir anahtar-değer seçenekleri çifti. Bu, istekle birlikte gönderilen üst bilgilere karşılık gelir. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
kaynak Kapsayıcının standart JSON biçimi SqlContainerResourceOrSqlContainerGetPropertiesResou... (gerekli)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Ad Açıklama Değer
autoscaleSettings Otomatik Ölçeklendirme ayarlarını belirtir. Not: Aktarım hızı veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir. Otomatik ÖlçeklendirmeAyarlar
aktarım hızı Saniye başına İstek Birimleri. Örneğin, "aktarım hızı": 10000. int

Otomatik ÖlçeklendirmeAyarlar

Ad Açıklama Değer
maxThroughput Kaynağın ölçeğini artırabileceği en yüksek aktarım hızını temsil eder. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Ad Açıklama Değer
analyticalStorageTtl Analitik TTL. int
clientEncryptionPolicy Kapsayıcı için istemci şifreleme ilkesi. ClientEncryptionPolicy
computedProperties Hesaplanan özelliklerin listesi ComputedProperty[]
conflictResolutionPolicy Kapsayıcı için çakışma çözümleme ilkesi. ConflictResolutionPolicy
createMode Kaynak oluşturma modunu belirtmek için sabit listesi. 'Varsayılan'
'PointInTimeRestore'
'Geri Yükle'
defaultTtl Varsayılan yaşam süresi int
kimlik Cosmos DB SQL kapsayıcısının adı dize (gerekli)
indexingPolicy Dizin oluşturma ilkesinin yapılandırması. Varsayılan olarak, dizin oluşturma kapsayıcı içindeki tüm belge yolları için otomatiktir IndexingPolicy
materializedViewDefinition Gerçekleştirilmiş Görünümleri tanımlama yapılandırması. Bu yalnızca Gerçekleştirilmiş Görünüm kapsayıcısı oluşturmak için belirtilmelidir. MaterializedViewDefinition
partitionKey Verileri birden çok bölüme bölmek için kullanılacak bölüm anahtarının yapılandırması ContainerPartitionKey
restoreParameters Geri yükleme hakkındaki bilgileri gösteren parametreler ResourceRestoreParameters
uniqueKeyPolicy Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlamalarını belirtmek için benzersiz anahtar ilkesi yapılandırması. UniqueKeyPolicy

ClientEncryptionPolicy

Ad Açıklama Değer
includedPaths Yola özgü ayarlarla birlikte şifreleme gerektiren öğenin yolları. ClientEncryptionIncludedPath[] (gerekli)
policyFormatVersion İstemci şifreleme ilkesi tanımının sürümü. Desteklenen sürümler 1 ve 2'dir. Sürüm 2, kimlik ve bölüm anahtarı yolu şifrelemeyi destekler. int (gerekli)

Kısıtlama -ları:
Min değer = 1
En yüksek değer = 2

ClientEncryptionIncludedPath

Ad Açıklama Değer
clientEncryptionKeyId Yolu şifrelemek için kullanılacak İstemci Şifreleme Anahtarının tanımlayıcısı. dize (gerekli)
Encryptionalgorithm Kullanılacak şifreleme algoritması. Örneğin- AEAD_AES_256_CBC_HMAC_SHA256. dize (gerekli)
encryptionType Gerçekleştirilecek şifreleme türü. Örneğin- Deterministik, Rastgele. dize (gerekli)
path Şifrelenmesi gereken yol. dize (gerekli)

ComputedProperty

Ad Açıklama Değer
name Hesaplanan özelliğin adı, örneğin - "cp_lowerName" string
query Hesaplanan özelliğin değerini değerlendiren sorgu, örneğin: "SELECT VALUE LOWER(c.name) FROM c" string

ConflictResolutionPolicy

Ad Açıklama Değer
conflictResolutionPath LastWriterWins modunda çakışma çözümleme yolu. string
conflictResolutionProcedure Özel mod durumunda çakışmaları çözümleme yordamı. string
mod Çakışma çözümleme modunu gösterir. 'Özel'
'LastWriterWins'

IndexingPolicy

Ad Açıklama Değer
otomatik Dizin oluşturma ilkesinin otomatik olup olmadığını gösterir bool
compositeIndexes Bileşik yol listesi listesi CompositePath[]
excludedPaths Dizin oluşturmanın dışında tutulacak yolların listesi ExcludedPath[]
includedPaths Dizine eklenecek yolların listesi IncludedPath[]
indexingMode Dizin oluşturma modunu gösterir. 'tutarlı'
'Tembel'
'hiçbiri'
spatialIndexes Uzamsal özelliklerin listesi SpatialSpec[]

CompositePath

Ad Açıklama Değer
sıra Bileşik yollar için sıralama düzeni. 'artan'
'azalan'
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

ExcludedPath

Ad Açıklama Değer
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

IncludedPath

Ad Açıklama Değer
Dizin Bu yol için dizin listesi Dizinler[]
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

Dizinler

Ad Açıklama Değer
dataType Dizin oluşturma davranışının uygulandığı veri türü. 'LineString'
'MultiPolygon'
'Sayı'
'Nokta'
'Çokgen'
'Dize'
Tür Dizinin türünü gösterir. 'Karma'
'Aralık'
'Uzamsal'
duyarlık Dizinin duyarlığı. -1 maksimum duyarlıktır. int

SpatialSpec

Ad Açıklama Değer
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string
types Yolun uzamsal türü listesi Herhangi birini içeren dize dizisi:
'LineString'
'MultiPolygon'
'Point'
'Çokgen'

MaterializedViewDefinition

Ad Açıklama Değer
tanım Tanım, Gerçekleştirilmiş Görünüm kapsayıcısına doldurulmak üzere kaynak kapsayıcıdan veri getirmek için kullanılacak bir SQL sorgusu olmalıdır. dize (gerekli)
sourceCollectionId Gerçekleştirilmiş Görünümün oluşturulacağı kaynak kapsayıcının adı. dize (gerekli)

ContainerPartitionKey

Ad Açıklama Değer
Tür Bölümleme için kullanılan algoritma türünü gösterir. MultiHash için kapsayıcı oluşturma için birden çok bölüm anahtarı (en fazla üç bölüm anahtarı) desteklenir 'Karma'
'MultiHash'
'Aralık'
Yol Kapsayıcı içindeki hangi verilerin bölümlenebileceğini kullanan yolların listesi string[]
sürüm Bölüm anahtarı tanımının sürümünü gösterir int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 2

ResourceRestoreParameters

Ad Açıklama Değer
restoreSource Geri yüklemenin başlatılması gereken geri yüklenebilir veritabanı hesabının kimliği. Örneğin: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restoreableDatabaseAccounts/{restoreableDatabaseAccountName} string
restoreTimestampInUtc Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi). string
restoreWithTtlDisabled Geri yüklemenin başarılı olması durumunda geri yüklenen hesabın Yaşam Süresi'nin devre dışı bırakılıp bırakılmayacağını belirtir. bool

UniqueKeyPolicy

Ad Açıklama Değer
uniqueKeys Üzerinde, Azure Cosmos DB hizmetindeki koleksiyondaki belgeler üzerinde benzersizlik kısıtlaması uygulayan benzersiz anahtarların listesi. UniqueKey[]

UniqueKey

Ad Açıklama Değer
Yol Yolların listesi Azure Cosmos DB hizmetindeki her belge için benzersiz olmalıdır string[]

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
Ücretsiz katman Azure Cosmos DB hesabı oluşturma

Azure’a dağıtın		 Bu şablon, paylaşılan aktarım hızına ve kapsayıcıya sahip bir veritabanıyla SQL API'si için serbest katmanlı bir Azure Cosmos DB hesabı oluşturur.
Çekirdek (SQL) API'si için Azure Cosmos DB hesabı oluşturma

Azure’a dağıtın		 Bu şablon, birden çok seçenekle aktarım hızına sahip bir veritabanı ve kapsayıcı ile Core (SQL) API'si için bir Azure Cosmos hesabı oluşturur.
Analiz deposu ile Azure Cosmos DB hesabı SQL API'si

Azure’a dağıtın		 Bu şablon, analiz deposuyla yapılandırılmış bir veritabanı ve kapsayıcı ile Çekirdek (SQL) API'si için bir Azure Cosmos hesabı oluşturur.
Otomatik ölçeklendirme ile Azure Cosmos DB hesabı SQL API'si oluşturma

Azure’a dağıtın		 Bu şablon, birden çok seçenekle otomatik ölçeklendirme aktarım hızına sahip bir veritabanı ve kapsayıcı ile Core (SQL) API'si için bir Azure Cosmos hesabı oluşturur.
Azure Cosmos DB Core (SQL) API saklı yordamları oluşturma

Azure’a dağıtın		 Bu şablon, Core (SQL) API için bir Azure Cosmos DB hesabı ve saklı yordam, tetikleyici ve kullanıcı tanımlı işlev içeren bir kapsayıcı oluşturur.
Cosmos DB bağlantısıyla Azure Veri Gezgini DB'yi dağıtma

Azure’a dağıtın		 Cosmos DB bağlantısıyla Azure Veri Gezgini DB'yi dağıtın.

ARM şablonu kaynak tanımı

databaseAccounts/sqlDatabases/containers kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          {
            "order": "string",
            "path": "string"
          }
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Özellik değerleri

databaseAccounts/sqlDatabases/containers

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'
apiVersion Kaynak API'sinin sürümü '2024-02-15-preview'
name Kaynak adı

JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
location Kaynağın ait olduğu kaynak grubunun konumu. string
etiketler Etiketler, kaynağı açıklayan anahtar-değer çiftlerinin listesidir. Bu etiketler, bu kaynağı (kaynak grupları arasında) görüntüleme ve gruplandırma işlemlerinde kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri "Tablo", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir. Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler
identity Kaynağın kimliği. ManagedServiceIdentity
properties Azure Cosmos DB kapsayıcısı oluşturma ve güncelleştirme özellikleri. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (gerekli)

ManagedServiceIdentity

Ad Açıklama Değer
tür 'Yok'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': Kaynak için kullanılan kimlik türü. 'SystemAssigned,UserAssigned' türü hem örtük olarak oluşturulmuş bir kimlik hem de kullanıcı tarafından atanan kimlikler kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.
userAssignedIdentities Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Ad Açıklama Değer
{özelleştirilmiş özellik} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermiyor. Tüm özellikler ReadOnly'dır.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Ad Açıklama Değer
seçenekler İstek için uygulanacak bir anahtar-değer seçenekleri çifti. Bu, istekle birlikte gönderilen üst bilgilere karşılık gelir. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
kaynak Kapsayıcının standart JSON biçimi SqlContainerResourceOrSqlContainerGetPropertiesResou... (gerekli)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Ad Açıklama Değer
autoscaleSettings Otomatik Ölçeklendirme ayarlarını belirtir. Not: Aktarım hızı veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir. Otomatik ÖlçeklendirmeAyarlar
aktarım hızı Saniye başına İstek Birimleri. Örneğin, "aktarım hızı": 10000. int

Otomatik ÖlçeklendirmeAyarlar

Ad Açıklama Değer
maxThroughput Kaynağın ölçeğini artırabileceği en yüksek aktarım hızını temsil eder. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Ad Açıklama Değer
analyticalStorageTtl Analitik TTL. int
clientEncryptionPolicy Kapsayıcı için istemci şifreleme ilkesi. ClientEncryptionPolicy
computedProperties Hesaplanan özelliklerin listesi ComputedProperty[]
conflictResolutionPolicy Kapsayıcı için çakışma çözümleme ilkesi. ConflictResolutionPolicy
createMode Kaynak oluşturma modunu belirtmek için sabit listesi. 'Varsayılan'
'PointInTimeRestore'
'Geri Yükle'
defaultTtl Varsayılan yaşam süresi int
kimlik Cosmos DB SQL kapsayıcısının adı dize (gerekli)
indexingPolicy Dizin oluşturma ilkesinin yapılandırması. Varsayılan olarak, dizin oluşturma kapsayıcı içindeki tüm belge yolları için otomatiktir IndexingPolicy
materializedViewDefinition Gerçekleştirilmiş Görünümleri tanımlama yapılandırması. Bu yalnızca Gerçekleştirilmiş Görünüm kapsayıcısı oluşturmak için belirtilmelidir. MaterializedViewDefinition
partitionKey Verileri birden çok bölüme bölmek için kullanılacak bölüm anahtarının yapılandırması ContainerPartitionKey
restoreParameters Geri yükleme hakkındaki bilgileri gösteren parametreler ResourceRestoreParameters
uniqueKeyPolicy Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlamalarını belirtmek için benzersiz anahtar ilkesi yapılandırması. UniqueKeyPolicy

ClientEncryptionPolicy

Ad Açıklama Değer
includedPaths Yola özgü ayarlarla birlikte şifreleme gerektiren öğenin yolları. ClientEncryptionIncludedPath[] (gerekli)
policyFormatVersion İstemci şifreleme ilkesi tanımının sürümü. Desteklenen sürümler 1 ve 2'dir. Sürüm 2, kimlik ve bölüm anahtarı yolu şifrelemeyi destekler. int (gerekli)

Kısıtlama -ları:
Min değer = 1
En yüksek değer = 2

ClientEncryptionIncludedPath

Ad Açıklama Değer
clientEncryptionKeyId Yolu şifrelemek için kullanılacak İstemci Şifreleme Anahtarının tanımlayıcısı. dize (gerekli)
Encryptionalgorithm Kullanılacak şifreleme algoritması. Örneğin- AEAD_AES_256_CBC_HMAC_SHA256. dize (gerekli)
encryptionType Gerçekleştirilecek şifreleme türü. Örneğin- Deterministik, Rastgele. dize (gerekli)
path Şifrelenmesi gereken yol. dize (gerekli)

ComputedProperty

Ad Açıklama Değer
name Hesaplanan özelliğin adı, örneğin - "cp_lowerName" string
query Hesaplanan özelliğin değerini değerlendiren sorgu, örneğin: "SELECT VALUE LOWER(c.name) FROM c" string

ConflictResolutionPolicy

Ad Açıklama Değer
conflictResolutionPath LastWriterWins modunda çakışma çözümleme yolu. string
conflictResolutionProcedure Özel mod durumunda çakışmaları çözümleme yordamı. string
mod Çakışma çözümleme modunu gösterir. 'Özel'
'LastWriterWins'

IndexingPolicy

Ad Açıklama Değer
otomatik Dizin oluşturma ilkesinin otomatik olup olmadığını gösterir bool
compositeIndexes Bileşik yol listesi listesi CompositePath[]
excludedPaths Dizin oluşturmanın dışında tutulacak yolların listesi ExcludedPath[]
includedPaths Dizine eklenecek yolların listesi IncludedPath[]
indexingMode Dizin oluşturma modunu gösterir. 'tutarlı'
'Tembel'
'hiçbiri'
spatialIndexes Uzamsal özelliklerin listesi SpatialSpec[]

CompositePath

Ad Açıklama Değer
sıra Bileşik yollar için sıralama düzeni. 'artan'
'azalan'
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

ExcludedPath

Ad Açıklama Değer
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

IncludedPath

Ad Açıklama Değer
Dizin Bu yol için dizin listesi Dizinler[]
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

Dizinler

Ad Açıklama Değer
dataType Dizin oluşturma davranışının uygulandığı veri türü. 'LineString'
'MultiPolygon'
'Sayı'
'Nokta'
'Çokgen'
'Dize'
Tür Dizinin türünü gösterir. 'Karma'
'Aralık'
'Uzamsal'
duyarlık Dizinin duyarlığı. -1 maksimum duyarlıktır. int

SpatialSpec

Ad Açıklama Değer
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string
types Yolun uzamsal türünün listesi Herhangi birini içeren dize dizisi:
'LineString'
'MultiPolygon'
'Nokta'
'Çokgen'

MaterializedViewDefinition

Ad Açıklama Değer
tanım Tanım, Gerçekleştirilmiş Görünüm kapsayıcısına doldurulacak kaynak kapsayıcıdan veri getirmek için kullanılacak bir SQL sorgusu olmalıdır. dize (gerekli)
sourceCollectionId Gerçekleştirilmiş Görünümün oluşturulacağı kaynak kapsayıcının adı. dize (gerekli)

ContainerPartitionKey

Ad Açıklama Değer
Tür Bölümleme için kullanılan algoritma türünü gösterir. MultiHash için kapsayıcı oluşturma için birden çok bölüm anahtarı (en fazla üç bölüm anahtarı) desteklenir 'Karma'
'MultiHash'
'Aralık'
Yol Kapsayıcı içindeki hangi verilerin bölümlenebileceğini kullanan yolların listesi string[]
sürüm Bölüm anahtarı tanımının sürümünü gösterir int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 2

ResourceRestoreParameters

Ad Açıklama Değer
restoreSource Geri yüklemenin başlatılması gereken geri yüklenebilir veritabanı hesabının kimliği. Örneğin: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restoreableDatabaseAccounts/{restoreableDatabaseAccountName} string
restoreTimestampInUtc Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi). string
restoreWithTtlDisabled Geri yüklemenin başarılı olması durumunda geri yüklenen hesabın Yaşam Süresi'nin devre dışı bırakılıp bırakılmayacağını belirtir. bool

UniqueKeyPolicy

Ad Açıklama Değer
uniqueKeys Üzerinde, Azure Cosmos DB hizmetindeki koleksiyondaki belgeler üzerinde benzersizlik kısıtlaması uygulayan benzersiz anahtarların listesi. UniqueKey[]

UniqueKey

Ad Açıklama Değer
Yol Yolların listesi Azure Cosmos DB hizmetindeki her belge için benzersiz olmalıdır string[]

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
Ücretsiz katman Azure Cosmos DB hesabı oluşturma

Azure’a dağıtın		 Bu şablon, paylaşılan aktarım hızına ve kapsayıcıya sahip bir veritabanıyla SQL API'si için serbest katmanlı bir Azure Cosmos DB hesabı oluşturur.
Çekirdek (SQL) API'si için Azure Cosmos DB hesabı oluşturma

Azure’a dağıtın		 Bu şablon, birden çok seçenekle aktarım hızına sahip bir veritabanı ve kapsayıcı ile Core (SQL) API'si için bir Azure Cosmos hesabı oluşturur.
Analiz deposu ile Azure Cosmos DB hesabı SQL API'si

Azure’a dağıtın		 Bu şablon, analiz deposuyla yapılandırılmış bir veritabanı ve kapsayıcı ile Çekirdek (SQL) API'si için bir Azure Cosmos hesabı oluşturur.
Otomatik ölçeklendirme ile Azure Cosmos DB hesabı SQL API'si oluşturma

Azure’a dağıtın		 Bu şablon, birden çok seçenekle otomatik ölçeklendirme aktarım hızına sahip bir veritabanı ve kapsayıcı ile Core (SQL) API'si için bir Azure Cosmos hesabı oluşturur.
Azure Cosmos DB Core (SQL) API saklı yordamları oluşturma

Azure’a dağıtın		 Bu şablon, Core (SQL) API için bir Azure Cosmos DB hesabı ve saklı yordam, tetikleyici ve kullanıcı tanımlı işlev içeren bir kapsayıcı oluşturur.
Cosmos DB bağlantısıyla Azure Veri Gezgini DB'yi dağıtma

Azure’a dağıtın		 Cosmos DB bağlantısıyla Azure Veri Gezgini DB'yi dağıtın.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

databaseAccounts/sqlDatabases/containers kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            {
              order = "string"
              path = "string"
            }
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Özellik değerleri

databaseAccounts/sqlDatabases/containers

Ad Açıklama Değer
tür Kaynak türü "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview"
name Kaynak adı dize (gerekli)
location Kaynağın ait olduğu kaynak grubunun konumu. string
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: sqlDatabases kimliği
etiketler Etiketler, kaynağı açıklayan anahtar-değer çiftlerinin listesidir. Bu etiketler, bu kaynağı görüntülemek ve gruplandırırken (kaynak grupları arasında) kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri ayrıca "Table", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir. Etiket adlarının ve değerlerinin sözlüğü.
identity Kaynağın kimliği. ManagedServiceIdentity
properties Azure Cosmos DB kapsayıcısı oluşturma ve güncelleştirme özellikleri. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (gerekli)

ManagedServiceIdentity

Ad Açıklama Değer
tür "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Kaynak için kullanılan kimlik türü. "SystemAssigned,UserAssigned" türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. "Hiçbiri" türü hizmetten tüm kimlikleri kaldırır.
identity_ids Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtarı başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Kullanıcı kimliği kimlikleri dizisi.

ManagedServiceIdentityUserAssignedIdentities

Ad Açıklama Değer
{özelleştirilmiş özellik} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermez. Tüm özellikler Salt Okunur'dır.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Ad Açıklama Değer
seçenekler İstek için uygulanacak bir anahtar-değer çifti seçeneği. Bu, istekle birlikte gönderilen üst bilgilere karşılık gelir. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
kaynak Kapsayıcının standart JSON biçimi SqlContainerResourceOrSqlContainerGetPropertiesResou... (gerekli)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Ad Açıklama Değer
autoscaleSettings Otomatik Ölçeklendirme ayarlarını belirtir. Not: Aktarım hızı veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir. Otomatik ÖlçeklendirmeAyarlar
aktarım hızı Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000. int

Otomatik ÖlçeklendirmeAyarlar

Ad Açıklama Değer
maxThroughput Kaynağın ölçeği artırabileceği en yüksek aktarım hızını temsil eder. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Ad Açıklama Değer
analyticalStorageTtl Analitik TTL. int
clientEncryptionPolicy Kapsayıcı için istemci şifreleme ilkesi. ClientEncryptionPolicy
computedProperties Hesaplanan özelliklerin listesi ComputedProperty[]
conflictResolutionPolicy Kapsayıcı için çakışma çözümleme ilkesi. ConflictResolutionPolicy
createMode Kaynak oluşturma modunu göstermek için sabit listesi. "Varsayılan"
"PointInTimeRestore"
"Geri Yükle"
defaultTtl Varsayılan yaşam süresi int
kimlik Cosmos DB SQL kapsayıcısının adı dize (gerekli)
indexingPolicy Dizin oluşturma ilkesinin yapılandırması. Varsayılan olarak, kapsayıcı içindeki tüm belge yolları için dizin oluşturma otomatiktir IndexingPolicy
materializedViewDefinition Gerçekleştirilmiş Görünümleri tanımlama yapılandırması. Bu yalnızca Gerçekleştirilmiş Görünüm kapsayıcısı oluşturmak için belirtilmelidir. MaterializedViewDefinition
partitionKey Verileri birden çok bölüme bölmek için kullanılacak bölüm anahtarının yapılandırması ContainerPartitionKey
restoreParameters Geri yükleme hakkındaki bilgileri gösteren parametreler ResourceRestoreParameters
uniqueKeyPolicy Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlamalarını belirtmek için benzersiz anahtar ilkesi yapılandırması. UniqueKeyPolicy

ClientEncryptionPolicy

Ad Açıklama Değer
includedPaths Yola özgü ayarlarla birlikte şifreleme gerektiren öğenin yolları. ClientEncryptionIncludedPath[] (gerekli)
policyFormatVersion İstemci şifreleme ilkesi tanımının sürümü. Desteklenen sürümler 1 ve 2'dir. Sürüm 2, kimlik ve bölüm anahtarı yolu şifrelemeyi destekler. int (gerekli)

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 2

ClientEncryptionIncludedPath

Ad Açıklama Değer
clientEncryptionKeyId Yolu şifrelemek için kullanılacak İstemci Şifreleme Anahtarının tanımlayıcısı. dize (gerekli)
Encryptionalgorithm Kullanılacak şifreleme algoritması. Örneğin - AEAD_AES_256_CBC_HMAC_SHA256. dize (gerekli)
encryptionType Gerçekleştirilecek şifreleme türü. Örneğin- Deterministik, Rastgele. dize (gerekli)
path Şifrelenmesi gereken yol. dize (gerekli)

ComputedProperty

Ad Açıklama Değer
name Hesaplanan özelliğin adı, örneğin : "cp_lowerName" string
query Hesaplanan özelliğin değerini değerlendiren sorgu, örneğin: "SELECT VALUE LOWER(c.name) FROM c" string

ConflictResolutionPolicy

Ad Açıklama Değer
conflictResolutionPath LastWriterWins modunda çakışma çözümleme yolu. string
conflictResolutionProcedure Özel mod durumunda çakışmaları çözümleme yordamı. string
mod Çakışma çözümleme modunu gösterir. "Özel"
"LastWriterWins"

IndexingPolicy

Ad Açıklama Değer
otomatik Dizin oluşturma ilkesinin otomatik olup olmadığını gösterir bool
compositeIndexes Bileşik yol listesi listesi CompositePath[]
excludedPaths Dizin oluşturmanın dışında tutulacak yolların listesi ExcludedPath[]
includedPaths Dizin oluşturmada yer alacak yolların listesi IncludedPath[]
indexingMode Dizin oluşturma modunu gösterir. "tutarlı"
"Tembel"
"hiçbiri"
spatialIndexes Uzamsal özelliklerin listesi SpatialSpec[]

CompositePath

Ad Açıklama Değer
sıra Bileşik yollar için sıralama düzeni. "artan"
"azalan"
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

ExcludedPath

Ad Açıklama Değer
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

IncludedPath

Ad Açıklama Değer
Dizin Bu yol için dizin listesi Dizinler[]
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string

Dizinler

Ad Açıklama Değer
dataType Dizin oluşturma davranışının uygulandığı veri türü. "LineString"
"MultiPolygon"
"Sayı"
"Nokta"
"Çokgen"
"Dize"
Tür Dizin türünü gösterir. "Karma"
"Aralık"
"Uzamsal"
duyarlık Dizinin duyarlığı. -1 maksimum duyarlıktır. int

SpatialSpec

Ad Açıklama Değer
path Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*) string
types Yolun uzamsal türü listesi Herhangi birini içeren dize dizisi:
"LineString"
"MultiPolygon"
"Nokta"
"Çokgen"

MaterializedViewDefinition

Ad Açıklama Değer
tanım Tanım, Gerçekleştirilmiş Görünüm kapsayıcısına doldurulmak üzere kaynak kapsayıcıdan veri getirmek için kullanılacak bir SQL sorgusu olmalıdır. dize (gerekli)
sourceCollectionId Gerçekleştirilmiş Görünümün oluşturulacağı kaynak kapsayıcının adı. dize (gerekli)

ContainerPartitionKey

Ad Açıklama Değer
Tür Bölümleme için kullanılan algoritma türünü gösterir. MultiHash için kapsayıcı oluşturma için birden çok bölüm anahtarı (en fazla üç bölüm anahtarı) desteklenir "Karma"
"MultiHash"
"Aralık"
Yol Kapsayıcı içindeki hangi verilerin bölümlenebileceğini kullanan yolların listesi string[]
sürüm Bölüm anahtarı tanımının sürümünü gösterir int

Kısıtlama -ları:
Min değer = 1
Maksimum değer = 2

ResourceRestoreParameters

Ad Açıklama Değer
restoreSource Geri yüklemenin başlatılması gereken geri yüklenebilir veritabanı hesabının kimliği. Örneğin: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restoreableDatabaseAccounts/{restoreableDatabaseAccountName} string
restoreTimestampInUtc Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi). string
restoreWithTtlDisabled Geri yüklemenin başarılı olması durumunda geri yüklenen hesabın Yaşam Süresi'nin devre dışı bırakılıp bırakılmayacağını belirtir. bool

UniqueKeyPolicy

Ad Açıklama Değer
uniqueKeys Üzerinde, Azure Cosmos DB hizmetindeki koleksiyondaki belgeler üzerinde benzersizlik kısıtlaması uygulayan benzersiz anahtarların listesi. UniqueKey[]

UniqueKey

Ad Açıklama Değer
Yol Yolların listesi Azure Cosmos DB hizmetindeki her belge için benzersiz olmalıdır dize[]