1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. WorkflowTaskInviteToMicrosoftTeamsChannel
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

    Manages workflow inviteToMicrosoftTeamsChannel task.

    Create WorkflowTaskInviteToMicrosoftTeamsChannel Resource

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

    Constructor syntax

    new WorkflowTaskInviteToMicrosoftTeamsChannel(name: string, args: WorkflowTaskInviteToMicrosoftTeamsChannelArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskInviteToMicrosoftTeamsChannel(resource_name: str,
                                                  args: WorkflowTaskInviteToMicrosoftTeamsChannelArgs,
                                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskInviteToMicrosoftTeamsChannel(resource_name: str,
                                                  opts: Optional[ResourceOptions] = None,
                                                  task_params: Optional[WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs] = None,
                                                  workflow_id: Optional[str] = None,
                                                  enabled: Optional[bool] = None,
                                                  name: Optional[str] = None,
                                                  position: Optional[int] = None,
                                                  skip_on_failure: Optional[bool] = None)
    func NewWorkflowTaskInviteToMicrosoftTeamsChannel(ctx *Context, name string, args WorkflowTaskInviteToMicrosoftTeamsChannelArgs, opts ...ResourceOption) (*WorkflowTaskInviteToMicrosoftTeamsChannel, error)
    public WorkflowTaskInviteToMicrosoftTeamsChannel(string name, WorkflowTaskInviteToMicrosoftTeamsChannelArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskInviteToMicrosoftTeamsChannel(String name, WorkflowTaskInviteToMicrosoftTeamsChannelArgs args)
    public WorkflowTaskInviteToMicrosoftTeamsChannel(String name, WorkflowTaskInviteToMicrosoftTeamsChannelArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskInviteToMicrosoftTeamsChannel
    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 WorkflowTaskInviteToMicrosoftTeamsChannelArgs
    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 WorkflowTaskInviteToMicrosoftTeamsChannelArgs
    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 WorkflowTaskInviteToMicrosoftTeamsChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskInviteToMicrosoftTeamsChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskInviteToMicrosoftTeamsChannelArgs
    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 workflowTaskInviteToMicrosoftTeamsChannelResource = new Rootly.WorkflowTaskInviteToMicrosoftTeamsChannel("workflowTaskInviteToMicrosoftTeamsChannelResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs
        {
            Channel = 
            {
                { "string", "string" },
            },
            Emails = "string",
            TaskType = "string",
            Team = 
            {
                { "string", "string" },
            },
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskInviteToMicrosoftTeamsChannel(ctx, "workflowTaskInviteToMicrosoftTeamsChannelResource", &rootly.WorkflowTaskInviteToMicrosoftTeamsChannelArgs{
    	TaskParams: &rootly.WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs{
    		Channel: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		Emails:   pulumi.String("string"),
    		TaskType: pulumi.String("string"),
    		Team: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    	},
    	WorkflowId:    pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	Position:      pulumi.Int(0),
    	SkipOnFailure: pulumi.Bool(false),
    })
    
    var workflowTaskInviteToMicrosoftTeamsChannelResource = new WorkflowTaskInviteToMicrosoftTeamsChannel("workflowTaskInviteToMicrosoftTeamsChannelResource", WorkflowTaskInviteToMicrosoftTeamsChannelArgs.builder()
        .taskParams(WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs.builder()
            .channel(Map.of("string", "string"))
            .emails("string")
            .taskType("string")
            .team(Map.of("string", "string"))
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_invite_to_microsoft_teams_channel_resource = rootly.WorkflowTaskInviteToMicrosoftTeamsChannel("workflowTaskInviteToMicrosoftTeamsChannelResource",
        task_params={
            "channel": {
                "string": "string",
            },
            "emails": "string",
            "task_type": "string",
            "team": {
                "string": "string",
            },
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskInviteToMicrosoftTeamsChannelResource = new rootly.WorkflowTaskInviteToMicrosoftTeamsChannel("workflowTaskInviteToMicrosoftTeamsChannelResource", {
        taskParams: {
            channel: {
                string: "string",
            },
            emails: "string",
            taskType: "string",
            team: {
                string: "string",
            },
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskInviteToMicrosoftTeamsChannel
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            channel:
                string: string
            emails: string
            taskType: string
            team:
                string: string
        workflowId: string
    

    WorkflowTaskInviteToMicrosoftTeamsChannel Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkflowTaskInviteToMicrosoftTeamsChannel resource accepts the following input properties:

    TaskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    taskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    Name of the workflow task
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    task_params WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    Name of the workflow task
    position int
    The position of the workflow task (1 being top of list)
    skip_on_failure bool
    Skip workflow task if any failures
    taskParams Property Map
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Number
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures

    Outputs

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

    Get an existing WorkflowTaskInviteToMicrosoftTeamsChannel 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?: WorkflowTaskInviteToMicrosoftTeamsChannelState, opts?: CustomResourceOptions): WorkflowTaskInviteToMicrosoftTeamsChannel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None,
            position: Optional[int] = None,
            skip_on_failure: Optional[bool] = None,
            task_params: Optional[WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs] = None,
            workflow_id: Optional[str] = None) -> WorkflowTaskInviteToMicrosoftTeamsChannel
    func GetWorkflowTaskInviteToMicrosoftTeamsChannel(ctx *Context, name string, id IDInput, state *WorkflowTaskInviteToMicrosoftTeamsChannelState, opts ...ResourceOption) (*WorkflowTaskInviteToMicrosoftTeamsChannel, error)
    public static WorkflowTaskInviteToMicrosoftTeamsChannel Get(string name, Input<string> id, WorkflowTaskInviteToMicrosoftTeamsChannelState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskInviteToMicrosoftTeamsChannel get(String name, Output<String> id, WorkflowTaskInviteToMicrosoftTeamsChannelState state, CustomResourceOptions options)
    resources:  _:    type: rootly:WorkflowTaskInviteToMicrosoftTeamsChannel    get:      id: ${id}
    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:
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    Name of the workflow task
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    Name of the workflow task
    position int
    The position of the workflow task (1 being top of list)
    skip_on_failure bool
    Skip workflow task if any failures
    task_params WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Number
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams Property Map
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow

    Supporting Types

    WorkflowTaskInviteToMicrosoftTeamsChannelTaskParams, WorkflowTaskInviteToMicrosoftTeamsChannelTaskParamsArgs

    Channel Dictionary<string, string>
    Map must contain two fields, id and name.
    Emails string
    Comma separated list of emails to invite
    TaskType string
    Team Dictionary<string, string>
    Map must contain two fields, id and name.
    Channel map[string]string
    Map must contain two fields, id and name.
    Emails string
    Comma separated list of emails to invite
    TaskType string
    Team map[string]string
    Map must contain two fields, id and name.
    channel Map<String,String>
    Map must contain two fields, id and name.
    emails String
    Comma separated list of emails to invite
    taskType String
    team Map<String,String>
    Map must contain two fields, id and name.
    channel {[key: string]: string}
    Map must contain two fields, id and name.
    emails string
    Comma separated list of emails to invite
    taskType string
    team {[key: string]: string}
    Map must contain two fields, id and name.
    channel Mapping[str, str]
    Map must contain two fields, id and name.
    emails str
    Comma separated list of emails to invite
    task_type str
    team Mapping[str, str]
    Map must contain two fields, id and name.
    channel Map<String>
    Map must contain two fields, id and name.
    emails String
    Comma separated list of emails to invite
    taskType String
    team Map<String>
    Map must contain two fields, id and name.

    Import

    rootly.WorkflowTaskInviteToMicrosoftTeamsChannel can be imported using the import command.

    $ pulumi import rootly:index/workflowTaskInviteToMicrosoftTeamsChannel:WorkflowTaskInviteToMicrosoftTeamsChannel primary a816421c-6ceb-481a-87c4-585e47451f24
    

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf
    

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

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
      Try Pulumi Cloud free. Your team will thank you.