1. Packages
  2. Azure Classic
  3. API Docs
  4. logicapps
  5. ActionCustom

We recommend using Azure Native.

Azure Classic v6.4.0 published on Tuesday, Oct 8, 2024 by Pulumi

azure.logicapps.ActionCustom

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.4.0 published on Tuesday, Oct 8, 2024 by Pulumi

    Manages a Custom Action within a Logic App Workflow

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "workflow-resources",
        location: "West Europe",
    });
    const exampleWorkflow = new azure.logicapps.Workflow("example", {
        name: "workflow1",
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleActionCustom = new azure.logicapps.ActionCustom("example", {
        name: "example-action",
        logicAppId: exampleWorkflow.id,
        body: `{
        "description": "A variable to configure the auto expiration age in days. Configured in negative number. Default is -30 (30 days old).",
        "inputs": {
            "variables": [
                {
                    "name": "ExpirationAgeInDays",
                    "type": "Integer",
                    "value": -30
                }
            ]
        },
        "runAfter": {},
        "type": "InitializeVariable"
    }
    `,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="workflow-resources",
        location="West Europe")
    example_workflow = azure.logicapps.Workflow("example",
        name="workflow1",
        location=example.location,
        resource_group_name=example.name)
    example_action_custom = azure.logicapps.ActionCustom("example",
        name="example-action",
        logic_app_id=example_workflow.id,
        body="""{
        "description": "A variable to configure the auto expiration age in days. Configured in negative number. Default is -30 (30 days old).",
        "inputs": {
            "variables": [
                {
                    "name": "ExpirationAgeInDays",
                    "type": "Integer",
                    "value": -30
                }
            ]
        },
        "runAfter": {},
        "type": "InitializeVariable"
    }
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/logicapps"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("workflow-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkflow, err := logicapps.NewWorkflow(ctx, "example", &logicapps.WorkflowArgs{
    			Name:              pulumi.String("workflow1"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = logicapps.NewActionCustom(ctx, "example", &logicapps.ActionCustomArgs{
    			Name:       pulumi.String("example-action"),
    			LogicAppId: exampleWorkflow.ID(),
    			Body: pulumi.String(`{
        "description": "A variable to configure the auto expiration age in days. Configured in negative number. Default is -30 (30 days old).",
        "inputs": {
            "variables": [
                {
                    "name": "ExpirationAgeInDays",
                    "type": "Integer",
                    "value": -30
                }
            ]
        },
        "runAfter": {},
        "type": "InitializeVariable"
    }
    `),
    		})
    		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 = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "workflow-resources",
            Location = "West Europe",
        });
    
        var exampleWorkflow = new Azure.LogicApps.Workflow("example", new()
        {
            Name = "workflow1",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleActionCustom = new Azure.LogicApps.ActionCustom("example", new()
        {
            Name = "example-action",
            LogicAppId = exampleWorkflow.Id,
            Body = @"{
        ""description"": ""A variable to configure the auto expiration age in days. Configured in negative number. Default is -30 (30 days old)."",
        ""inputs"": {
            ""variables"": [
                {
                    ""name"": ""ExpirationAgeInDays"",
                    ""type"": ""Integer"",
                    ""value"": -30
                }
            ]
        },
        ""runAfter"": {},
        ""type"": ""InitializeVariable""
    }
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.logicapps.Workflow;
    import com.pulumi.azure.logicapps.WorkflowArgs;
    import com.pulumi.azure.logicapps.ActionCustom;
    import com.pulumi.azure.logicapps.ActionCustomArgs;
    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) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("workflow-resources")
                .location("West Europe")
                .build());
    
            var exampleWorkflow = new Workflow("exampleWorkflow", WorkflowArgs.builder()
                .name("workflow1")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleActionCustom = new ActionCustom("exampleActionCustom", ActionCustomArgs.builder()
                .name("example-action")
                .logicAppId(exampleWorkflow.id())
                .body("""
    {
        "description": "A variable to configure the auto expiration age in days. Configured in negative number. Default is -30 (30 days old).",
        "inputs": {
            "variables": [
                {
                    "name": "ExpirationAgeInDays",
                    "type": "Integer",
                    "value": -30
                }
            ]
        },
        "runAfter": {},
        "type": "InitializeVariable"
    }
                """)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: workflow-resources
          location: West Europe
      exampleWorkflow:
        type: azure:logicapps:Workflow
        name: example
        properties:
          name: workflow1
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleActionCustom:
        type: azure:logicapps:ActionCustom
        name: example
        properties:
          name: example-action
          logicAppId: ${exampleWorkflow.id}
          body: |
            {
                "description": "A variable to configure the auto expiration age in days. Configured in negative number. Default is -30 (30 days old).",
                "inputs": {
                    "variables": [
                        {
                            "name": "ExpirationAgeInDays",
                            "type": "Integer",
                            "value": -30
                        }
                    ]
                },
                "runAfter": {},
                "type": "InitializeVariable"
            }        
    

    Create ActionCustom Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ActionCustom(name: string, args: ActionCustomArgs, opts?: CustomResourceOptions);
    @overload
    def ActionCustom(resource_name: str,
                     args: ActionCustomArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ActionCustom(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     body: Optional[str] = None,
                     logic_app_id: Optional[str] = None,
                     name: Optional[str] = None)
    func NewActionCustom(ctx *Context, name string, args ActionCustomArgs, opts ...ResourceOption) (*ActionCustom, error)
    public ActionCustom(string name, ActionCustomArgs args, CustomResourceOptions? opts = null)
    public ActionCustom(String name, ActionCustomArgs args)
    public ActionCustom(String name, ActionCustomArgs args, CustomResourceOptions options)
    
    type: azure:logicapps:ActionCustom
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ActionCustomArgs
    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 ActionCustomArgs
    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 ActionCustomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionCustomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActionCustomArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var actionCustomResource = new Azure.LogicApps.ActionCustom("actionCustomResource", new()
    {
        Body = "string",
        LogicAppId = "string",
        Name = "string",
    });
    
    example, err := logicapps.NewActionCustom(ctx, "actionCustomResource", &logicapps.ActionCustomArgs{
    	Body:       pulumi.String("string"),
    	LogicAppId: pulumi.String("string"),
    	Name:       pulumi.String("string"),
    })
    
    var actionCustomResource = new ActionCustom("actionCustomResource", ActionCustomArgs.builder()
        .body("string")
        .logicAppId("string")
        .name("string")
        .build());
    
    action_custom_resource = azure.logicapps.ActionCustom("actionCustomResource",
        body="string",
        logic_app_id="string",
        name="string")
    
    const actionCustomResource = new azure.logicapps.ActionCustom("actionCustomResource", {
        body: "string",
        logicAppId: "string",
        name: "string",
    });
    
    type: azure:logicapps:ActionCustom
    properties:
        body: string
        logicAppId: string
        name: string
    

    ActionCustom 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 ActionCustom resource accepts the following input properties:

    Body string
    Specifies the JSON Blob defining the Body of this Custom Action.
    LogicAppId string
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    Body string
    Specifies the JSON Blob defining the Body of this Custom Action.
    LogicAppId string
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body String
    Specifies the JSON Blob defining the Body of this Custom Action.
    logicAppId String
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name String

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body string
    Specifies the JSON Blob defining the Body of this Custom Action.
    logicAppId string
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name string

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body str
    Specifies the JSON Blob defining the Body of this Custom Action.
    logic_app_id str
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name str

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body String
    Specifies the JSON Blob defining the Body of this Custom Action.
    logicAppId String
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name String

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ActionCustom 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 ActionCustom Resource

    Get an existing ActionCustom 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?: ActionCustomState, opts?: CustomResourceOptions): ActionCustom
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            body: Optional[str] = None,
            logic_app_id: Optional[str] = None,
            name: Optional[str] = None) -> ActionCustom
    func GetActionCustom(ctx *Context, name string, id IDInput, state *ActionCustomState, opts ...ResourceOption) (*ActionCustom, error)
    public static ActionCustom Get(string name, Input<string> id, ActionCustomState? state, CustomResourceOptions? opts = null)
    public static ActionCustom get(String name, Output<String> id, ActionCustomState 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
    Specifies the JSON Blob defining the Body of this Custom Action.
    LogicAppId string
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    Body string
    Specifies the JSON Blob defining the Body of this Custom Action.
    LogicAppId string
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body String
    Specifies the JSON Blob defining the Body of this Custom Action.
    logicAppId String
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name String

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body string
    Specifies the JSON Blob defining the Body of this Custom Action.
    logicAppId string
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name string

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body str
    Specifies the JSON Blob defining the Body of this Custom Action.
    logic_app_id str
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name str

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    body String
    Specifies the JSON Blob defining the Body of this Custom Action.
    logicAppId String
    Specifies the ID of the Logic App Workflow. Changing this forces a new resource to be created.
    name String

    Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.

    NOTE: This name must be unique across all Actions within the Logic App Workflow.

    Import

    Logic App Custom Actions can be imported using the resource id, e.g.

    $ pulumi import azure:logicapps/actionCustom:ActionCustom custom1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Logic/workflows/workflow1/actions/custom1
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v6.4.0 published on Tuesday, Oct 8, 2024 by Pulumi