Share via

Microsoft.EventGrid partnerDestinations

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.EventGrid/partnerDestinations@2024-12-15-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    activationState: 'string'
    endpointBaseUrl: 'string'
    endpointServiceContext: 'string'
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerRegistrationImmutableId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.EventGrid/partnerDestinations

Name Description Value
location Location of the resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties Properties of the Partner Destination. PartnerDestinationProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

PartnerDestinationProperties

Name Description Value
activationState Activation state of the partner destination. 'Activated'
'NeverActivated'
endpointBaseUrl Endpoint Base URL of the partner destination string
endpointServiceContext Endpoint context associated with this partner destination. string
expirationTimeIfNotActivatedUtc Expiration time of the partner destination. If this timer expires and the partner destination was never activated,
the partner destination and corresponding channel are deleted.		 string
messageForActivation Context or helpful message that can be used during the approval process. string
partnerRegistrationImmutableId The immutable Id of the corresponding partner registration. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

TrackedResourceTags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.EventGrid/partnerDestinations",
  "apiVersion": "2024-12-15-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "activationState": "string",
    "endpointBaseUrl": "string",
    "endpointServiceContext": "string",
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerRegistrationImmutableId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.EventGrid/partnerDestinations

Name Description Value
apiVersion The api version '2024-12-15-preview'
location Location of the resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties Properties of the Partner Destination. PartnerDestinationProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.EventGrid/partnerDestinations'

PartnerDestinationProperties

Name Description Value
activationState Activation state of the partner destination. 'Activated'
'NeverActivated'
endpointBaseUrl Endpoint Base URL of the partner destination string
endpointServiceContext Endpoint context associated with this partner destination. string
expirationTimeIfNotActivatedUtc Expiration time of the partner destination. If this timer expires and the partner destination was never activated,
the partner destination and corresponding channel are deleted.		 string
messageForActivation Context or helpful message that can be used during the approval process. string
partnerRegistrationImmutableId The immutable Id of the corresponding partner registration. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerDestinations@2024-12-15-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      activationState = "string"
      endpointBaseUrl = "string"
      endpointServiceContext = "string"
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerRegistrationImmutableId = "string"
    }
  })
}

Property Values

Microsoft.EventGrid/partnerDestinations

Name Description Value
location Location of the resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties Properties of the Partner Destination. PartnerDestinationProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.EventGrid/partnerDestinations@2024-12-15-preview"

PartnerDestinationProperties

Name Description Value
activationState Activation state of the partner destination. 'Activated'
'NeverActivated'
endpointBaseUrl Endpoint Base URL of the partner destination string
endpointServiceContext Endpoint context associated with this partner destination. string
expirationTimeIfNotActivatedUtc Expiration time of the partner destination. If this timer expires and the partner destination was never activated,
the partner destination and corresponding channel are deleted.		 string
messageForActivation Context or helpful message that can be used during the approval process. string
partnerRegistrationImmutableId The immutable Id of the corresponding partner registration. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

TrackedResourceTags

Name Description Value