1. Packages
  2. Ibm Provider
  3. API Docs
  4. EnDestinationMsteams
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.EnDestinationMsteams

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Create, update, or delete a MSTeams destination by using IBM Cloud™ Event Notifications.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const msteamsEnDestination = new ibm.EnDestinationMsteams("msteamsEnDestination", {
        instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
        type: "msteams",
        collectFailedEvents: false,
        description: "Destination MSTeams for event notification",
        config: {
            params: {
                url: "https://xyz.webhook.office.com",
            },
        },
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    msteams_en_destination = ibm.EnDestinationMsteams("msteamsEnDestination",
        instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
        type="msteams",
        collect_failed_events=False,
        description="Destination MSTeams for event notification",
        config={
            "params": {
                "url": "https://xyz.webhook.office.com",
            },
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewEnDestinationMsteams(ctx, "msteamsEnDestination", &ibm.EnDestinationMsteamsArgs{
    			InstanceGuid:        pulumi.Any(ibm_resource_instance.En_terraform_test_resource.Guid),
    			Type:                pulumi.String("msteams"),
    			CollectFailedEvents: pulumi.Bool(false),
    			Description:         pulumi.String("Destination MSTeams for event notification"),
    			Config: &ibm.EnDestinationMsteamsConfigArgs{
    				Params: &ibm.EnDestinationMsteamsConfigParamsArgs{
    					Url: pulumi.String("https://xyz.webhook.office.com"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var msteamsEnDestination = new Ibm.EnDestinationMsteams("msteamsEnDestination", new()
        {
            InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
            Type = "msteams",
            CollectFailedEvents = false,
            Description = "Destination MSTeams for event notification",
            Config = new Ibm.Inputs.EnDestinationMsteamsConfigArgs
            {
                Params = new Ibm.Inputs.EnDestinationMsteamsConfigParamsArgs
                {
                    Url = "https://xyz.webhook.office.com",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.EnDestinationMsteams;
    import com.pulumi.ibm.EnDestinationMsteamsArgs;
    import com.pulumi.ibm.inputs.EnDestinationMsteamsConfigArgs;
    import com.pulumi.ibm.inputs.EnDestinationMsteamsConfigParamsArgs;
    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 msteamsEnDestination = new EnDestinationMsteams("msteamsEnDestination", EnDestinationMsteamsArgs.builder()
                .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
                .type("msteams")
                .collectFailedEvents(false)
                .description("Destination MSTeams for event notification")
                .config(EnDestinationMsteamsConfigArgs.builder()
                    .params(EnDestinationMsteamsConfigParamsArgs.builder()
                        .url("https://xyz.webhook.office.com")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      msteamsEnDestination:
        type: ibm:EnDestinationMsteams
        properties:
          instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
          type: msteams
          collectFailedEvents: false
          description: Destination MSTeams for event notification
          config:
            params:
              url: https://xyz.webhook.office.com
    

    Create EnDestinationMsteams Resource

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

    Constructor syntax

    new EnDestinationMsteams(name: string, args: EnDestinationMsteamsArgs, opts?: CustomResourceOptions);
    @overload
    def EnDestinationMsteams(resource_name: str,
                             args: EnDestinationMsteamsArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def EnDestinationMsteams(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             instance_guid: Optional[str] = None,
                             type: Optional[str] = None,
                             collect_failed_events: Optional[bool] = None,
                             config: Optional[EnDestinationMsteamsConfigArgs] = None,
                             description: Optional[str] = None,
                             en_destination_msteams_id: Optional[str] = None,
                             name: Optional[str] = None)
    func NewEnDestinationMsteams(ctx *Context, name string, args EnDestinationMsteamsArgs, opts ...ResourceOption) (*EnDestinationMsteams, error)
    public EnDestinationMsteams(string name, EnDestinationMsteamsArgs args, CustomResourceOptions? opts = null)
    public EnDestinationMsteams(String name, EnDestinationMsteamsArgs args)
    public EnDestinationMsteams(String name, EnDestinationMsteamsArgs args, CustomResourceOptions options)
    
    type: ibm:EnDestinationMsteams
    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 EnDestinationMsteamsArgs
    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 EnDestinationMsteamsArgs
    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 EnDestinationMsteamsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnDestinationMsteamsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnDestinationMsteamsArgs
    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 enDestinationMsteamsResource = new Ibm.EnDestinationMsteams("enDestinationMsteamsResource", new()
    {
        InstanceGuid = "string",
        Type = "string",
        CollectFailedEvents = false,
        Config = new Ibm.Inputs.EnDestinationMsteamsConfigArgs
        {
            Params = new Ibm.Inputs.EnDestinationMsteamsConfigParamsArgs
            {
                Url = "string",
            },
        },
        Description = "string",
        EnDestinationMsteamsId = "string",
        Name = "string",
    });
    
    example, err := ibm.NewEnDestinationMsteams(ctx, "enDestinationMsteamsResource", &ibm.EnDestinationMsteamsArgs{
    	InstanceGuid:        pulumi.String("string"),
    	Type:                pulumi.String("string"),
    	CollectFailedEvents: pulumi.Bool(false),
    	Config: &ibm.EnDestinationMsteamsConfigArgs{
    		Params: &ibm.EnDestinationMsteamsConfigParamsArgs{
    			Url: pulumi.String("string"),
    		},
    	},
    	Description:            pulumi.String("string"),
    	EnDestinationMsteamsId: pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    })
    
    var enDestinationMsteamsResource = new EnDestinationMsteams("enDestinationMsteamsResource", EnDestinationMsteamsArgs.builder()
        .instanceGuid("string")
        .type("string")
        .collectFailedEvents(false)
        .config(EnDestinationMsteamsConfigArgs.builder()
            .params(EnDestinationMsteamsConfigParamsArgs.builder()
                .url("string")
                .build())
            .build())
        .description("string")
        .enDestinationMsteamsId("string")
        .name("string")
        .build());
    
    en_destination_msteams_resource = ibm.EnDestinationMsteams("enDestinationMsteamsResource",
        instance_guid="string",
        type="string",
        collect_failed_events=False,
        config={
            "params": {
                "url": "string",
            },
        },
        description="string",
        en_destination_msteams_id="string",
        name="string")
    
    const enDestinationMsteamsResource = new ibm.EnDestinationMsteams("enDestinationMsteamsResource", {
        instanceGuid: "string",
        type: "string",
        collectFailedEvents: false,
        config: {
            params: {
                url: "string",
            },
        },
        description: "string",
        enDestinationMsteamsId: "string",
        name: "string",
    });
    
    type: ibm:EnDestinationMsteams
    properties:
        collectFailedEvents: false
        config:
            params:
                url: string
        description: string
        enDestinationMsteamsId: string
        instanceGuid: string
        name: string
        type: string
    

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

    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Type string
    msteams.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationMsteamsConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    EnDestinationMsteamsId string
    (String) The unique identifier of the msteams_en_destination.
    Name string
    The Destintion name.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Type string
    msteams.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationMsteamsConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    EnDestinationMsteamsId string
    (String) The unique identifier of the msteams_en_destination.
    Name string
    The Destintion name.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    type String
    msteams.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationMsteamsConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    enDestinationMsteamsId String
    (String) The unique identifier of the msteams_en_destination.
    name String
    The Destintion name.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    type string
    msteams.
    collectFailedEvents boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationMsteamsConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description string
    The Destination description.
    enDestinationMsteamsId string
    (String) The unique identifier of the msteams_en_destination.
    name string
    The Destintion name.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    type str
    msteams.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationMsteamsConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    description str
    The Destination description.
    en_destination_msteams_id str
    (String) The unique identifier of the msteams_en_destination.
    name str
    The Destintion name.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    type String
    msteams.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config Property Map

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    enDestinationMsteamsId String
    (String) The unique identifier of the msteams_en_destination.
    name String
    The Destintion name.

    Outputs

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

    DestinationId string
    (String) The unique identifier of the created destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionCount double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames List<string>
    (List) List of subscriptions.
    UpdatedAt string
    (String) Last updated time.
    DestinationId string
    (String) The unique identifier of the created destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionCount float64
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames []string
    (List) List of subscriptions.
    UpdatedAt string
    (String) Last updated time.
    destinationId String
    (String) The unique identifier of the created destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionCount Double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    updatedAt String
    (String) Last updated time.
    destinationId string
    (String) The unique identifier of the created destination.
    id string
    The provider-assigned unique ID for this managed resource.
    subscriptionCount number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames string[]
    (List) List of subscriptions.
    updatedAt string
    (String) Last updated time.
    destination_id str
    (String) The unique identifier of the created destination.
    id str
    The provider-assigned unique ID for this managed resource.
    subscription_count float
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names Sequence[str]
    (List) List of subscriptions.
    updated_at str
    (String) Last updated time.
    destinationId String
    (String) The unique identifier of the created destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionCount Number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    updatedAt String
    (String) Last updated time.

    Look up Existing EnDestinationMsteams Resource

    Get an existing EnDestinationMsteams 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?: EnDestinationMsteamsState, opts?: CustomResourceOptions): EnDestinationMsteams
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            collect_failed_events: Optional[bool] = None,
            config: Optional[EnDestinationMsteamsConfigArgs] = None,
            description: Optional[str] = None,
            destination_id: Optional[str] = None,
            en_destination_msteams_id: Optional[str] = None,
            instance_guid: Optional[str] = None,
            name: Optional[str] = None,
            subscription_count: Optional[float] = None,
            subscription_names: Optional[Sequence[str]] = None,
            type: Optional[str] = None,
            updated_at: Optional[str] = None) -> EnDestinationMsteams
    func GetEnDestinationMsteams(ctx *Context, name string, id IDInput, state *EnDestinationMsteamsState, opts ...ResourceOption) (*EnDestinationMsteams, error)
    public static EnDestinationMsteams Get(string name, Input<string> id, EnDestinationMsteamsState? state, CustomResourceOptions? opts = null)
    public static EnDestinationMsteams get(String name, Output<String> id, EnDestinationMsteamsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnDestinationMsteams    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:
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationMsteamsConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    DestinationId string
    (String) The unique identifier of the created destination.
    EnDestinationMsteamsId string
    (String) The unique identifier of the msteams_en_destination.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    The Destintion name.
    SubscriptionCount double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames List<string>
    (List) List of subscriptions.
    Type string
    msteams.
    UpdatedAt string
    (String) Last updated time.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationMsteamsConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    DestinationId string
    (String) The unique identifier of the created destination.
    EnDestinationMsteamsId string
    (String) The unique identifier of the msteams_en_destination.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    The Destintion name.
    SubscriptionCount float64
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames []string
    (List) List of subscriptions.
    Type string
    msteams.
    UpdatedAt string
    (String) Last updated time.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationMsteamsConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    destinationId String
    (String) The unique identifier of the created destination.
    enDestinationMsteamsId String
    (String) The unique identifier of the msteams_en_destination.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    The Destintion name.
    subscriptionCount Double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    type String
    msteams.
    updatedAt String
    (String) Last updated time.
    collectFailedEvents boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationMsteamsConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description string
    The Destination description.
    destinationId string
    (String) The unique identifier of the created destination.
    enDestinationMsteamsId string
    (String) The unique identifier of the msteams_en_destination.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    name string
    The Destintion name.
    subscriptionCount number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames string[]
    (List) List of subscriptions.
    type string
    msteams.
    updatedAt string
    (String) Last updated time.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationMsteamsConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    description str
    The Destination description.
    destination_id str
    (String) The unique identifier of the created destination.
    en_destination_msteams_id str
    (String) The unique identifier of the msteams_en_destination.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    name str
    The Destintion name.
    subscription_count float
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names Sequence[str]
    (List) List of subscriptions.
    type str
    msteams.
    updated_at str
    (String) Last updated time.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config Property Map

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    destinationId String
    (String) The unique identifier of the created destination.
    enDestinationMsteamsId String
    (String) The unique identifier of the msteams_en_destination.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    The Destintion name.
    subscriptionCount Number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    type String
    msteams.
    updatedAt String
    (String) Last updated time.

    Supporting Types

    EnDestinationMsteamsConfig, EnDestinationMsteamsConfigArgs

    Params EnDestinationMsteamsConfigParams
    Nested scheme for params:
    Params EnDestinationMsteamsConfigParams
    Nested scheme for params:
    params EnDestinationMsteamsConfigParams
    Nested scheme for params:
    params EnDestinationMsteamsConfigParams
    Nested scheme for params:
    params EnDestinationMsteamsConfigParams
    Nested scheme for params:
    params Property Map
    Nested scheme for params:

    EnDestinationMsteamsConfigParams, EnDestinationMsteamsConfigParamsArgs

    Url string
    URL for msteams.
    Url string
    URL for msteams.
    url String
    URL for msteams.
    url string
    URL for msteams.
    url str
    URL for msteams.
    url String
    URL for msteams.

    Import

    You can import the ibm_en_destination_slack resource by using id.

    The id property can be formed from instance_guid, and destination_id in the following format:

    <instance_guid>/<destination_id>

    • instance_guid: A string. Unique identifier for IBM Cloud Event Notifications instance.

    • destination_id: A string. Unique identifier for Destination.

    Example

    $ pulumi import ibm:index/enDestinationMsteams:EnDestinationMsteams msteams_en_destination <instance_guid>/<destination_id>
    

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud