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

vw_sql_user_defined_functions

Name	Datatype	Description
id	text	The unique resource identifier of the ARM resource.
name	text	The name of the ARM resource.
accountName	text	field from the properties object
containerName	text	field from the properties object
databaseName	text	field from the properties object
identity	text	Identity for the resource.
location	text	The location of the resource group to which the resource belongs.
resource	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	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	text	The type of Azure resource.
userDefinedFunctionName	text	field from the properties object

sql_user_defined_functions

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

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

SELECT examples

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

vw_sql_user_defined_functions

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

sql_user_defined_functions

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

INSERT example

Use the following StackQL query and manifest file to create a new sql_user_defined_functions resource.

All Properties

/*+ create */
INSERT INTO azure.cosmos_db.sql_user_defined_functions (
accountName,
containerName,
databaseName,
resourceGroupName,
subscriptionId,
userDefinedFunctionName,
data__properties,
properties,
location,
tags,
identity
)
SELECT 
'{{ accountName }}',
'{{ containerName }}',
'{{ databaseName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ userDefinedFunctionName }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: resource
          value:
            - name: id
              value: string
            - name: body
              value: string
        - name: options
          value:
            - name: throughput
              value: integer
            - name: autoscaleSettings
              value:
                - name: maxThroughput
                  value: integer
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: []
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object

DELETE example

Deletes the specified sql_user_defined_functions resource.

/*+ delete */
DELETE FROM azure.cosmos_db.sql_user_defined_functions
WHERE accountName = '{{ accountName }}'
AND containerName = '{{ containerName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userDefinedFunctionName = '{{ userDefinedFunctionName }}';