These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
azure-native.eventgrid.getEventChannel
Explore with Pulumi AI
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
Get properties of an event channel. API Version: 2021-06-01-preview.
Using getEventChannel
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 getEventChannel(args: GetEventChannelArgs, opts?: InvokeOptions): Promise<GetEventChannelResult>
function getEventChannelOutput(args: GetEventChannelOutputArgs, opts?: InvokeOptions): Output<GetEventChannelResult>def get_event_channel(event_channel_name: Optional[str] = None,
                      partner_namespace_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetEventChannelResult
def get_event_channel_output(event_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[GetEventChannelResult]func LookupEventChannel(ctx *Context, args *LookupEventChannelArgs, opts ...InvokeOption) (*LookupEventChannelResult, error)
func LookupEventChannelOutput(ctx *Context, args *LookupEventChannelOutputArgs, opts ...InvokeOption) LookupEventChannelResultOutput> Note: This function is named LookupEventChannel in the Go SDK.
public static class GetEventChannel 
{
    public static Task<GetEventChannelResult> InvokeAsync(GetEventChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetEventChannelResult> Invoke(GetEventChannelInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEventChannelResult> getEventChannel(GetEventChannelArgs args, InvokeOptions options)
public static Output<GetEventChannelResult> getEventChannel(GetEventChannelArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:eventgrid:getEventChannel
  arguments:
    # arguments dictionaryThe following arguments are supported:
- EventChannel stringName 
- Name of the event channel.
- PartnerNamespace stringName 
- Name of the partner namespace.
- ResourceGroup stringName 
- The name of the resource group within the user's subscription.
- EventChannel stringName 
- Name of the event channel.
- PartnerNamespace stringName 
- Name of the partner namespace.
- ResourceGroup stringName 
- The name of the resource group within the user's subscription.
- eventChannel StringName 
- Name of the event channel.
- partnerNamespace StringName 
- Name of the partner namespace.
- resourceGroup StringName 
- The name of the resource group within the user's subscription.
- eventChannel stringName 
- Name of the event channel.
- partnerNamespace stringName 
- Name of the partner namespace.
- resourceGroup stringName 
- The name of the resource group within the user's subscription.
- event_channel_ strname 
- Name of the event channel.
- partner_namespace_ strname 
- Name of the partner namespace.
- resource_group_ strname 
- The name of the resource group within the user's subscription.
- eventChannel StringName 
- Name of the event channel.
- partnerNamespace StringName 
- Name of the partner namespace.
- resourceGroup StringName 
- The name of the resource group within the user's subscription.
getEventChannel Result
The following output properties are available:
- Id string
- Fully qualified identifier of the resource.
- Name string
- Name of the resource.
- PartnerTopic stringReadiness State 
- The readiness state of the corresponding partner topic.
- ProvisioningState string
- Provisioning state of the event channel.
- SystemData Pulumi.Azure Native. Event Grid. Outputs. System Data Response 
- The system metadata relating to Event Channel resource.
- Type string
- Type of the resource.
- Destination
Pulumi.Azure Native. Event Grid. Outputs. Event Channel Destination Response 
- Represents the destination of an event channel.
- ExpirationTime stringIf Not Activated Utc 
- Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.
- Filter
Pulumi.Azure Native. Event Grid. Outputs. Event Channel Filter Response 
- Information about the filter for the event channel.
- PartnerTopic stringFriendly Description 
- Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
- Source
Pulumi.Azure Native. Event Grid. Outputs. Event Channel Source Response 
- Source of the event channel. This represents a unique resource in the partner's resource model.
- Id string
- Fully qualified identifier of the resource.
- Name string
- Name of the resource.
- PartnerTopic stringReadiness State 
- The readiness state of the corresponding partner topic.
- ProvisioningState string
- Provisioning state of the event channel.
- SystemData SystemData Response 
- The system metadata relating to Event Channel resource.
- Type string
- Type of the resource.
- Destination
EventChannel Destination Response 
- Represents the destination of an event channel.
- ExpirationTime stringIf Not Activated Utc 
- Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.
- Filter
EventChannel Filter Response 
- Information about the filter for the event channel.
- PartnerTopic stringFriendly Description 
- Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
- Source
EventChannel Source Response 
- Source of the event channel. This represents a unique resource in the partner's resource model.
- id String
- Fully qualified identifier of the resource.
- name String
- Name of the resource.
- partnerTopic StringReadiness State 
- The readiness state of the corresponding partner topic.
- provisioningState String
- Provisioning state of the event channel.
- systemData SystemData Response 
- The system metadata relating to Event Channel resource.
- type String
- Type of the resource.
- destination
EventChannel Destination Response 
- Represents the destination of an event channel.
- expirationTime StringIf Not Activated Utc 
- Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.
- filter
EventChannel Filter Response 
- Information about the filter for the event channel.
- partnerTopic StringFriendly Description 
- Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
- source
EventChannel Source Response 
- Source of the event channel. This represents a unique resource in the partner's resource model.
- id string
- Fully qualified identifier of the resource.
- name string
- Name of the resource.
- partnerTopic stringReadiness State 
- The readiness state of the corresponding partner topic.
- provisioningState string
- Provisioning state of the event channel.
- systemData SystemData Response 
- The system metadata relating to Event Channel resource.
- type string
- Type of the resource.
- destination
EventChannel Destination Response 
- Represents the destination of an event channel.
- expirationTime stringIf Not Activated Utc 
- Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.
- filter
EventChannel Filter Response 
- Information about the filter for the event channel.
- partnerTopic stringFriendly Description 
- Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
- source
EventChannel Source Response 
- Source of the event channel. This represents a unique resource in the partner's resource model.
- id str
- Fully qualified identifier of the resource.
- name str
- Name of the resource.
- partner_topic_ strreadiness_ state 
- The readiness state of the corresponding partner topic.
- provisioning_state str
- Provisioning state of the event channel.
- system_data SystemData Response 
- The system metadata relating to Event Channel resource.
- type str
- Type of the resource.
- destination
EventChannel Destination Response 
- Represents the destination of an event channel.
- expiration_time_ strif_ not_ activated_ utc 
- Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.
- filter
EventChannel Filter Response 
- Information about the filter for the event channel.
- partner_topic_ strfriendly_ description 
- Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
- source
EventChannel Source Response 
- Source of the event channel. This represents a unique resource in the partner's resource model.
- id String
- Fully qualified identifier of the resource.
- name String
- Name of the resource.
- partnerTopic StringReadiness State 
- The readiness state of the corresponding partner topic.
- provisioningState String
- Provisioning state of the event channel.
- systemData Property Map
- The system metadata relating to Event Channel resource.
- type String
- Type of the resource.
- destination Property Map
- Represents the destination of an event channel.
- expirationTime StringIf Not Activated Utc 
- Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, the event channel and corresponding partner topic are deleted.
- filter Property Map
- Information about the filter for the event channel.
- partnerTopic StringFriendly Description 
- Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
- source Property Map
- Source of the event channel. This represents a unique resource in the partner's resource model.
Supporting Types
BoolEqualsAdvancedFilterResponse    
EventChannelDestinationResponse   
- AzureSubscription stringId 
- Azure subscription ID of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.
- PartnerTopic stringName 
- Name of the partner topic associated with the event channel.
- ResourceGroup string
- Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.
- AzureSubscription stringId 
- Azure subscription ID of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.
- PartnerTopic stringName 
- Name of the partner topic associated with the event channel.
- ResourceGroup string
- Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.
- azureSubscription StringId 
- Azure subscription ID of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.
- partnerTopic StringName 
- Name of the partner topic associated with the event channel.
- resourceGroup String
- Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.
- azureSubscription stringId 
- Azure subscription ID of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.
- partnerTopic stringName 
- Name of the partner topic associated with the event channel.
- resourceGroup string
- Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.
- azure_subscription_ strid 
- Azure subscription ID of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.
- partner_topic_ strname 
- Name of the partner topic associated with the event channel.
- resource_group str
- Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.
- azureSubscription StringId 
- Azure subscription ID of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.
- partnerTopic StringName 
- Name of the partner topic associated with the event channel.
- resourceGroup String
- Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.
EventChannelFilterResponse   
- AdvancedFilters List<object>
- An array of advanced filters that are used for filtering event channels.
- EnableAdvanced boolFiltering On Arrays 
- Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.
- AdvancedFilters []interface{}
- An array of advanced filters that are used for filtering event channels.
- EnableAdvanced boolFiltering On Arrays 
- Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.
- advancedFilters List<Object>
- An array of advanced filters that are used for filtering event channels.
- enableAdvanced BooleanFiltering On Arrays 
- Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.
- advancedFilters (BoolEquals Advanced Filter Response | Is Not Null Advanced Filter Response | Is Null Or Undefined Advanced Filter Response | Number Greater Than Advanced Filter Response | Number Greater Than Or Equals Advanced Filter Response | Number In Advanced Filter Response | Number In Range Advanced Filter Response | Number Less Than Advanced Filter Response | Number Less Than Or Equals Advanced Filter Response | Number Not In Advanced Filter Response | Number Not In Range Advanced Filter Response | String Begins With Advanced Filter Response | String Contains Advanced Filter Response | String Ends With Advanced Filter Response | String In Advanced Filter Response | String Not Begins With Advanced Filter Response | String Not Contains Advanced Filter Response | String Not Ends With Advanced Filter Response | String Not In Advanced Filter Response)[] 
- An array of advanced filters that are used for filtering event channels.
- enableAdvanced booleanFiltering On Arrays 
- Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.
- advanced_filters Sequence[Union[BoolEquals Advanced Filter Response, Is Not Null Advanced Filter Response, Is Null Or Undefined Advanced Filter Response, Number Greater Than Advanced Filter Response, Number Greater Than Or Equals Advanced Filter Response, Number In Advanced Filter Response, Number In Range Advanced Filter Response, Number Less Than Advanced Filter Response, Number Less Than Or Equals Advanced Filter Response, Number Not In Advanced Filter Response, Number Not In Range Advanced Filter Response, String Begins With Advanced Filter Response, String Contains Advanced Filter Response, String Ends With Advanced Filter Response, String In Advanced Filter Response, String Not Begins With Advanced Filter Response, String Not Contains Advanced Filter Response, String Not Ends With Advanced Filter Response, String Not In Advanced Filter Response]] 
- An array of advanced filters that are used for filtering event channels.
- enable_advanced_ boolfiltering_ on_ arrays 
- Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.
- advancedFilters List<Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map>
- An array of advanced filters that are used for filtering event channels.
- enableAdvanced BooleanFiltering On Arrays 
- Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.
EventChannelSourceResponse   
- Source string
- The identifier of the resource that's the source of the events. This represents a unique resource in the partner's resource model.
- Source string
- The identifier of the resource that's the source of the events. This represents a unique resource in the partner's resource model.
- source String
- The identifier of the resource that's the source of the events. This represents a unique resource in the partner's resource model.
- source string
- The identifier of the resource that's the source of the events. This represents a unique resource in the partner's resource model.
- source str
- The identifier of the resource that's the source of the events. This represents a unique resource in the partner's resource model.
- source String
- The identifier of the resource that's the source of the events. This represents a unique resource in the partner's resource model.
IsNotNullAdvancedFilterResponse     
- Key string
- The field/property in the event based on which you want to filter.
- Key string
- The field/property in the event based on which you want to filter.
- key String
- The field/property in the event based on which you want to filter.
- key string
- The field/property in the event based on which you want to filter.
- key str
- The field/property in the event based on which you want to filter.
- key String
- The field/property in the event based on which you want to filter.
IsNullOrUndefinedAdvancedFilterResponse      
- Key string
- The field/property in the event based on which you want to filter.
- Key string
- The field/property in the event based on which you want to filter.
- key String
- The field/property in the event based on which you want to filter.
- key string
- The field/property in the event based on which you want to filter.
- key str
- The field/property in the event based on which you want to filter.
- key String
- The field/property in the event based on which you want to filter.
NumberGreaterThanAdvancedFilterResponse     
NumberGreaterThanOrEqualsAdvancedFilterResponse       
NumberInAdvancedFilterResponse    
NumberInRangeAdvancedFilterResponse     
NumberLessThanAdvancedFilterResponse     
NumberLessThanOrEqualsAdvancedFilterResponse       
NumberNotInAdvancedFilterResponse     
NumberNotInRangeAdvancedFilterResponse      
StringBeginsWithAdvancedFilterResponse     
StringContainsAdvancedFilterResponse    
StringEndsWithAdvancedFilterResponse     
StringInAdvancedFilterResponse    
StringNotBeginsWithAdvancedFilterResponse      
StringNotContainsAdvancedFilterResponse     
StringNotEndsWithAdvancedFilterResponse      
StringNotInAdvancedFilterResponse     
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi