共用方式為

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

  • 發行項

Bicep 資源定義

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

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

資源格式

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

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

屬性值

AutoscaleSettings

名字 描述 價值
maxThroughput 代表最大輸送量，資源可以相應增加至 。 int

CreateUpdateOptions

名字 描述 價值
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如，「輸送量」：10000。 int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

名字 描述 價值
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 字串 （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：databaseAccounts/sqlDatabases/containers
性能 用來建立及更新 Azure Cosmos DB userDefinedFunction 的屬性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

名字 描述 價值
選項 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 CreateUpdateOptions
資源 userDefinedFunction 的標準 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource （必要）

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

名字 描述 價值
身體 用戶定義函式的主體 字串
id Cosmos DB SQL 使用者DefinedFunction 的名稱 字串 （必要）

標籤

名字 描述 價值

快速入門範例

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

Bicep 檔案 描述
建立 Azure Cosmos DB Core （SQL） API 預存程式 此範本會建立適用於 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-01-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

AutoscaleSettings

名字 描述 價值
maxThroughput 代表最大輸送量，資源可以相應增加至 。 int

CreateUpdateOptions

名字 描述 價值
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如，「輸送量」：10000。 int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

名字 描述 價值
apiVersion API 版本 '2021-01-15'
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 字串 （必要）
性能 用來建立及更新 Azure Cosmos DB userDefinedFunction 的屬性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

名字 描述 價值
選項 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 CreateUpdateOptions
資源 userDefinedFunction 的標準 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource （必要）

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

名字 描述 價值
身體 用戶定義函式的主體 字串
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-01-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  })
}

屬性值

AutoscaleSettings

名字 描述 價值
maxThroughput 代表最大輸送量，資源可以相應增加至 。 int

CreateUpdateOptions

名字 描述 價值
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如，「輸送量」：10000。 int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

名字 描述 價值
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 字串 （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：databaseAccounts/sqlDatabases/containers
性能 用來建立及更新 Azure Cosmos DB userDefinedFunction 的屬性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-01-15”

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

名字 描述 價值
選項 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 CreateUpdateOptions
資源 userDefinedFunction 的標準 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource （必要）

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

名字 描述 價值
身體 用戶定義函式的主體 字串
id Cosmos DB SQL 使用者DefinedFunction 的名稱 字串 （必要）

標籤

名字 描述 價值