你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.EventGrid partnerConfigurations 2024-12-15-preview
Bicep resource definition
The partnerConfigurations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2024-12-15-preview' = {
location: 'string'
name: 'default'
properties: {
partnerAuthorization: {
authorizedPartnersList: [
{
authorizationExpirationTimeInUtc: 'string'
partnerName: 'string'
partnerRegistrationImmutableId: 'string'
}
]
defaultMaximumExpirationTimeInDays: int
}
provisioningState: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.EventGrid/partnerConfigurations
Name | Description | Value |
---|---|---|
location | Location of the resource. | string |
name | The resource name | 'default' (required) |
properties | Properties of the partner configuration. | PartnerConfigurationProperties |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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}$ |
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 |
PartnerConfigurationProperties
Name | Description | Value |
---|---|---|
partnerAuthorization | The details of authorized partners. | PartnerAuthorization |
provisioningState | Provisioning state of the partner configuration. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PartnerConfigurationTags
Name | Description | Value |
---|
ARM template resource definition
The partnerConfigurations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2024-12-15-preview",
"name": "string",
"location": "string",
"properties": {
"partnerAuthorization": {
"authorizedPartnersList": [
{
"authorizationExpirationTimeInUtc": "string",
"partnerName": "string",
"partnerRegistrationImmutableId": "string"
}
],
"defaultMaximumExpirationTimeInDays": "int"
},
"provisioningState": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.EventGrid/partnerConfigurations
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2024-12-15-preview' |
location | Location of the resource. | string |
name | The resource name | 'default' (required) |
properties | Properties of the partner configuration. | PartnerConfigurationProperties |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
type | The resource type | 'Microsoft.EventGrid/partnerConfigurations' |
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}$ |
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 |
PartnerConfigurationProperties
Name | Description | Value |
---|---|---|
partnerAuthorization | The details of authorized partners. | PartnerAuthorization |
provisioningState | Provisioning state of the partner configuration. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PartnerConfigurationTags
Name | Description | Value |
---|
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@2024-12-15-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
partnerAuthorization = {
authorizedPartnersList = [
{
authorizationExpirationTimeInUtc = "string"
partnerName = "string"
partnerRegistrationImmutableId = "string"
}
]
defaultMaximumExpirationTimeInDays = int
}
provisioningState = "string"
}
})
}
Property values
Microsoft.EventGrid/partnerConfigurations
Name | Description | Value |
---|---|---|
location | Location of the resource. | string |
name | The resource name | 'default' (required) |
properties | Properties of the partner configuration. | PartnerConfigurationProperties |
tags | Resource tags | Dictionary of tag names and values. |
type | The resource type | "Microsoft.EventGrid/partnerConfigurations@2024-12-15-preview" |
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}$ |
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 |
PartnerConfigurationProperties
Name | Description | Value |
---|---|---|
partnerAuthorization | The details of authorized partners. | PartnerAuthorization |
provisioningState | Provisioning state of the partner configuration. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PartnerConfigurationTags
Name | Description | Value |
---|