Share via

Microsoft.EventGrid partnerDestinations 2021-10-15-preview

  • 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@2021-10-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    activationState: 'string'
    endpointBaseUrl: 'string'
    endpointServiceContext: 'string'
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerRegistrationImmutableId: 'string'
    provisioningState: 'string'
  }
}

Property values

partnerDestinations

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

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}$
provisioningState Provisioning state of the partner destination. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

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": "2021-10-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "activationState": "string",
    "endpointBaseUrl": "string",
    "endpointServiceContext": "string",
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerRegistrationImmutableId": "string",
    "provisioningState": "string"
  }
}

Property values

partnerDestinations

Name Description Value
type The resource type 'Microsoft.EventGrid/partnerDestinations'
apiVersion The resource api version '2021-10-15-preview'
name The resource name string (required)
location Location of the resource. string (required)
tags Tags of the resource. Dictionary of tag names and values. See Tags in templates
properties Properties of the Partner Destination. PartnerDestinationProperties

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}$
provisioningState Provisioning state of the partner destination. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

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@2021-10-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      activationState = "string"
      endpointBaseUrl = "string"
      endpointServiceContext = "string"
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerRegistrationImmutableId = "string"
      provisioningState = "string"
    }
  })
}

Property values

partnerDestinations

Name Description Value
type The resource type "Microsoft.EventGrid/partnerDestinations@2021-10-15-preview"
name The resource name string (required)
location Location of the resource. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Tags of the resource. Dictionary of tag names and values.
properties Properties of the Partner Destination. PartnerDestinationProperties

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}$
provisioningState Provisioning state of the partner destination. "Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"