Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@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: {
      body: 'string'
      id: 'string'
    }
  }
}

Özellik değerleri

databaseAccounts/sqlDatabases/containers/userDefined...

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.
Şu tür kaynak için sembolik ad: kapsayıcılar
identity Kaynağın kimliği. ManagedServiceIdentity
properties Azure Cosmos DB userDefinedFunction oluşturma ve güncelleştirme özellikleri. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (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.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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. CreateUpdateOptions
kaynak UserDefinedFunction'ın standart JSON biçimi SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (gerekli)

CreateUpdateOptions

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Ad Açıklama Değer
body Kullanıcı Tanımlı İşlevin Gövdesi string
kimlik Cosmos DB SQL kullanıcısının adıDefinedFunction dize (gerekli)

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

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

Şablon Description
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.

ARM şablonu kaynak tanımı

databaseAccounts/sqlDatabases/containers/userDefinedFunctions 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/userDefinedFunctions kaynağı oluşturmak için, şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "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": {
      "body": "string",
      "id": "string"
    }
  }
}

Özellik değerleri

databaseAccounts/sqlDatabases/containers/userDefined...

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'
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 userDefinedFunction oluşturma ve güncelleştirme özellikleri. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (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çermez. Tüm özellikler Salt Okunur'dır.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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. CreateUpdateOptions
kaynak UserDefinedFunction'ın standart JSON biçimi SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (gerekli)

CreateUpdateOptions

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Ad Açıklama Değer
body Kullanıcı Tanımlı İşlevin Gövdesi string
kimlik Cosmos DB SQL kullanıcısının adıDefinedFunction dize (gerekli)

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

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

Şablon Description
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.

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

databaseAccounts/sqlDatabases/containers/userDefinedFunctions kaynak türü şu hedeflenen 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/userDefinedFunctions kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@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 = {
        body = "string"
        id = "string"
      }
    }
  })
}

Özellik değerleri

databaseAccounts/sqlDatabases/containers/userDefined...

Ad Açıklama Değer
tür Kaynak türü "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@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. Kapsayıcı türündeki kaynağın 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 userDefinedFunction oluşturma ve güncelleştirme özellikleri. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (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.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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. CreateUpdateOptions
kaynak UserDefinedFunction'ın standart JSON biçimi SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (gerekli)

CreateUpdateOptions

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Ad Açıklama Değer
body Kullanıcı Tanımlı İşlevin Gövdesi string
kimlik Cosmos DB SQL kullanıcısının adıDefinedFunction dize (gerekli)