Share via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2020-03-01

  • Article

Bicep resource definition

The databaseAccounts/sqlDatabases/containers/userDefinedFunctions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions resource, add the following Bicep to your template.

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

Property values

CreateUpdateOptions

Name Description Value
throughput Request Units per second. For example, "throughput": "10000". string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts/sqlDatabases/containers
properties Properties to create and update Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptions (required)
resource The standard JSON format of a userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (required)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Name Description Value
body Body of the User Defined Function string
id Name of the Cosmos DB SQL userDefinedFunction string (required)

Tags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Create Azure Cosmos DB Core (SQL) API stored procedures This template creates an Azure Cosmos DB account for Core (SQL) API and a container with a stored procedure, trigger and user defined function.

ARM template resource definition

The databaseAccounts/sqlDatabases/containers/userDefinedFunctions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "apiVersion": "2020-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "throughput": "string"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

CreateUpdateOptions

Name Description Value
throughput Request Units per second. For example, "throughput": "10000". string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Name Description Value
apiVersion The api version '2020-03-01'
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
properties Properties to create and update Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptions (required)
resource The standard JSON format of a userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (required)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Name Description Value
body Body of the User Defined Function string
id Name of the Cosmos DB SQL userDefinedFunction string (required)

Tags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure Cosmos DB Core (SQL) API stored procedures

Deploy to Azure		 This template creates an Azure Cosmos DB account for Core (SQL) API and a container with a stored procedure, trigger and user defined function.

Terraform (AzAPI provider) resource definition

The databaseAccounts/sqlDatabases/containers/userDefinedFunctions resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        throughput = "string"
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  })
}

Property values

CreateUpdateOptions

Name Description Value
throughput Request Units per second. For example, "throughput": "10000". string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts/sqlDatabases/containers
properties Properties to create and update Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01"

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptions (required)
resource The standard JSON format of a userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (required)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Name Description Value
body Body of the User Defined Function string
id Name of the Cosmos DB SQL userDefinedFunction string (required)

Tags

Name Description Value