sql_user_defined_functions

Creates, updates, deletes, gets or lists a sql_user_defined_functions resource.

Overview

Name	sql_user_defined_functions
Type	Resource
Id	azure.cosmos_db.sql_user_defined_functions

Fields

The following fields are returned by SELECT queries:

get

The SQL userDefinedFunction property was retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
properties	object	The properties of an Azure Cosmos DB userDefinedFunction
tags	object	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	string	The type of Azure resource.

list

The SQL userDefinedFunction properties were retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
properties	object	The properties of an Azure Cosmos DB userDefinedFunction
tags	object	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	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, databaseName, containerName, userDefinedFunctionName		Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
list	select	subscriptionId, resourceGroupName, accountName, databaseName, containerName		Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
create_update	insert	subscriptionId, resourceGroupName, accountName, databaseName, containerName, userDefinedFunctionName, data__properties		Create or update an Azure Cosmos DB SQL userDefinedFunction
delete	delete	subscriptionId, resourceGroupName, accountName, databaseName, containerName, userDefinedFunctionName		Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Cosmos DB database account name.
containerName	string	Cosmos DB container name.
databaseName	string	Cosmos DB database name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
userDefinedFunctionName	string	Cosmos DB userDefinedFunction name.

SELECT examples

get

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.cosmos_db.sql_user_defined_functions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND containerName = '{{ containerName }}' -- required
AND userDefinedFunctionName = '{{ userDefinedFunctionName }}' -- required
;

list

Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.cosmos_db.sql_user_defined_functions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND containerName = '{{ containerName }}' -- required
;

INSERT examples

create_update

Create or update an Azure Cosmos DB SQL userDefinedFunction

INSERT INTO azure.cosmos_db.sql_user_defined_functions (
data__properties,
data__location,
data__tags,
data__identity,
subscriptionId,
resourceGroupName,
accountName,
databaseName,
containerName,
userDefinedFunctionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ databaseName }}',
'{{ containerName }}',
'{{ userDefinedFunctionName }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_user_defined_functions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_user_defined_functions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_user_defined_functions resource.
    - name: accountName
      value: string
      description: Required parameter for the sql_user_defined_functions resource.
    - name: databaseName
      value: string
      description: Required parameter for the sql_user_defined_functions resource.
    - name: containerName
      value: string
      description: Required parameter for the sql_user_defined_functions resource.
    - name: userDefinedFunctionName
      value: string
      description: Required parameter for the sql_user_defined_functions resource.
    - name: properties
      value: object
      description: |
        Properties to create and update Azure Cosmos DB userDefinedFunction.
    - name: location
      value: string
      description: |
        The location of the resource group to which the resource belongs.
    - name: tags
      value: object
      description: |
        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".
    - name: identity
      value: object
      description: |
        Identity for the resource.

DELETE examples

delete

Deletes an existing Azure Cosmos DB SQL userDefinedFunction.

DELETE FROM azure.cosmos_db.sql_user_defined_functions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND containerName = '{{ containerName }}' --required
AND userDefinedFunctionName = '{{ userDefinedFunctionName }}' --required
;