Top / Microsoft Azure / Azure CosmosDB (DocumentDB) / SQL Function

Azure CosmosDB (DocumentDB) SQL Function

This page shows how to write Terraform and Azure Resource Manager for CosmosDB (DocumentDB) SQL Function and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_cosmosdb_sql_function (Terraform)

The SQL Function in CosmosDB (DocumentDB) can be configured in Terraform with the resource name azurerm_cosmosdb_sql_function. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.

  • container_id - (Required) The id of the Cosmos DB SQL Container to create the SQL User Defined Function within. Changing this forces a new SQL User Defined Function to be created.

  • body - (Required) Body of the User Defined Function.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the SQL User Defined Function.

>> from Terraform Registry

Explanation in Terraform Registry

Manages an SQL User Defined Function.

>> from Terraform Registry

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions (Azure Resource Manager)

The databaseAccounts/sqlDatabases/containers/userDefinedFunctions in Microsoft.DocumentDB can be configured in Azure Resource Manager with the resource name Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • location optional - string

    The location of the resource group to which the resource belongs.

  • name required - string

    Cosmos DB userDefinedFunction name.

  • properties required
      • options optional
          • autoscaleSettings optional
              • maxThroughput optional - integer

                Represents maximum throughput, the resource can scale up to.

          • throughput optional - integer

            Request Units per second. For example, "throughput": 10000.

      • resource required
          • body optional - string

            Body of the User Defined Function

          • id required - string

            Name of the Cosmos DB SQL userDefinedFunction

  • tags optional - string

    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure CosmosDB (DocumentDB) Resources

Frequently asked questions

What is Azure CosmosDB (DocumentDB) SQL Function?

Azure CosmosDB (DocumentDB) SQL Function is a resource for CosmosDB (DocumentDB) of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents