Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2023-09-15-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2023-09-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

CreateUpdateOptions

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

ManagedServiceIdentity

Name	Description	Value
type	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Name	Description	Value
identity	Identity for the resource.	ManagedServiceIdentity
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
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

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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:

• Resource groups - See resource group deployment commands

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": "2023-09-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

CreateUpdateOptions

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

ManagedServiceIdentity

Name	Description	Value
type	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Name	Description	Value
apiVersion	The api version	'2023-09-15-preview'
identity	Identity for the resource.	ManagedServiceIdentity
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
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

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	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.

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@2023-09-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 = {
        body = "string"
        id = "string"
      }
    }
  }
}

Property Values

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

CreateUpdateOptions

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

ManagedServiceIdentity

Name	Description	Value
type	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Name	Description	Value
identity	Identity for the resource.	ManagedServiceIdentity
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@2023-09-15-preview"

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
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