共用方式為


Microsoft.DocumentDB 資料庫Accounts/sqlDatabases/containers/userDefinedFunctions 2021-04-15

Bicep 資源定義

databaseAccounts/sqlDatabases/containers/userDefinedFunctions 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
}

屬性值

databaseAccounts/sqlDatabases/containers/userDefined...

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()
location 資源所屬之資源群組的位置。 字串
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗會設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標籤
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: 容器
properties 用來建立及更新 Azure Cosmos DB userDefinedFunction 的屬性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... 必要 ()

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

名稱 描述
選項 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 CreateUpdateOptions
資源 userDefinedFunction 的標準 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... 必要 ()

CreateUpdateOptions

名稱 描述
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加。 int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

名稱 描述
body 用戶定義函式的主體 字串
id Cosmos DB SQL 使用者DefinedFunction 的名稱 字串 (必要)

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure Cosmos DB Core (SQL) API 預存程式

部署至 Azure
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos DB 帳戶,以及具有預存程式、觸發程式和使用者定義函式的容器。

ARM 範本資源定義

databaseAccounts/sqlDatabases/containers/userDefinedFunctions 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions 資源,請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "apiVersion": "2021-04-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  }
}

屬性值

databaseAccounts/sqlDatabases/containers/userDefined...

名稱 描述
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'
apiVersion 資源 API 版本 '2021-04-15'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。
字串 (必要)
location 資源所屬資源群組的位置。 字串
tags 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標記
properties 用來建立及更新 Azure Cosmos DB userDefinedFunction 的屬性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... 必要 ()

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

名稱 描述
選項 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 CreateUpdateOptions
資源 userDefinedFunction 的標準 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... 必要 ()

CreateUpdateOptions

名稱 描述
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加。 int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

名稱 描述
body 用戶定義函式的主體 字串
id Cosmos DB SQL 使用者DefinedFunction 的名稱 字串 (必要)

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure Cosmos DB Core (SQL) API 預存程式

部署至 Azure
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos DB 帳戶,以及具有預存程式、觸發程式和使用者定義函式的容器。

Terraform (AzAPI 提供者) 資源定義

databaseAccounts/sqlDatabases/containers/userDefinedFunctions 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  })
}

屬性值

databaseAccounts/sqlDatabases/containers/userDefined...

名稱 描述
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-15”
NAME 資源名稱 字串 (必要)
location 資源所屬資源群組的位置。 字串
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼: 容器
tags 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。
properties 用來建立及更新 Azure Cosmos DB userDefinedFunction 的屬性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... 必要 ()

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

名稱 描述
選項 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 CreateUpdateOptions
資源 userDefinedFunction 的標準 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... 必要 ()

CreateUpdateOptions

名稱 描述
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加。 int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

名稱 描述
body 用戶定義函式的主體 字串
id Cosmos DB SQL 使用者DefinedFunction 的名稱 字串 (必要)