1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. getChannel
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.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.eventgrid.getChannel

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.29.0 published on Friday, Feb 16, 2024 by Pulumi

    Get properties of a channel. Azure REST API version: 2022-06-15.

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

    Using getChannel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getChannel(args: GetChannelArgs, opts?: InvokeOptions): Promise<GetChannelResult>
    function getChannelOutput(args: GetChannelOutputArgs, opts?: InvokeOptions): Output<GetChannelResult>
    def get_channel(channel_name: Optional[str] = None,
                    partner_namespace_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetChannelResult
    def get_channel_output(channel_name: Optional[pulumi.Input[str]] = None,
                    partner_namespace_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetChannelResult]
    func LookupChannel(ctx *Context, args *LookupChannelArgs, opts ...InvokeOption) (*LookupChannelResult, error)
    func LookupChannelOutput(ctx *Context, args *LookupChannelOutputArgs, opts ...InvokeOption) LookupChannelResultOutput

    > Note: This function is named LookupChannel in the Go SDK.

    public static class GetChannel 
    {
        public static Task<GetChannelResult> InvokeAsync(GetChannelArgs args, InvokeOptions? opts = null)
        public static Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:eventgrid:getChannel
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ChannelName string
    Name of the channel.
    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.
    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.
    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.
    partnerNamespaceName string
    Name of the partner namespace.
    resourceGroupName string
    The name of the resource group within the partners subscription.
    channel_name str
    Name of the channel.
    partner_namespace_name str
    Name of the partner namespace.
    resource_group_name str
    The name of the resource group within the partners subscription.
    channelName String
    Name of the channel.
    partnerNamespaceName String
    Name of the partner namespace.
    resourceGroupName String
    The name of the resource group within the partners subscription.

    getChannel Result

    The following output properties are available:

    Id string
    Fully qualified identifier of the 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.
    ChannelType string
    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.Outputs.PartnerTopicInfoResponse
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    ProvisioningState string
    Provisioning state of the channel.
    ReadinessState string
    The readiness state of the corresponding partner topic.
    Id string
    Fully qualified identifier of the resource.
    Name string
    Name of the resource.
    SystemData SystemDataResponse
    The system metadata relating to Channel resource.
    Type string
    Type of the resource.
    ChannelType string
    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 PartnerTopicInfoResponse
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    ProvisioningState string
    Provisioning state of the channel.
    ReadinessState string
    The readiness state of the corresponding partner topic.
    id String
    Fully qualified identifier of the resource.
    name String
    Name of the resource.
    systemData SystemDataResponse
    The system metadata relating to Channel resource.
    type String
    Type of the resource.
    channelType String
    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 PartnerTopicInfoResponse
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioningState String
    Provisioning state of the channel.
    readinessState String
    The readiness state of the corresponding partner topic.
    id string
    Fully qualified identifier of the resource.
    name string
    Name of the resource.
    systemData SystemDataResponse
    The system metadata relating to Channel resource.
    type string
    Type of the resource.
    channelType string
    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 PartnerTopicInfoResponse
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioningState string
    Provisioning state of the channel.
    readinessState string
    The readiness state of the corresponding partner topic.
    id str
    Fully qualified identifier of the resource.
    name str
    Name of the resource.
    system_data SystemDataResponse
    The system metadata relating to Channel resource.
    type str
    Type of the resource.
    channel_type str
    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 PartnerTopicInfoResponse
    This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
    provisioning_state str
    Provisioning state of the channel.
    readiness_state str
    The readiness state of the corresponding partner topic.
    id String
    Fully qualified identifier of the resource.
    name String
    Name of the resource.
    systemData Property Map
    The system metadata relating to Channel resource.
    type String
    Type of the resource.
    channelType String
    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
    Provisioning state of the channel.
    readinessState String
    The readiness state of the corresponding partner topic.

    Supporting Types

    EventTypeInfoResponse

    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.

    InlineEventPropertiesResponse

    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.

    PartnerTopicInfoResponse

    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.

    SystemDataResponse

    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.

    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.29.0 published on Friday, Feb 16, 2024 by Pulumi