Share via

Microsoft.EventGrid partnerRegistrations 2020-04-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.EventGrid/partnerRegistrations@2020-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    authorizedAzureSubscriptionIds: [
      'string'
    ]
    customerServiceUri: 'string'
    logoUri: 'string'
    longDescription: 'string'
    partnerCustomerServiceExtension: 'string'
    partnerCustomerServiceNumber: 'string'
    partnerName: 'string'
    partnerResourceTypeDescription: 'string'
    partnerResourceTypeDisplayName: 'string'
    partnerResourceTypeName: 'string'
    setupUri: 'string'
    visibilityState: 'string'
  }
}

Property values

partnerRegistrations

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 registration. PartnerRegistrationProperties

PartnerRegistrationProperties

Name Description Value
authorizedAzureSubscriptionIds List of Azure subscription Ids that are authorized to create a partner namespace
associated with this partner registration. This is an optional property. Creating
partner namespaces is always permitted under the same Azure subscription as the one used
for creating the partner registration.		 string[]
customerServiceUri The extension of the customer service URI of the publisher. string
logoUri URI of the logo. string
longDescription Long description for the custom scenarios and integration to be displayed in the portal if needed.
Length of this description should not exceed 2048 characters.		 string
partnerCustomerServiceExtension The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10. string
partnerCustomerServiceNumber The customer service number of the publisher. The expected phone format should start with a '+' sign
followed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its
length cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and
+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43		 string
partnerName Official name of the partner name. For example: "Contoso". string
partnerResourceTypeDescription Short description of the partner resource type. The length of this description should not exceed 256 characters. string
partnerResourceTypeDisplayName Display name of the partner resource type. string
partnerResourceTypeName Name of the partner resource type. string
setupUri URI of the partner website that can be used by Azure customers to setup Event Grid
integration on an event source.		 string
visibilityState Visibility state of the partner registration. 'GenerallyAvailable'
'Hidden'
'PublicPreview'

ARM template resource definition

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

{
  "type": "Microsoft.EventGrid/partnerRegistrations",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "authorizedAzureSubscriptionIds": [ "string" ],
    "customerServiceUri": "string",
    "logoUri": "string",
    "longDescription": "string",
    "partnerCustomerServiceExtension": "string",
    "partnerCustomerServiceNumber": "string",
    "partnerName": "string",
    "partnerResourceTypeDescription": "string",
    "partnerResourceTypeDisplayName": "string",
    "partnerResourceTypeName": "string",
    "setupUri": "string",
    "visibilityState": "string"
  }
}

Property values

partnerRegistrations

Name Description Value
type The resource type 'Microsoft.EventGrid/partnerRegistrations'
apiVersion The resource api version '2020-04-01-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 registration. PartnerRegistrationProperties

PartnerRegistrationProperties

Name Description Value
authorizedAzureSubscriptionIds List of Azure subscription Ids that are authorized to create a partner namespace
associated with this partner registration. This is an optional property. Creating
partner namespaces is always permitted under the same Azure subscription as the one used
for creating the partner registration.		 string[]
customerServiceUri The extension of the customer service URI of the publisher. string
logoUri URI of the logo. string
longDescription Long description for the custom scenarios and integration to be displayed in the portal if needed.
Length of this description should not exceed 2048 characters.		 string
partnerCustomerServiceExtension The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10. string
partnerCustomerServiceNumber The customer service number of the publisher. The expected phone format should start with a '+' sign
followed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its
length cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and
+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43		 string
partnerName Official name of the partner name. For example: "Contoso". string
partnerResourceTypeDescription Short description of the partner resource type. The length of this description should not exceed 256 characters. string
partnerResourceTypeDisplayName Display name of the partner resource type. string
partnerResourceTypeName Name of the partner resource type. string
setupUri URI of the partner website that can be used by Azure customers to setup Event Grid
integration on an event source.		 string
visibilityState Visibility state of the partner registration. 'GenerallyAvailable'
'Hidden'
'PublicPreview'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerRegistrations@2020-04-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      authorizedAzureSubscriptionIds = [
        "string"
      ]
      customerServiceUri = "string"
      logoUri = "string"
      longDescription = "string"
      partnerCustomerServiceExtension = "string"
      partnerCustomerServiceNumber = "string"
      partnerName = "string"
      partnerResourceTypeDescription = "string"
      partnerResourceTypeDisplayName = "string"
      partnerResourceTypeName = "string"
      setupUri = "string"
      visibilityState = "string"
    }
  })
}

Property values

partnerRegistrations

Name Description Value
type The resource type "Microsoft.EventGrid/partnerRegistrations@2020-04-01-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 registration. PartnerRegistrationProperties

PartnerRegistrationProperties

Name Description Value
authorizedAzureSubscriptionIds List of Azure subscription Ids that are authorized to create a partner namespace
associated with this partner registration. This is an optional property. Creating
partner namespaces is always permitted under the same Azure subscription as the one used
for creating the partner registration.		 string[]
customerServiceUri The extension of the customer service URI of the publisher. string
logoUri URI of the logo. string
longDescription Long description for the custom scenarios and integration to be displayed in the portal if needed.
Length of this description should not exceed 2048 characters.		 string
partnerCustomerServiceExtension The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10. string
partnerCustomerServiceNumber The customer service number of the publisher. The expected phone format should start with a '+' sign
followed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its
length cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and
+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43		 string
partnerName Official name of the partner name. For example: "Contoso". string
partnerResourceTypeDescription Short description of the partner resource type. The length of this description should not exceed 256 characters. string
partnerResourceTypeDisplayName Display name of the partner resource type. string
partnerResourceTypeName Name of the partner resource type. string
setupUri URI of the partner website that can be used by Azure customers to setup Event Grid
integration on an event source.		 string
visibilityState Visibility state of the partner registration. "GenerallyAvailable"
"Hidden"
"PublicPreview"