Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-09-15-önizleme

• en son
• 2025-05-01-önizleme
• 2025-04-15
• 2024-12-01-önizleme
• 2024-11-15
• 2024-09-01-önizleme
• 2024-08-15
• 2024-05-15
• 2024-05-15-önizleme
• 2024-02-15-önizleme
• 2023-11-15
• 2023-11-15-önizleme
• 2023-09-15
• 2023-09-15-önizleme
• 2023-04-15
• 2023-03-15
• 2023-03-15-önizleme
• 2023-03-01-önizleme
• 2022-11-15
• 2022-11-15-önizleme
• 2022-08-15
• 2022-08-15-önizleme
• 2022-05-15
• 2022-05-15-önizleme
• 2022-02-15-önizleme
• 2021-11-15-önizleme
• 2021-10-15
• 2021-10-15-önizleme
• 2021-07-01-önizleme
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-önizleme
• 2021-03-15
• 2021-03-01-önizleme
• 2021-01-15
• 2020-09-01
• 2020-06-01-önizleme
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep kaynak tanımı

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

• kaynak grupları - Bkz. kaynak grubu dağıtım komutları

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/mongodbDatabases/collections kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-09-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      createMode: 'string'
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Özellik Değerleri

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Ad	Açıklama	Değer
kimlik	Kaynağın kimliği.	ManagedServiceIdentity
yer	Kaynağın ait olduğu kaynak grubunun konumu.	dizgi
ad	Kaynak adı	dize (gerekli)
ebeveyn	Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında.	Tür kaynağı için sembolik ad: databaseAccounts/mongodbDatabases
Özellikler	Azure Cosmos DB MongoDB koleksiyonunu oluşturmak ve güncelleştirmek için özellikler.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (gerekli)
Etiketler	Kaynak etiketleri	Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri

Otomatik ÖlçeklendirmeAyarlar

Ad	Açıklama	Değer
maxVerim	En yüksek aktarım hızını temsil eder; kaynak ölçeği artırabilir.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Ad	Açıklama	Değer

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Ad	Açıklama	Değer
otomatik ölçeklendirmeAyarlar	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
Verim	Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000.	Int

ManagedServiceIdentity (Yönetilen Servis Kimliği)

Ad	Açıklama	Değer
tür	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.	'Hiçbiri' 'Sistem Atandı' 'SystemAssigned,UserAssigned' 'Kullanıcı Tarafından Atanan'
kullanıcı tarafından atanan kimlikler	Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük 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

MongoDBCollectionCreateUpdatePropertiesVeyaMongoDBCollectionGetProperties

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

MongoDBCollectionResourceVeyaMongoDBCollectionGetPropertiesResource

Ad	Açıklama	Değer
analyticalStorageTtl	Analitik TTL.	Int
createMode (Oluştur Modu	Kaynak oluşturma modunu belirtmek için sabit listesi.	'Varsayılan' 'PointInTimeRestore' 'Geri Yükle'
Kimliği	Cosmos DB MongoDB koleksiyonunun adı	dize (gerekli)
Dizin	Dizin anahtarları listesi	MongoIndex[]
restoreParameters	Geri yükleme hakkındaki bilgileri gösteren parametreler	ResourceRestoreParameters
shardKey (Parça)	İstek için uygulanacak bir anahtar-değer çifti parça anahtarı.	Parça Tuşları

MongoIndex (MongoIndex)

Ad	Açıklama	Değer
anahtar	Cosmos DB MongoDB koleksiyonu dizin anahtarları	mongoIndexKeys
Seçenekler	Cosmos DB MongoDB koleksiyonu dizin anahtarı seçenekleri	mongoIndexOptions

MongoDizin Anahtarları

Ad	Açıklama	Değer
Anahtar	Azure Cosmos DB hizmetindeki her MongoDB koleksiyonunun anahtarları listesi	dize[]

MongoEndeks Seçenekleri

Ad	Açıklama	Değer
sona erme SonraSaniye	Saniyeler sonra süresi dolduğunda	Int
eşsiz	Benzersiz veya değil	Bool

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/{restorableDatabaseAccountName}	dizgi
restoreTimestampInUtc	Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi).	dizgi

Parça Tuşları

Ad	Açıklama	Değer

Etiketler

Ad	Açıklama	Değer

Kullanım Örnekleri

Azure Hızlı Başlangıç Örnekleri

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak için Bicep örnekleri içerir.

Bicep Dosyası	Açıklama
MongoDB API için Azure Cosmos hesabı oluşturma	Bu şablon, iki koleksiyonla paylaşılan ve ayrılmış aktarım hızı kullanarak iki bölgede MongoDB API 4.2 için bir Azure Cosmos DB hesabı oluşturur.
MongoDB API otomatik ölçeklendirme için Azure Cosmos hesabı oluşturma	Bu şablon, hem paylaşılan hem de ayrılmış otomatik ölçeklendirme aktarım hızını kullanarak iki bölgede MongoDB API 4.2 için bir Azure Cosmos DB hesabı oluşturur.

ARM şablonu kaynak tanımı

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

• kaynak grupları - Bkz. kaynak grubu dağıtım komutları

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/mongodbDatabases/collections kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "createMode": "string",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Özellik Değerleri

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Ad	Açıklama	Değer
apiVersiyonu	API sürümü	'2023-09-15-önizleme'
kimlik	Kaynağın kimliği.	ManagedServiceIdentity
yer	Kaynağın ait olduğu kaynak grubunun konumu.	dizgi
ad	Kaynak adı	dize (gerekli)
Özellikler	Azure Cosmos DB MongoDB koleksiyonunu oluşturmak ve güncelleştirmek için özellikler.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (gerekli)
Etiketler	Kaynak etiketleri	Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri
tür	Kaynak türü	'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

Otomatik ÖlçeklendirmeAyarlar

Ad	Açıklama	Değer
maxVerim	En yüksek aktarım hızını temsil eder; kaynak ölçeği artırabilir.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Ad	Açıklama	Değer

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Ad	Açıklama	Değer
otomatik ölçeklendirmeAyarlar	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
Verim	Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000.	Int

ManagedServiceIdentity (Yönetilen Servis Kimliği)

Ad	Açıklama	Değer
tür	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.	'Hiçbiri' 'Sistem Atandı' 'SystemAssigned,UserAssigned' 'Kullanıcı Tarafından Atanan'
kullanıcı tarafından atanan kimlikler	Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük 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

MongoDBCollectionCreateUpdatePropertiesVeyaMongoDBCollectionGetProperties

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

MongoDBCollectionResourceVeyaMongoDBCollectionGetPropertiesResource

Ad	Açıklama	Değer
analyticalStorageTtl	Analitik TTL.	Int
createMode (Oluştur Modu	Kaynak oluşturma modunu belirtmek için sabit listesi.	'Varsayılan' 'PointInTimeRestore' 'Geri Yükle'
Kimliği	Cosmos DB MongoDB koleksiyonunun adı	dize (gerekli)
Dizin	Dizin anahtarları listesi	MongoIndex[]
restoreParameters	Geri yükleme hakkındaki bilgileri gösteren parametreler	ResourceRestoreParameters
shardKey (Parça)	İstek için uygulanacak bir anahtar-değer çifti parça anahtarı.	Parça Tuşları

MongoIndex (MongoIndex)

Ad	Açıklama	Değer
anahtar	Cosmos DB MongoDB koleksiyonu dizin anahtarları	mongoIndexKeys
Seçenekler	Cosmos DB MongoDB koleksiyonu dizin anahtarı seçenekleri	mongoIndexOptions

MongoDizin Anahtarları

Ad	Açıklama	Değer
Anahtar	Azure Cosmos DB hizmetindeki her MongoDB koleksiyonunun anahtarları listesi	dize[]

MongoEndeks Seçenekleri

Ad	Açıklama	Değer
sona erme SonraSaniye	Saniyeler sonra süresi dolduğunda	Int
eşsiz	Benzersiz veya değil	Bool

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/{restorableDatabaseAccountName}	dizgi
restoreTimestampInUtc	Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi).	dizgi

Parça Tuşları

Ad	Açıklama	Değer

Etiketler

Ad	Açıklama	Değer

Kullanım Örnekleri

Azure Hızlı Başlangıç Şablonları

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak.

Şablon	Açıklama
MongoDB API için Azure Cosmos hesabı oluşturma 'a dağıtma	Bu şablon, iki koleksiyonla paylaşılan ve ayrılmış aktarım hızı kullanarak iki bölgede MongoDB API 4.2 için bir Azure Cosmos DB hesabı oluşturur.
MongoDB API otomatik ölçeklendirme için Azure Cosmos hesabı oluşturma 'a dağıtma	Bu şablon, hem paylaşılan hem de ayrılmış otomatik ölçeklendirme aktarım hızını kullanarak iki bölgede MongoDB API 4.2 için bir Azure Cosmos DB hesabı oluşturur.

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

databaseAccounts/mongodbDatabases/collections 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/mongodbDatabases/collections kaynağı oluşturmak için, şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-09-15-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  }
}

Özellik Değerleri

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Ad	Açıklama	Değer
kimlik	Kaynağın kimliği.	ManagedServiceIdentity
yer	Kaynağın ait olduğu kaynak grubunun konumu.	dizgi
ad	Kaynak adı	dize (gerekli)
ebeveyn_kimlik	Bu kaynağın üst öğesi olan kaynağın kimliği.	Tür kaynağı kimliği: databaseAccounts/mongodbDatabases
Özellikler	Azure Cosmos DB MongoDB koleksiyonunu oluşturmak ve güncelleştirmek için özellikler.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (gerekli)
Etiketler	Kaynak etiketleri	Etiket adları ve değerleri sözlüğü.
tür	Kaynak türü	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-09-15-preview"

Otomatik ÖlçeklendirmeAyarlar

Ad	Açıklama	Değer
maxVerim	En yüksek aktarım hızını temsil eder; kaynak ölçeği artırabilir.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Ad	Açıklama	Değer

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Ad	Açıklama	Değer
otomatik ölçeklendirmeAyarlar	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
Verim	Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000.	Int

ManagedServiceIdentity (Yönetilen Servis Kimliği)

Ad	Açıklama	Değer
tür	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.	'Hiçbiri' 'Sistem Atandı' 'SystemAssigned,UserAssigned' 'Kullanıcı Tarafından Atanan'
kullanıcı tarafından atanan kimlikler	Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük 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

MongoDBCollectionCreateUpdatePropertiesVeyaMongoDBCollectionGetProperties

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

MongoDBCollectionResourceVeyaMongoDBCollectionGetPropertiesResource

Ad	Açıklama	Değer
analyticalStorageTtl	Analitik TTL.	Int
createMode (Oluştur Modu	Kaynak oluşturma modunu belirtmek için sabit listesi.	'Varsayılan' 'PointInTimeRestore' 'Geri Yükle'
Kimliği	Cosmos DB MongoDB koleksiyonunun adı	dize (gerekli)
Dizin	Dizin anahtarları listesi	MongoIndex[]
restoreParameters	Geri yükleme hakkındaki bilgileri gösteren parametreler	ResourceRestoreParameters
shardKey (Parça)	İstek için uygulanacak bir anahtar-değer çifti parça anahtarı.	Parça Tuşları

MongoIndex (MongoIndex)

Ad	Açıklama	Değer
anahtar	Cosmos DB MongoDB koleksiyonu dizin anahtarları	mongoIndexKeys
Seçenekler	Cosmos DB MongoDB koleksiyonu dizin anahtarı seçenekleri	mongoIndexOptions

MongoDizin Anahtarları

Ad	Açıklama	Değer
Anahtar	Azure Cosmos DB hizmetindeki her MongoDB koleksiyonunun anahtarları listesi	dize[]

MongoEndeks Seçenekleri

Ad	Açıklama	Değer
sona erme SonraSaniye	Saniyeler sonra süresi dolduğunda	Int
eşsiz	Benzersiz veya değil	Bool

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/{restorableDatabaseAccountName}	dizgi
restoreTimestampInUtc	Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi).	dizgi

Parça Tuşları

Ad	Açıklama	Değer

Etiketler

Ad	Açıklama	Değer