Share via

Microsoft.EventGrid partnerConfigurations 2023-12-15-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.EventGrid/partnerConfigurations@2023-12-15-preview' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
  properties: {
    partnerAuthorization: {
      authorizedPartnersList: [
        {
          authorizationExpirationTimeInUtc: 'string'
          partnerName: 'string'
          partnerRegistrationImmutableId: 'string'
        }
      ]
      defaultMaximumExpirationTimeInDays: int
    }
    provisioningState: 'string'
  }
}

Property values

partnerConfigurations

Name Description Value
name The resource name 'default'
location Location of the resource. string
tags Tags of the resource. Dictionary of tag names and values. See Tags in templates
properties Properties of the partner configuration. PartnerConfigurationProperties

PartnerConfigurationProperties

Name Description Value
partnerAuthorization The details of authorized partners. PartnerAuthorization
provisioningState Provisioning state of the partner configuration. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

PartnerAuthorization

Name Description Value
authorizedPartnersList The list of authorized partners. Partner[]
defaultMaximumExpirationTimeInDays Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is
not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.
 int

Partner

Name Description Value
authorizationExpirationTimeInUtc Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's
context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration.
If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.		 string
partnerName The partner name. string
partnerRegistrationImmutableId The immutableId 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}$

ARM template resource definition

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

{
  "type": "Microsoft.EventGrid/partnerConfigurations",
  "apiVersion": "2023-12-15-preview",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string"
  "properties": {
    "partnerAuthorization": {
      "authorizedPartnersList": [
        {
          "authorizationExpirationTimeInUtc": "string",
          "partnerName": "string",
          "partnerRegistrationImmutableId": "string"
        }
      ],
      "defaultMaximumExpirationTimeInDays": "int"
    },
    "provisioningState": "string"
  }
}

Property values

partnerConfigurations

Name Description Value
type The resource type 'Microsoft.EventGrid/partnerConfigurations'
apiVersion The resource api version '2023-12-15-preview'
name The resource name 'default'
location Location of the resource. string
tags Tags of the resource. Dictionary of tag names and values. See Tags in templates
properties Properties of the partner configuration. PartnerConfigurationProperties

PartnerConfigurationProperties

Name Description Value
partnerAuthorization The details of authorized partners. PartnerAuthorization
provisioningState Provisioning state of the partner configuration. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

PartnerAuthorization

Name Description Value
authorizedPartnersList The list of authorized partners. Partner[]
defaultMaximumExpirationTimeInDays Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is
not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.
 int

Partner

Name Description Value
authorizationExpirationTimeInUtc Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's
context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration.
If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.		 string
partnerName The partner name. string
partnerRegistrationImmutableId The immutableId 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}$

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerConfigurations@2023-12-15-preview"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
  body = jsonencode({
    properties = {
      partnerAuthorization = {
        authorizedPartnersList = [
          {
            authorizationExpirationTimeInUtc = "string"
            partnerName = "string"
            partnerRegistrationImmutableId = "string"
          }
        ]
        defaultMaximumExpirationTimeInDays = int
      }
      provisioningState = "string"
    }
  })
}

Property values

partnerConfigurations

Name Description Value
type The resource type "Microsoft.EventGrid/partnerConfigurations@2023-12-15-preview"
name The resource name "default"
location Location of the resource. string
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 configuration. PartnerConfigurationProperties

PartnerConfigurationProperties

Name Description Value
partnerAuthorization The details of authorized partners. PartnerAuthorization
provisioningState Provisioning state of the partner configuration. "Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"

PartnerAuthorization

Name Description Value
authorizedPartnersList The list of authorized partners. Partner[]
defaultMaximumExpirationTimeInDays Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is
not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.
 int

Partner

Name Description Value
authorizationExpirationTimeInUtc Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's
context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration.
If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.		 string
partnerName The partner name. string
partnerRegistrationImmutableId The immutableId 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}$