Share via

Microsoft.EventGrid partnerNamespaces 2022-06-15

  • Article

Bicep resource definition

The partnerNamespaces 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces@2022-06-15' = {
  location: 'string'
  name: 'string'
  properties: {
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    partnerRegistrationFullyQualifiedId: 'string'
    partnerTopicRoutingMode: 'string'
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

InboundIpRule

Name Description Value
action Action to perform based on the match or no match of the IpMask. 'Allow'
ipMask IP Address in CIDR notation e.g., 10.0.0.0/8. string

Microsoft.EventGrid/partnerNamespaces

Name Description Value
location Location of the resource. string (required)
name The resource name string (required)
properties Properties of the Partner Namespace. PartnerNamespaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

PartnerNamespaceProperties

Name Description Value
disableLocalAuth This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. bool
inboundIpRules This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. InboundIpRule[]
partnerRegistrationFullyQualifiedId The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.		 string
partnerTopicRoutingMode This determines if events published to this partner namespace should use the source attribute in the event payload
or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.		 'ChannelNameHeader'
'SourceEventAttribute'
publicNetworkAccess This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />		 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

ARM template resource definition

The partnerNamespaces 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.EventGrid/partnerNamespaces",
  "apiVersion": "2022-06-15",
  "name": "string",
  "location": "string",
  "properties": {
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "partnerRegistrationFullyQualifiedId": "string",
    "partnerTopicRoutingMode": "string",
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

InboundIpRule

Name Description Value
action Action to perform based on the match or no match of the IpMask. 'Allow'
ipMask IP Address in CIDR notation e.g., 10.0.0.0/8. string

Microsoft.EventGrid/partnerNamespaces

Name Description Value
apiVersion The api version '2022-06-15'
location Location of the resource. string (required)
name The resource name string (required)
properties Properties of the Partner Namespace. PartnerNamespaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.EventGrid/partnerNamespaces'

PartnerNamespaceProperties

Name Description Value
disableLocalAuth This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. bool
inboundIpRules This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. InboundIpRule[]
partnerRegistrationFullyQualifiedId The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.		 string
partnerTopicRoutingMode This determines if events published to this partner namespace should use the source attribute in the event payload
or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.		 'ChannelNameHeader'
'SourceEventAttribute'
publicNetworkAccess This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />		 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The partnerNamespaces 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces@2022-06-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      partnerRegistrationFullyQualifiedId = "string"
      partnerTopicRoutingMode = "string"
      publicNetworkAccess = "string"
    }
  })
}

Property Values

InboundIpRule

Name Description Value
action Action to perform based on the match or no match of the IpMask. 'Allow'
ipMask IP Address in CIDR notation e.g., 10.0.0.0/8. string

Microsoft.EventGrid/partnerNamespaces

Name Description Value
location Location of the resource. string (required)
name The resource name string (required)
properties Properties of the Partner Namespace. PartnerNamespaceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.EventGrid/partnerNamespaces@2022-06-15"

PartnerNamespaceProperties

Name Description Value
disableLocalAuth This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. bool
inboundIpRules This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. InboundIpRule[]
partnerRegistrationFullyQualifiedId The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.		 string
partnerTopicRoutingMode This determines if events published to this partner namespace should use the source attribute in the event payload
or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.		 'ChannelNameHeader'
'SourceEventAttribute'
publicNetworkAccess This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />		 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value