Microsoft.EventGrid partnerNamespaces/eventChannels

The partnerNamespaces/eventChannels resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.EventGrid/partnerNamespaces/eventChannels resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/eventChannels@2021-06-01-preview' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    destination: {
      azureSubscriptionId: 'string'
      partnerTopicName: 'string'
      resourceGroup: 'string'
    }
    expirationTimeIfNotActivatedUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
    }
    partnerTopicFriendlyDescription: 'string'
    source: {
      source: 'string'
    }
  }
}

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

  operatorType: 'BoolEquals'
  value: bool

For IsNotNull, use:

  operatorType: 'IsNotNull'

For IsNullOrUndefined, use:

  operatorType: 'IsNullOrUndefined'

For NumberGreaterThan, use:

  operatorType: 'NumberGreaterThan'
  value: int

For NumberGreaterThanOrEquals, use:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

For NumberIn, use:

  operatorType: 'NumberIn'
  values: [ int ]

For NumberInRange, use:

  operatorType: 'NumberInRange'
  values: [ [ int ] ]

For NumberLessThan, use:

  operatorType: 'NumberLessThan'
  value: int

For NumberLessThanOrEquals, use:

  operatorType: 'NumberLessThanOrEquals'
  value: int

For NumberNotIn, use:

  operatorType: 'NumberNotIn'
  values: [ int ]

For NumberNotInRange, use:

  operatorType: 'NumberNotInRange'
  values: [ [ int ] ]

For StringBeginsWith, use:

  operatorType: 'StringBeginsWith'
  values: [ 'string' ]

For StringContains, use:

  operatorType: 'StringContains'
  values: [ 'string' ]

For StringEndsWith, use:

  operatorType: 'StringEndsWith'
  values: [ 'string' ]

For StringIn, use:

  operatorType: 'StringIn'
  values: [ 'string' ]

For StringNotBeginsWith, use:

  operatorType: 'StringNotBeginsWith'
  values: [ 'string' ]

For StringNotContains, use:

  operatorType: 'StringNotContains'
  values: [ 'string' ]

For StringNotEndsWith, use:

  operatorType: 'StringNotEndsWith'
  values: [ 'string' ]

For StringNotIn, use:

  operatorType: 'StringNotIn'
  values: [ 'string' ]

Property values

partnerNamespaces/eventChannels

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.EventGrid/partnerNamespaces/eventChannels'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-06-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
properties Properties of the Event Channel. EventChannelProperties

EventChannelProperties

Name Description Value
destination Properties of the destination of an event channel. EventChannelDestination
expirationTimeIfNotActivatedUtc 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.
string
filter Filter for the Event Channel. EventChannelFilter
partnerTopicFriendlyDescription 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.
string
source Properties of the source of an event channel. EventChannelSource

EventChannelDestination

Name Description Value
azureSubscriptionId 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.
string
partnerTopicName Name of the partner topic associated with the event channel. string
resourceGroup 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.
string

EventChannelFilter

Name Description Value
advancedFilters An array of advanced filters that are used for filtering event channels. AdvancedFilter[]
enableAdvancedFilteringOnArrays 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. bool

AdvancedFilter

Name Description Value
key The field/property in the event based on which you want to filter. string
operatorType Set the object type BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn

BoolEqualsAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'BoolEquals'
value The boolean filter value. bool

IsNotNullAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'IsNotNull'

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'IsNullOrUndefined'

NumberGreaterThanAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberGreaterThan'
value The filter value. int

NumberGreaterThanOrEqualsAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberGreaterThanOrEquals'
value The filter value. int

NumberInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberIn'
values The set of filter values. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberInRange'
values The set of filter values. int[][]

NumberLessThanAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberLessThan'
value The filter value. int

NumberLessThanOrEqualsAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberLessThanOrEquals'
value The filter value. int

NumberNotInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberNotIn'
values The set of filter values. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberNotInRange'
values The set of filter values. int[][]

StringBeginsWithAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringBeginsWith'
values The set of filter values. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringContains'
values The set of filter values. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringEndsWith'
values The set of filter values. string[]

StringInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringIn'
values The set of filter values. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringNotBeginsWith'
values The set of filter values. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringNotContains'
values The set of filter values. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringNotEndsWith'
values The set of filter values. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'StringNotIn'
values The set of filter values. string[]

EventChannelSource

Name Description Value
source The identifier of the resource that's the source of the events.
This represents a unique resource in the partner's resource model.
string