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üğü.
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-03-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
Otomatik ÖlçeklendirmeAyarlar
| Ad |
Açıklama |
Değer |
| maxThroughput |
En yüksek aktarım hızını temsil eder; kaynak ölçeği artırabilir. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Ad |
Açıklama |
Değer |
| otomatik ölçeklendirmeAyarlar |
Otomatik Ölçeklendirme ayarlarını belirtir. |
Otomatik ÖlçeklendirmeAyarlar |
| Verim |
Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000. |
Int |
ManagedServiceIdentity
| 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'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' |
| userAssignedIdentities |
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
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 |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
| 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) |
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Ad |
Açıklama |
Değer |
| analyticalStorageTtl |
Analitik TTL. |
Int |
| createMode |
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 |
İstek için uygulanacak bir anahtar-değer çifti parça anahtarı. |
ShardKeys |
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 |
MongoIndexKeys
| Ad |
Açıklama |
Değer |
| Anahtar |
Azure Cosmos DB hizmetindeki her MongoDB koleksiyonunun anahtarları listesi |
string[] |
MongoIndexOptions
| Ad |
Açıklama |
Değer |
| expireAfterSeconds |
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 |
ShardKeys
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üğü.
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-03-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
Otomatik ÖlçeklendirmeAyarlar
| Ad |
Açıklama |
Değer |
| maxThroughput |
En yüksek aktarım hızını temsil eder; kaynak ölçeği artırabilir. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Ad |
Açıklama |
Değer |
| otomatik ölçeklendirmeAyarlar |
Otomatik Ölçeklendirme ayarlarını belirtir. |
Otomatik ÖlçeklendirmeAyarlar |
| Verim |
Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000. |
Int |
ManagedServiceIdentity
| 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'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' |
| userAssignedIdentities |
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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
| Ad |
Açıklama |
Değer |
| apiVersion |
API sürümü |
'2023-03-15-preview' |
| 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' |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
| 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) |
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Ad |
Açıklama |
Değer |
| analyticalStorageTtl |
Analitik TTL. |
Int |
| createMode |
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 |
İstek için uygulanacak bir anahtar-değer çifti parça anahtarı. |
ShardKeys |
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 |
MongoIndexKeys
| Ad |
Açıklama |
Değer |
| Anahtar |
Azure Cosmos DB hizmetindeki her MongoDB koleksiyonunun anahtarları listesi |
string[] |
MongoIndexOptions
| Ad |
Açıklama |
Değer |
| expireAfterSeconds |
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 |
ShardKeys
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. |
databaseAccounts/mongodbDatabases/collections 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üğü.
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-03-15-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
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
Otomatik ÖlçeklendirmeAyarlar
| Ad |
Açıklama |
Değer |
| maxThroughput |
En yüksek aktarım hızını temsil eder; kaynak ölçeği artırabilir. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Ad |
Açıklama |
Değer |
| otomatik ölçeklendirmeAyarlar |
Otomatik Ölçeklendirme ayarlarını belirtir. |
Otomatik ÖlçeklendirmeAyarlar |
| Verim |
Saniye başına İstek Birimi sayısı. Örneğin, "aktarım hızı": 10000. |
Int |
ManagedServiceIdentity
| 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'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' |
| userAssignedIdentities |
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
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) |
| parent_id |
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-03-15-preview" |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
| 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) |
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Ad |
Açıklama |
Değer |
| analyticalStorageTtl |
Analitik TTL. |
Int |
| createMode |
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 |
İstek için uygulanacak bir anahtar-değer çifti parça anahtarı. |
ShardKeys |
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 |
MongoIndexKeys
| Ad |
Açıklama |
Değer |
| Anahtar |
Azure Cosmos DB hizmetindeki her MongoDB koleksiyonunun anahtarları listesi |
string[] |
MongoIndexOptions
| Ad |
Açıklama |
Değer |
| expireAfterSeconds |
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 |
ShardKeys