1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. SqlFunction

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.cosmosdb.SqlFunction

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages an SQL User Defined Function.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.cosmosdb.getAccount({
        name: "tfex-cosmosdb-account",
        resourceGroupName: "tfex-cosmosdb-account-rg",
    });
    const exampleSqlDatabase = new azure.cosmosdb.SqlDatabase("example", {
        name: "tfex-cosmos-db",
        resourceGroupName: example.then(example => example.resourceGroupName),
        accountName: example.then(example => example.name),
        throughput: 400,
    });
    const exampleSqlContainer = new azure.cosmosdb.SqlContainer("example", {
        name: "example-container",
        resourceGroupName: example.then(example => example.resourceGroupName),
        accountName: example.then(example => example.name),
        databaseName: exampleSqlDatabase.name,
        partitionKeyPath: "/id",
    });
    const exampleSqlFunction = new azure.cosmosdb.SqlFunction("example", {
        name: "test-function",
        containerId: exampleSqlContainer.id,
        body: "function trigger(){}",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
        resource_group_name="tfex-cosmosdb-account-rg")
    example_sql_database = azure.cosmosdb.SqlDatabase("example",
        name="tfex-cosmos-db",
        resource_group_name=example.resource_group_name,
        account_name=example.name,
        throughput=400)
    example_sql_container = azure.cosmosdb.SqlContainer("example",
        name="example-container",
        resource_group_name=example.resource_group_name,
        account_name=example.name,
        database_name=example_sql_database.name,
        partition_key_path="/id")
    example_sql_function = azure.cosmosdb.SqlFunction("example",
        name="test-function",
        container_id=example_sql_container.id,
        body="function trigger(){}")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
    			Name:              "tfex-cosmosdb-account",
    			ResourceGroupName: "tfex-cosmosdb-account-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleSqlDatabase, err := cosmosdb.NewSqlDatabase(ctx, "example", &cosmosdb.SqlDatabaseArgs{
    			Name:              pulumi.String("tfex-cosmos-db"),
    			ResourceGroupName: pulumi.String(example.ResourceGroupName),
    			AccountName:       pulumi.String(example.Name),
    			Throughput:        pulumi.Int(400),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSqlContainer, err := cosmosdb.NewSqlContainer(ctx, "example", &cosmosdb.SqlContainerArgs{
    			Name:              pulumi.String("example-container"),
    			ResourceGroupName: pulumi.String(example.ResourceGroupName),
    			AccountName:       pulumi.String(example.Name),
    			DatabaseName:      exampleSqlDatabase.Name,
    			PartitionKeyPath:  pulumi.String("/id"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cosmosdb.NewSqlFunction(ctx, "example", &cosmosdb.SqlFunctionArgs{
    			Name:        pulumi.String("test-function"),
    			ContainerId: exampleSqlContainer.ID(),
    			Body:        pulumi.String("function trigger(){}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.CosmosDB.GetAccount.Invoke(new()
        {
            Name = "tfex-cosmosdb-account",
            ResourceGroupName = "tfex-cosmosdb-account-rg",
        });
    
        var exampleSqlDatabase = new Azure.CosmosDB.SqlDatabase("example", new()
        {
            Name = "tfex-cosmos-db",
            ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
            AccountName = example.Apply(getAccountResult => getAccountResult.Name),
            Throughput = 400,
        });
    
        var exampleSqlContainer = new Azure.CosmosDB.SqlContainer("example", new()
        {
            Name = "example-container",
            ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
            AccountName = example.Apply(getAccountResult => getAccountResult.Name),
            DatabaseName = exampleSqlDatabase.Name,
            PartitionKeyPath = "/id",
        });
    
        var exampleSqlFunction = new Azure.CosmosDB.SqlFunction("example", new()
        {
            Name = "test-function",
            ContainerId = exampleSqlContainer.Id,
            Body = "function trigger(){}",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.cosmosdb.CosmosdbFunctions;
    import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
    import com.pulumi.azure.cosmosdb.SqlDatabase;
    import com.pulumi.azure.cosmosdb.SqlDatabaseArgs;
    import com.pulumi.azure.cosmosdb.SqlContainer;
    import com.pulumi.azure.cosmosdb.SqlContainerArgs;
    import com.pulumi.azure.cosmosdb.SqlFunction;
    import com.pulumi.azure.cosmosdb.SqlFunctionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
                .name("tfex-cosmosdb-account")
                .resourceGroupName("tfex-cosmosdb-account-rg")
                .build());
    
            var exampleSqlDatabase = new SqlDatabase("exampleSqlDatabase", SqlDatabaseArgs.builder()        
                .name("tfex-cosmos-db")
                .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
                .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
                .throughput(400)
                .build());
    
            var exampleSqlContainer = new SqlContainer("exampleSqlContainer", SqlContainerArgs.builder()        
                .name("example-container")
                .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
                .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
                .databaseName(exampleSqlDatabase.name())
                .partitionKeyPath("/id")
                .build());
    
            var exampleSqlFunction = new SqlFunction("exampleSqlFunction", SqlFunctionArgs.builder()        
                .name("test-function")
                .containerId(exampleSqlContainer.id())
                .body("function trigger(){}")
                .build());
    
        }
    }
    
    resources:
      exampleSqlDatabase:
        type: azure:cosmosdb:SqlDatabase
        name: example
        properties:
          name: tfex-cosmos-db
          resourceGroupName: ${example.resourceGroupName}
          accountName: ${example.name}
          throughput: 400
      exampleSqlContainer:
        type: azure:cosmosdb:SqlContainer
        name: example
        properties:
          name: example-container
          resourceGroupName: ${example.resourceGroupName}
          accountName: ${example.name}
          databaseName: ${exampleSqlDatabase.name}
          partitionKeyPath: /id
      exampleSqlFunction:
        type: azure:cosmosdb:SqlFunction
        name: example
        properties:
          name: test-function
          containerId: ${exampleSqlContainer.id}
          body: function trigger(){}
    variables:
      example:
        fn::invoke:
          Function: azure:cosmosdb:getAccount
          Arguments:
            name: tfex-cosmosdb-account
            resourceGroupName: tfex-cosmosdb-account-rg
    

    Create SqlFunction Resource

    new SqlFunction(name: string, args: SqlFunctionArgs, opts?: CustomResourceOptions);
    @overload
    def SqlFunction(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    body: Optional[str] = None,
                    container_id: Optional[str] = None,
                    name: Optional[str] = None)
    @overload
    def SqlFunction(resource_name: str,
                    args: SqlFunctionArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewSqlFunction(ctx *Context, name string, args SqlFunctionArgs, opts ...ResourceOption) (*SqlFunction, error)
    public SqlFunction(string name, SqlFunctionArgs args, CustomResourceOptions? opts = null)
    public SqlFunction(String name, SqlFunctionArgs args)
    public SqlFunction(String name, SqlFunctionArgs args, CustomResourceOptions options)
    
    type: azure:cosmosdb:SqlFunction
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SqlFunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlFunctionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlFunctionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlFunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlFunctionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SqlFunction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SqlFunction resource accepts the following input properties:

    Body string
    Body of the User Defined Function.
    ContainerId string
    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.
    Name string
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    Body string
    Body of the User Defined Function.
    ContainerId string
    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.
    Name string
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body String
    Body of the User Defined Function.
    containerId String
    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.
    name String
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body string
    Body of the User Defined Function.
    containerId string
    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.
    name string
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body str
    Body of the User Defined Function.
    container_id str
    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.
    name str
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body String
    Body of the User Defined Function.
    containerId String
    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.
    name String
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SqlFunction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SqlFunction Resource

    Get an existing SqlFunction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SqlFunctionState, opts?: CustomResourceOptions): SqlFunction
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            body: Optional[str] = None,
            container_id: Optional[str] = None,
            name: Optional[str] = None) -> SqlFunction
    func GetSqlFunction(ctx *Context, name string, id IDInput, state *SqlFunctionState, opts ...ResourceOption) (*SqlFunction, error)
    public static SqlFunction Get(string name, Input<string> id, SqlFunctionState? state, CustomResourceOptions? opts = null)
    public static SqlFunction get(String name, Output<String> id, SqlFunctionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Body string
    Body of the User Defined Function.
    ContainerId string
    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.
    Name string
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    Body string
    Body of the User Defined Function.
    ContainerId string
    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.
    Name string
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body String
    Body of the User Defined Function.
    containerId String
    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.
    name String
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body string
    Body of the User Defined Function.
    containerId string
    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.
    name string
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body str
    Body of the User Defined Function.
    container_id str
    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.
    name str
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.
    body String
    Body of the User Defined Function.
    containerId String
    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.
    name String
    The name which should be used for this SQL User Defined Function. Changing this forces a new SQL User Defined Function to be created.

    Import

    SQL User Defined Functions can be imported using the resource id, e.g.

    $ pulumi import azure:cosmosdb/sqlFunction:SqlFunction example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DocumentDB/databaseAccounts/account1/sqlDatabases/database1/containers/container1/userDefinedFunctions/userDefinedFunction1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi