1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. Channel
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi

azure-native.eventgrid.Channel

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi

    Channel info. Azure REST API version: 2022-06-15. Prior API version in Azure Native 1.x: 2021-10-15-preview.

    Other available API versions: 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview.

    Example Usage

    Channels_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var channel = new AzureNative.EventGrid.Channel("channel", new()
        {
            ChannelName = "exampleChannelName1",
            ChannelType = AzureNative.EventGrid.ChannelType.PartnerTopic,
            ExpirationTimeIfNotActivatedUtc = "2021-10-21T22:50:25.410433Z",
            MessageForActivation = "Example message to approver",
            PartnerNamespaceName = "examplePartnerNamespaceName1",
            PartnerTopicInfo = new AzureNative.EventGrid.Inputs.PartnerTopicInfoArgs
            {
                AzureSubscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
                Name = "examplePartnerTopic1",
                ResourceGroupName = "examplerg2",
                Source = "ContosoCorp.Accounts.User1",
            },
            ResourceGroupName = "examplerg",
        });
    
    });
    
    package main
    
    import (
    	eventgrid "github.com/pulumi/pulumi-azure-native-sdk/eventgrid/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := eventgrid.NewChannel(ctx, "channel", &eventgrid.ChannelArgs{
    			ChannelName:                     pulumi.String("exampleChannelName1"),
    			ChannelType:                     pulumi.String(eventgrid.ChannelTypePartnerTopic),
    			ExpirationTimeIfNotActivatedUtc: pulumi.String("2021-10-21T22:50:25.410433Z"),
    			MessageForActivation:            pulumi.String("Example message to approver"),
    			PartnerNamespaceName:            pulumi.String("examplePartnerNamespaceName1"),
    			PartnerTopicInfo: &eventgrid.PartnerTopicInfoArgs{
    				AzureSubscriptionId: pulumi.String("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
    				Name:                pulumi.String("examplePartnerTopic1"),
    				ResourceGroupName:   pulumi.String("examplerg2"),
    				Source:              pulumi.String("ContosoCorp.Accounts.User1"),
    			},
    			ResourceGroupName: pulumi.String("examplerg"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.eventgrid.Channel;
    import com.pulumi.azurenative.eventgrid.ChannelArgs;
    import com.pulumi.azurenative.eventgrid.inputs.PartnerTopicInfoArgs;
    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 channel = new Channel("channel", ChannelArgs.builder()
                .channelName("exampleChannelName1")
                .channelType("PartnerTopic")
                .expirationTimeIfNotActivatedUtc("2021-10-21T22:50:25.410433Z")
                .messageForActivation("Example message to approver")
                .partnerNamespaceName("examplePartnerNamespaceName1")
                .partnerTopicInfo(PartnerTopicInfoArgs.builder()
                    .azureSubscriptionId("5b4b650e-28b9-4790-b3ab-ddbd88d727c4")
                    .name("examplePartnerTopic1")
                    .resourceGroupName("examplerg2")
                    .source("ContosoCorp.Accounts.User1")
                    .build())
                .resourceGroupName("examplerg")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    channel = azure_native.eventgrid.Channel("channel",
        channel_name="exampleChannelName1",
        channel_type=azure_native.eventgrid.ChannelType.PARTNER_TOPIC,
        expiration_time_if_not_activated_utc="2021-10-21T22:50:25.410433Z",
        message_for_activation="Example message to approver",
        partner_namespace_name="examplePartnerNamespaceName1",
        partner_topic_info={
            "azure_subscription_id": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
            "name": "examplePartnerTopic1",
            "resource_group_name": "examplerg2",
            "source": "ContosoCorp.Accounts.User1",
        },
        resource_group_name="examplerg")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const channel = new azure_native.eventgrid.Channel("channel", {
        channelName: "exampleChannelName1",
        channelType: azure_native.eventgrid.ChannelType.PartnerTopic,
        expirationTimeIfNotActivatedUtc: "2021-10-21T22:50:25.410433Z",
        messageForActivation: "Example message to approver",
        partnerNamespaceName: "examplePartnerNamespaceName1",
        partnerTopicInfo: {
            azureSubscriptionId: "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
            name: "examplePartnerTopic1",
            resourceGroupName: "examplerg2",
            source: "ContosoCorp.Accounts.User1",
        },
        resourceGroupName: "examplerg",
    });
    
    resources:
      channel:
        type: azure-native:eventgrid:Channel
        properties:
          channelName: exampleChannelName1
          channelType: PartnerTopic
          expirationTimeIfNotActivatedUtc: 2021-10-21T22:50:25.410433Z
          messageForActivation: Example message to approver
          partnerNamespaceName: examplePartnerNamespaceName1
          partnerTopicInfo:
            azureSubscriptionId: 5b4b650e-28b9-4790-b3ab-ddbd88d727c4
            name: examplePartnerTopic1
            resourceGroupName: examplerg2
            source: ContosoCorp.Accounts.User1
          resourceGroupName: examplerg
    

    Create Channel Resource

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

    Constructor syntax

    new Channel(name: string, args: ChannelArgs, opts?: CustomResourceOptions);
    @overload
    def Channel(resource_name: str,
                args: ChannelArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Channel(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                partner_namespace_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                channel_name: Optional[str] = None,
                channel_type: Optional[Union[str, ChannelType]] = None,
                expiration_time_if_not_activated_utc: Optional[str] = None,
                message_for_activation: Optional[str] = None,
                partner_topic_info: Optional[PartnerTopicInfoArgs] = None,
                provisioning_state: Optional[Union[str, ChannelProvisioningState]] = None,
                readiness_state: Optional[Union[str, ReadinessState]] = None)
    func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)
    public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
    public Channel(String name, ChannelArgs args)
    public Channel(String name, ChannelArgs args, CustomResourceOptions options)
    
    type: azure-native:eventgrid:Channel
    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 ChannelArgs
    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 ChannelArgs
    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 ChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelArgs
    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 examplechannelResourceResourceFromEventgrid = new AzureNative.EventGrid.Channel("examplechannelResourceResourceFromEventgrid", new()
    {
        PartnerNamespaceName = "string",
        ResourceGroupName = "string",
        ChannelName = "string",
        ChannelType = "string",
        ExpirationTimeIfNotActivatedUtc = "string",
        MessageForActivation = "string",
        PartnerTopicInfo = new AzureNative.EventGrid.Inputs.PartnerTopicInfoArgs
        {
            AzureSubscriptionId = "string",
            EventTypeInfo = new AzureNative.EventGrid.Inputs.EventTypeInfoArgs
            {
                InlineEventTypes = 
                {
                    { "string", new AzureNative.EventGrid.Inputs.InlineEventPropertiesArgs
                    {
                        DataSchemaUrl = "string",
                        Description = "string",
                        DisplayName = "string",
                        DocumentationUrl = "string",
                    } },
                },
                Kind = "string",
            },
            Name = "string",
            ResourceGroupName = "string",
            Source = "string",
        },
        ProvisioningState = "string",
        ReadinessState = "string",
    });
    
    example, err := eventgrid.NewChannel(ctx, "examplechannelResourceResourceFromEventgrid", &eventgrid.ChannelArgs{
    	PartnerNamespaceName:            pulumi.String("string"),
    	ResourceGroupName:               pulumi.String("string"),
    	ChannelName:                     pulumi.String("string"),
    	ChannelType:                     pulumi.String("string"),
    	ExpirationTimeIfNotActivatedUtc: pulumi.String("string"),
    	MessageForActivation:            pulumi.String("string"),
    	PartnerTopicInfo: &eventgrid.PartnerTopicInfoArgs{
    		AzureSubscriptionId: pulumi.String("string"),
    		EventTypeInfo: &eventgrid.EventTypeInfoArgs{
    			InlineEventTypes: eventgrid.InlineEventPropertiesMap{
    				"string": &eventgrid.InlineEventPropertiesArgs{
    					DataSchemaUrl:    pulumi.String("string"),
    					Description:      pulumi.String("string"),
    					DisplayName:      pulumi.String("string"),
    					DocumentationUrl: pulumi.String("string"),
    				},
    			},
    			Kind: pulumi.String("string"),
    		},
    		Name:              pulumi.String("string"),
    		ResourceGroupName: pulumi.String("string"),
    		Source:            pulumi.String("string"),
    	},
    	ProvisioningState: pulumi.String("string"),
    	ReadinessState:    pulumi.String("string"),
    })
    
    var examplechannelResourceResourceFromEventgrid = new Channel("examplechannelResourceResourceFromEventgrid", ChannelArgs.builder()
        .partnerNamespaceName("string")
        .resourceGroupName("string")
        .channelName("string")
        .channelType("string")
        .expirationTimeIfNotActivatedUtc("string")
        .messageForActivation("string")
        .partnerTopicInfo(PartnerTopicInfoArgs.builder()
            .azureSubscriptionId("string")
            .eventTypeInfo(EventTypeInfoArgs.builder()
                .inlineEventTypes(Map.of("string", Map.ofEntries(
                    Map.entry("dataSchemaUrl", "string"),
                    Map.entry("description", "string"),
                    Map.entry("displayName", "string"),
                    Map.entry("documentationUrl", "string")
                )))
                .kind("string")
                .build())
            .name("string")
            .resourceGroupName("string")
            .source("string")
            .build())
        .provisioningState("string")
        .readinessState("string")
        .build());
    
    examplechannel_resource_resource_from_eventgrid = azure_native.eventgrid.Channel("examplechannelResourceResourceFromEventgrid",
        partner_namespace_name="string",
        resource_group_name="string",
        channel_name="string",
        channel_type="string",
        expiration_time_if_not_activated_utc="string",
        message_for_activation="string",
        partner_topic_info={
            "azureSubscriptionId": "string",
            "eventTypeInfo": {
                "inlineEventTypes": {
                    "string": {
                        "dataSchemaUrl": "string",
                        "description": "string",
                        "displayName": "string",
                        "documentationUrl": "string",
                    },
                },
                "kind": "string",
            },
            "name": "string",
            "resourceGroupName": "string",
            "source": "string",
        },
        provisioning_state="string",
        readiness_state="string")
    
    const examplechannelResourceResourceFromEventgrid = new azure_native.eventgrid.Channel("examplechannelResourceResourceFromEventgrid", {
        partnerNamespaceName: "string",
        resourceGroupName: "string",
        channelName: "string",
        channelType: "string",
        expirationTimeIfNotActivatedUtc: "string",
        messageForActivation: "string",
        partnerTopicInfo: {
            azureSubscriptionId: "string",
            eventTypeInfo: {
                inlineEventTypes: {
                    string: {
                        dataSchemaUrl: "string",
                        description: "string",
                        displayName: "string",
                        documentationUrl: "string",
                    },
                },
                kind: "string",
            },
            name: "string",
            resourceGroupName: "string",
            source: "string",
        },
        provisioningState: "string",
        readinessState: "string",
    });
    
    type: azure-native:eventgrid:Channel
    properties:
        channelName: string
        channelType: string
        expirationTimeIfNotActivatedUtc: string
        messageForActivation: string
        partnerNamespaceName: string
        partnerTopicInfo:
            azureSubscriptionId: string
            eventTypeInfo:
                inlineEventTypes:
                    string:
                        dataSchemaUrl: string
                        description: string
                        displayName: string
                        documentationUrl: string
                kind: string
            name: string
            resourceGroupName: string
            source: string
        provisioningState: string
        readinessState: string
        resourceGroupName: string
    

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

    PartnerNamespaceName string
    Name of the partner namespace.
    ResourceGroupName string
    The name of the resource group within the partners subscription.
    ChannelName string
    Name of the channel.
    ChannelType string | Pulumi.AzureNative.EventGrid.ChannelType
    The type of the event channel which represents the direction flow of events.
    ExpirationTimeIfNotActivatedUtc string
    Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
    MessageForActivation string
    Context or helpful message that can be used during the approval process by the subscriber.
    PartnerTopicInfo Pulumi.AzureNative.EventGrid.Inputs.PartnerTopicInfo
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    ProvisioningState string | Pulumi.AzureNative.EventGrid.ChannelProvisioningState
    Provisioning state of the channel.
    ReadinessState string | Pulumi.AzureNative.EventGrid.ReadinessState
    The readiness state of the corresponding partner topic.
    PartnerNamespaceName string
    Name of the partner namespace.
    ResourceGroupName string
    The name of the resource group within the partners subscription.
    ChannelName string
    Name of the channel.
    ChannelType string | ChannelType
    The type of the event channel which represents the direction flow of events.
    ExpirationTimeIfNotActivatedUtc string
    Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
    MessageForActivation string
    Context or helpful message that can be used during the approval process by the subscriber.
    PartnerTopicInfo PartnerTopicInfoArgs
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    ProvisioningState string | ChannelProvisioningState
    Provisioning state of the channel.
    ReadinessState string | ReadinessState
    The readiness state of the corresponding partner topic.
    partnerNamespaceName String
    Name of the partner namespace.
    resourceGroupName String
    The name of the resource group within the partners subscription.
    channelName String
    Name of the channel.
    channelType String | ChannelType
    The type of the event channel which represents the direction flow of events.
    expirationTimeIfNotActivatedUtc String
    Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
    messageForActivation String
    Context or helpful message that can be used during the approval process by the subscriber.
    partnerTopicInfo PartnerTopicInfo
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioningState String | ChannelProvisioningState
    Provisioning state of the channel.
    readinessState String | ReadinessState
    The readiness state of the corresponding partner topic.
    partnerNamespaceName string
    Name of the partner namespace.
    resourceGroupName string
    The name of the resource group within the partners subscription.
    channelName string
    Name of the channel.
    channelType string | ChannelType
    The type of the event channel which represents the direction flow of events.
    expirationTimeIfNotActivatedUtc string
    Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
    messageForActivation string
    Context or helpful message that can be used during the approval process by the subscriber.
    partnerTopicInfo PartnerTopicInfo
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioningState string | ChannelProvisioningState
    Provisioning state of the channel.
    readinessState string | ReadinessState
    The readiness state of the corresponding partner topic.
    partner_namespace_name str
    Name of the partner namespace.
    resource_group_name str
    The name of the resource group within the partners subscription.
    channel_name str
    Name of the channel.
    channel_type str | ChannelType
    The type of the event channel which represents the direction flow of events.
    expiration_time_if_not_activated_utc str
    Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
    message_for_activation str
    Context or helpful message that can be used during the approval process by the subscriber.
    partner_topic_info PartnerTopicInfoArgs
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioning_state str | ChannelProvisioningState
    Provisioning state of the channel.
    readiness_state str | ReadinessState
    The readiness state of the corresponding partner topic.
    partnerNamespaceName String
    Name of the partner namespace.
    resourceGroupName String
    The name of the resource group within the partners subscription.
    channelName String
    Name of the channel.
    channelType String | "PartnerTopic"
    The type of the event channel which represents the direction flow of events.
    expirationTimeIfNotActivatedUtc String
    Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
    messageForActivation String
    Context or helpful message that can be used during the approval process by the subscriber.
    partnerTopicInfo Property Map
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioningState String | "Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed" | "IdleDueToMirroredPartnerTopicDeletion"
    Provisioning state of the channel.
    readinessState String | "NeverActivated" | "Activated"
    The readiness state of the corresponding partner topic.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the resource.
    SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
    The system metadata relating to Channel resource.
    Type string
    Type of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the resource.
    SystemData SystemDataResponse
    The system metadata relating to Channel resource.
    Type string
    Type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the resource.
    systemData SystemDataResponse
    The system metadata relating to Channel resource.
    type String
    Type of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the resource.
    systemData SystemDataResponse
    The system metadata relating to Channel resource.
    type string
    Type of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the resource.
    system_data SystemDataResponse
    The system metadata relating to Channel resource.
    type str
    Type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the resource.
    systemData Property Map
    The system metadata relating to Channel resource.
    type String
    Type of the resource.

    Supporting Types

    ChannelProvisioningState, ChannelProvisioningStateArgs

    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    IdleDueToMirroredPartnerTopicDeletion
    IdleDueToMirroredPartnerTopicDeletion
    ChannelProvisioningStateCreating
    Creating
    ChannelProvisioningStateUpdating
    Updating
    ChannelProvisioningStateDeleting
    Deleting
    ChannelProvisioningStateSucceeded
    Succeeded
    ChannelProvisioningStateCanceled
    Canceled
    ChannelProvisioningStateFailed
    Failed
    ChannelProvisioningStateIdleDueToMirroredPartnerTopicDeletion
    IdleDueToMirroredPartnerTopicDeletion
    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    IdleDueToMirroredPartnerTopicDeletion
    IdleDueToMirroredPartnerTopicDeletion
    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    IdleDueToMirroredPartnerTopicDeletion
    IdleDueToMirroredPartnerTopicDeletion
    CREATING
    Creating
    UPDATING
    Updating
    DELETING
    Deleting
    SUCCEEDED
    Succeeded
    CANCELED
    Canceled
    FAILED
    Failed
    IDLE_DUE_TO_MIRRORED_PARTNER_TOPIC_DELETION
    IdleDueToMirroredPartnerTopicDeletion
    "Creating"
    Creating
    "Updating"
    Updating
    "Deleting"
    Deleting
    "Succeeded"
    Succeeded
    "Canceled"
    Canceled
    "Failed"
    Failed
    "IdleDueToMirroredPartnerTopicDeletion"
    IdleDueToMirroredPartnerTopicDeletion

    ChannelType, ChannelTypeArgs

    PartnerTopic
    PartnerTopic
    ChannelTypePartnerTopic
    PartnerTopic
    PartnerTopic
    PartnerTopic
    PartnerTopic
    PartnerTopic
    PARTNER_TOPIC
    PartnerTopic
    "PartnerTopic"
    PartnerTopic

    EventDefinitionKind, EventDefinitionKindArgs

    Inline
    Inline
    EventDefinitionKindInline
    Inline
    Inline
    Inline
    Inline
    Inline
    INLINE
    Inline
    "Inline"
    Inline

    EventTypeInfo, EventTypeInfoArgs

    InlineEventTypes Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.InlineEventProperties>
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    Kind string | Pulumi.AzureNative.EventGrid.EventDefinitionKind
    The kind of event type used.
    InlineEventTypes map[string]InlineEventProperties
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    Kind string | EventDefinitionKind
    The kind of event type used.
    inlineEventTypes Map<String,InlineEventProperties>
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind String | EventDefinitionKind
    The kind of event type used.
    inlineEventTypes {[key: string]: InlineEventProperties}
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind string | EventDefinitionKind
    The kind of event type used.
    inline_event_types Mapping[str, InlineEventProperties]
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind str | EventDefinitionKind
    The kind of event type used.
    inlineEventTypes Map<Property Map>
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind String | "Inline"
    The kind of event type used.

    EventTypeInfoResponse, EventTypeInfoResponseArgs

    InlineEventTypes Dictionary<string, Pulumi.AzureNative.EventGrid.Inputs.InlineEventPropertiesResponse>
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    Kind string
    The kind of event type used.
    InlineEventTypes map[string]InlineEventPropertiesResponse
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    Kind string
    The kind of event type used.
    inlineEventTypes Map<String,InlineEventPropertiesResponse>
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind String
    The kind of event type used.
    inlineEventTypes {[key: string]: InlineEventPropertiesResponse}
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind string
    The kind of event type used.
    inline_event_types Mapping[str, InlineEventPropertiesResponse]
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind str
    The kind of event type used.
    inlineEventTypes Map<Property Map>
    A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.
    kind String
    The kind of event type used.

    InlineEventProperties, InlineEventPropertiesArgs

    DataSchemaUrl string
    The dataSchemaUrl for the inline event.
    Description string
    The description for the inline event.
    DisplayName string
    The displayName for the inline event.
    DocumentationUrl string
    The documentationUrl for the inline event.
    DataSchemaUrl string
    The dataSchemaUrl for the inline event.
    Description string
    The description for the inline event.
    DisplayName string
    The displayName for the inline event.
    DocumentationUrl string
    The documentationUrl for the inline event.
    dataSchemaUrl String
    The dataSchemaUrl for the inline event.
    description String
    The description for the inline event.
    displayName String
    The displayName for the inline event.
    documentationUrl String
    The documentationUrl for the inline event.
    dataSchemaUrl string
    The dataSchemaUrl for the inline event.
    description string
    The description for the inline event.
    displayName string
    The displayName for the inline event.
    documentationUrl string
    The documentationUrl for the inline event.
    data_schema_url str
    The dataSchemaUrl for the inline event.
    description str
    The description for the inline event.
    display_name str
    The displayName for the inline event.
    documentation_url str
    The documentationUrl for the inline event.
    dataSchemaUrl String
    The dataSchemaUrl for the inline event.
    description String
    The description for the inline event.
    displayName String
    The displayName for the inline event.
    documentationUrl String
    The documentationUrl for the inline event.

    InlineEventPropertiesResponse, InlineEventPropertiesResponseArgs

    DataSchemaUrl string
    The dataSchemaUrl for the inline event.
    Description string
    The description for the inline event.
    DisplayName string
    The displayName for the inline event.
    DocumentationUrl string
    The documentationUrl for the inline event.
    DataSchemaUrl string
    The dataSchemaUrl for the inline event.
    Description string
    The description for the inline event.
    DisplayName string
    The displayName for the inline event.
    DocumentationUrl string
    The documentationUrl for the inline event.
    dataSchemaUrl String
    The dataSchemaUrl for the inline event.
    description String
    The description for the inline event.
    displayName String
    The displayName for the inline event.
    documentationUrl String
    The documentationUrl for the inline event.
    dataSchemaUrl string
    The dataSchemaUrl for the inline event.
    description string
    The description for the inline event.
    displayName string
    The displayName for the inline event.
    documentationUrl string
    The documentationUrl for the inline event.
    data_schema_url str
    The dataSchemaUrl for the inline event.
    description str
    The description for the inline event.
    display_name str
    The displayName for the inline event.
    documentation_url str
    The documentationUrl for the inline event.
    dataSchemaUrl String
    The dataSchemaUrl for the inline event.
    description String
    The description for the inline event.
    displayName String
    The displayName for the inline event.
    documentationUrl String
    The documentationUrl for the inline event.

    PartnerTopicInfo, PartnerTopicInfoArgs

    AzureSubscriptionId string
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    EventTypeInfo Pulumi.AzureNative.EventGrid.Inputs.EventTypeInfo
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    Name string
    Name of the partner topic associated with the channel.
    ResourceGroupName string
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    Source string
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    AzureSubscriptionId string
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    EventTypeInfo EventTypeInfo
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    Name string
    Name of the partner topic associated with the channel.
    ResourceGroupName string
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    Source string
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azureSubscriptionId String
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    eventTypeInfo EventTypeInfo
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name String
    Name of the partner topic associated with the channel.
    resourceGroupName String
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source String
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azureSubscriptionId string
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    eventTypeInfo EventTypeInfo
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name string
    Name of the partner topic associated with the channel.
    resourceGroupName string
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source string
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azure_subscription_id str
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    event_type_info EventTypeInfo
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name str
    Name of the partner topic associated with the channel.
    resource_group_name str
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source str
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azureSubscriptionId String
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    eventTypeInfo Property Map
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name String
    Name of the partner topic associated with the channel.
    resourceGroupName String
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source String
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.

    PartnerTopicInfoResponse, PartnerTopicInfoResponseArgs

    AzureSubscriptionId string
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    EventTypeInfo Pulumi.AzureNative.EventGrid.Inputs.EventTypeInfoResponse
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    Name string
    Name of the partner topic associated with the channel.
    ResourceGroupName string
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    Source string
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    AzureSubscriptionId string
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    EventTypeInfo EventTypeInfoResponse
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    Name string
    Name of the partner topic associated with the channel.
    ResourceGroupName string
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    Source string
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azureSubscriptionId String
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    eventTypeInfo EventTypeInfoResponse
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name String
    Name of the partner topic associated with the channel.
    resourceGroupName String
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source String
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azureSubscriptionId string
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    eventTypeInfo EventTypeInfoResponse
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name string
    Name of the partner topic associated with the channel.
    resourceGroupName string
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source string
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azure_subscription_id str
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    event_type_info EventTypeInfoResponse
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name str
    Name of the partner topic associated with the channel.
    resource_group_name str
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source str
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.
    azureSubscriptionId String
    Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.
    eventTypeInfo Property Map
    Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
    name String
    Name of the partner topic associated with the channel.
    resourceGroupName String
    Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.
    source String
    The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.

    ReadinessState, ReadinessStateArgs

    NeverActivated
    NeverActivated
    Activated
    Activated
    ReadinessStateNeverActivated
    NeverActivated
    ReadinessStateActivated
    Activated
    NeverActivated
    NeverActivated
    Activated
    Activated
    NeverActivated
    NeverActivated
    Activated
    Activated
    NEVER_ACTIVATED
    NeverActivated
    ACTIVATED
    Activated
    "NeverActivated"
    NeverActivated
    "Activated"
    Activated

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:eventgrid:Channel exampleChannelName1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi