Microsoft.EventGrid partnerNamespaces/eventChannels 2020-04-01-preview

  • Article

Bicep resource definition

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

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@2020-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    destination: {
      azureSubscriptionId: 'string'
      partnerTopicName: 'string'
      resourceGroup: 'string'
    }
    expirationTimeIfNotActivatedUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
    }
    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 NumberGreaterThan, use:

  operatorType: 'NumberGreaterThan'
  value: int

For NumberGreaterThanOrEquals, use:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

For NumberIn, use:

  operatorType: 'NumberIn'
  values: [
    int
  ]

For NumberLessThan, use:

  operatorType: 'NumberLessThan'
  value: int

For NumberLessThanOrEquals, use:

  operatorType: 'NumberLessThanOrEquals'
  value: int

For NumberNotIn, use:

  operatorType: 'NumberNotIn'
  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 StringNotIn, use:

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

Property values

partnerNamespaces/eventChannels

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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.		 Symbolic name for resource of type: partnerNamespaces
properties Properties of the EventChannel. EventChannelProperties

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

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[]

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
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberIn' (required)
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' (required)
value The filter value. int

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberNotIn' (required)
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' (required)
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' (required)
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' (required)
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' (required)
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' (required)
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

ARM template resource definition

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

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 JSON to your template.

{
  "type": "Microsoft.EventGrid/partnerNamespaces/eventChannels",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "properties": {
    "destination": {
      "azureSubscriptionId": "string",
      "partnerTopicName": "string",
      "resourceGroup": "string"
    },
    "expirationTimeIfNotActivatedUtc": "string",
    "filter": {
      "advancedFilters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see AdvancedFilter objects
        }
      ]
    },
    "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 NumberGreaterThan, use:

  "operatorType": "NumberGreaterThan",
  "value": "int"

For NumberGreaterThanOrEquals, use:

  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"

For NumberIn, use:

  "operatorType": "NumberIn",
  "values": [ "int" ]

For NumberLessThan, use:

  "operatorType": "NumberLessThan",
  "value": "int"

For NumberLessThanOrEquals, use:

  "operatorType": "NumberLessThanOrEquals",
  "value": "int"

For NumberNotIn, use:

  "operatorType": "NumberNotIn",
  "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 StringNotIn, use:

  "operatorType": "StringNotIn",
  "values": [ "string" ]

Property values

partnerNamespaces/eventChannels

Name Description Value
type The resource type 'Microsoft.EventGrid/partnerNamespaces/eventChannels'
apiVersion The resource api version '2020-04-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties of the EventChannel. EventChannelProperties

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

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[]

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
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberIn' (required)
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' (required)
value The filter value. int

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. 'NumberNotIn' (required)
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' (required)
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' (required)
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' (required)
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' (required)
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' (required)
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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/eventChannels@2020-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      destination = {
        azureSubscriptionId = "string"
        partnerTopicName = "string"
        resourceGroup = "string"
      }
      expirationTimeIfNotActivatedUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
      }
      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 NumberGreaterThan, use:

  operatorType = "NumberGreaterThan"
  value = int

For NumberGreaterThanOrEquals, use:

  operatorType = "NumberGreaterThanOrEquals"
  value = int

For NumberIn, use:

  operatorType = "NumberIn"
  values = [
    int
  ]

For NumberLessThan, use:

  operatorType = "NumberLessThan"
  value = int

For NumberLessThanOrEquals, use:

  operatorType = "NumberLessThanOrEquals"
  value = int

For NumberNotIn, use:

  operatorType = "NumberNotIn"
  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 StringNotIn, use:

  operatorType = "StringNotIn"
  values = [
    "string"
  ]

Property values

partnerNamespaces/eventChannels

Name Description Value
type The resource type "Microsoft.EventGrid/partnerNamespaces/eventChannels@2020-04-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: partnerNamespaces
properties Properties of the EventChannel. EventChannelProperties

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

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[]

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
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. "NumberIn" (required)
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" (required)
value The filter value. int

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

Name Description Value
operatorType The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. "NumberNotIn" (required)
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" (required)
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" (required)
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" (required)
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" (required)
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" (required)
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