Microsoft.EventGrid partnerNamespaces/eventChannels 2021-10-15-preview

Article
12/09/2024

Bicep resource definition

The partnerNamespaces/eventChannels resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/eventChannels@2021-10-15-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  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

AdvancedFilter

Name	Description	Value
key	The field/property in the event based on which you want to filter.	string
operatorType	Set to 'BoolEquals' for type BoolEqualsAdvancedFilter. Set to 'IsNotNull' for type IsNotNullAdvancedFilter. Set to 'IsNullOrUndefined' for type IsNullOrUndefinedAdvancedFilter. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberInRange' for type NumberInRangeAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Set to 'NumberNotIn' for type NumberNotInAdvancedFilter. Set to 'NumberNotInRange' for type NumberNotInRangeAdvancedFilter. Set to 'StringBeginsWith' for type StringBeginsWithAdvancedFilter. Set to 'StringContains' for type StringContainsAdvancedFilter. Set to 'StringEndsWith' for type StringEndsWithAdvancedFilter. Set to 'StringIn' for type StringInAdvancedFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithAdvancedFilter. Set to 'StringNotContains' for type StringNotContainsAdvancedFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (required)

BoolEqualsAdvancedFilter

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

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

EventChannelProperties

Name	Description	Value
destination	Represents 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	Information about the 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	Source of the event channel. This represents a unique resource in the partner's resource model.	EventChannelSource

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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