1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. MsteamsRecipient
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio

honeycombio.MsteamsRecipient

Explore with Pulumi AI

honeycombio logo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio

    # Resource: honeycombio.MsteamsRecipient

    honeycombio.MsteamsRecipient allows you to define and manage an MSTeams recipient that can be used by Triggers or BurnAlerts notifications.

    !> Deprecated Microsoft has deprecated Office 365 Connectors. This resource will no longer allow creation of new recipients. It is recommended you recreate your Teams recipients with the honeycombio.MsteamsWorkflowRecipient resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as honeycombio from "@pulumi/honeycombio";
    
    const prod = new honeycombio.MsteamsRecipient("prod", {url: "https://mycorp.webhook.office.com/webhookb2/abcd12345"});
    
    import pulumi
    import pulumi_honeycombio as honeycombio
    
    prod = honeycombio.MsteamsRecipient("prod", url="https://mycorp.webhook.office.com/webhookb2/abcd12345")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := honeycombio.NewMsteamsRecipient(ctx, "prod", &honeycombio.MsteamsRecipientArgs{
    			Url: pulumi.String("https://mycorp.webhook.office.com/webhookb2/abcd12345"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Honeycombio = Pulumi.Honeycombio;
    
    return await Deployment.RunAsync(() => 
    {
        var prod = new Honeycombio.MsteamsRecipient("prod", new()
        {
            Url = "https://mycorp.webhook.office.com/webhookb2/abcd12345",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.honeycombio.MsteamsRecipient;
    import com.pulumi.honeycombio.MsteamsRecipientArgs;
    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 prod = new MsteamsRecipient("prod", MsteamsRecipientArgs.builder()
                .url("https://mycorp.webhook.office.com/webhookb2/abcd12345")
                .build());
    
        }
    }
    
    resources:
      prod:
        type: honeycombio:MsteamsRecipient
        properties:
          url: https://mycorp.webhook.office.com/webhookb2/abcd12345
    

    Create MsteamsRecipient Resource

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

    Constructor syntax

    new MsteamsRecipient(name: string, args: MsteamsRecipientArgs, opts?: CustomResourceOptions);
    @overload
    def MsteamsRecipient(resource_name: str,
                         args: MsteamsRecipientArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def MsteamsRecipient(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         url: Optional[str] = None,
                         msteams_recipient_id: Optional[str] = None,
                         name: Optional[str] = None)
    func NewMsteamsRecipient(ctx *Context, name string, args MsteamsRecipientArgs, opts ...ResourceOption) (*MsteamsRecipient, error)
    public MsteamsRecipient(string name, MsteamsRecipientArgs args, CustomResourceOptions? opts = null)
    public MsteamsRecipient(String name, MsteamsRecipientArgs args)
    public MsteamsRecipient(String name, MsteamsRecipientArgs args, CustomResourceOptions options)
    
    type: honeycombio:MsteamsRecipient
    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 MsteamsRecipientArgs
    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 MsteamsRecipientArgs
    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 MsteamsRecipientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MsteamsRecipientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MsteamsRecipientArgs
    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 msteamsRecipientResource = new Honeycombio.MsteamsRecipient("msteamsRecipientResource", new()
    {
        Url = "string",
        MsteamsRecipientId = "string",
        Name = "string",
    });
    
    example, err := honeycombio.NewMsteamsRecipient(ctx, "msteamsRecipientResource", &honeycombio.MsteamsRecipientArgs{
    Url: pulumi.String("string"),
    MsteamsRecipientId: pulumi.String("string"),
    Name: pulumi.String("string"),
    })
    
    var msteamsRecipientResource = new MsteamsRecipient("msteamsRecipientResource", MsteamsRecipientArgs.builder()
        .url("string")
        .msteamsRecipientId("string")
        .name("string")
        .build());
    
    msteams_recipient_resource = honeycombio.MsteamsRecipient("msteamsRecipientResource",
        url="string",
        msteams_recipient_id="string",
        name="string")
    
    const msteamsRecipientResource = new honeycombio.MsteamsRecipient("msteamsRecipientResource", {
        url: "string",
        msteamsRecipientId: "string",
        name: "string",
    });
    
    type: honeycombio:MsteamsRecipient
    properties:
        msteamsRecipientId: string
        name: string
        url: string
    

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

    Url string
    The Incoming Webhook URL to send the notification to.
    MsteamsRecipientId string
    The ID of the recipient.
    Name string
    The name of the MS Teams Integration to create.
    Url string
    The Incoming Webhook URL to send the notification to.
    MsteamsRecipientId string
    The ID of the recipient.
    Name string
    The name of the MS Teams Integration to create.
    url String
    The Incoming Webhook URL to send the notification to.
    msteamsRecipientId String
    The ID of the recipient.
    name String
    The name of the MS Teams Integration to create.
    url string
    The Incoming Webhook URL to send the notification to.
    msteamsRecipientId string
    The ID of the recipient.
    name string
    The name of the MS Teams Integration to create.
    url str
    The Incoming Webhook URL to send the notification to.
    msteams_recipient_id str
    The ID of the recipient.
    name str
    The name of the MS Teams Integration to create.
    url String
    The Incoming Webhook URL to send the notification to.
    msteamsRecipientId String
    The ID of the recipient.
    name String
    The name of the MS Teams Integration to create.

    Outputs

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

    Get an existing MsteamsRecipient 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?: MsteamsRecipientState, opts?: CustomResourceOptions): MsteamsRecipient
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            msteams_recipient_id: Optional[str] = None,
            name: Optional[str] = None,
            url: Optional[str] = None) -> MsteamsRecipient
    func GetMsteamsRecipient(ctx *Context, name string, id IDInput, state *MsteamsRecipientState, opts ...ResourceOption) (*MsteamsRecipient, error)
    public static MsteamsRecipient Get(string name, Input<string> id, MsteamsRecipientState? state, CustomResourceOptions? opts = null)
    public static MsteamsRecipient get(String name, Output<String> id, MsteamsRecipientState state, CustomResourceOptions options)
    resources:  _:    type: honeycombio:MsteamsRecipient    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:
    MsteamsRecipientId string
    The ID of the recipient.
    Name string
    The name of the MS Teams Integration to create.
    Url string
    The Incoming Webhook URL to send the notification to.
    MsteamsRecipientId string
    The ID of the recipient.
    Name string
    The name of the MS Teams Integration to create.
    Url string
    The Incoming Webhook URL to send the notification to.
    msteamsRecipientId String
    The ID of the recipient.
    name String
    The name of the MS Teams Integration to create.
    url String
    The Incoming Webhook URL to send the notification to.
    msteamsRecipientId string
    The ID of the recipient.
    name string
    The name of the MS Teams Integration to create.
    url string
    The Incoming Webhook URL to send the notification to.
    msteams_recipient_id str
    The ID of the recipient.
    name str
    The name of the MS Teams Integration to create.
    url str
    The Incoming Webhook URL to send the notification to.
    msteamsRecipientId String
    The ID of the recipient.
    name String
    The name of the MS Teams Integration to create.
    url String
    The Incoming Webhook URL to send the notification to.

    Import

    MSTeams Recipients can be imported by their ID, e.g.

    $ pulumi import honeycombio:index/msteamsRecipient:MsteamsRecipient my_recipient nx2zsefB1cX
    

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

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio