你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.EventGrid 域 2020-10-15-preview
Bicep 资源定义
可以使用目标操作部署域资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/domains 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.EventGrid/domains@2020-10-15-preview' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
inboundIpRules: [
{
action: 'string'
ipMask: 'string'
}
]
inputSchema: 'string'
inputSchemaMapping: {
inputSchemaMappingType: 'string'
// For remaining properties, see InputSchemaMapping objects
}
publicNetworkAccess: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
InputSchemaMapping 对象
设置 inputSchemaMappingType 属性以指定对象的类型。
对于 Json,请使用:
{
inputSchemaMappingType: 'Json'
properties: {
dataVersion: {
defaultValue: 'string'
sourceField: 'string'
}
eventTime: {
sourceField: 'string'
}
eventType: {
defaultValue: 'string'
sourceField: 'string'
}
id: {
sourceField: 'string'
}
subject: {
defaultValue: 'string'
sourceField: 'string'
}
topic: {
sourceField: 'string'
}
}
}
属性值
DomainProperties
名字 | 描述 | 价值 |
---|---|---|
inboundIpRules | 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 | InboundIpRule[] |
inputSchema | 这决定了事件网格应期望用于发布到域的传入事件的格式。 | “CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema” |
inputSchemaMapping | 有关 InputSchemaMapping 的信息,其中指定了映射事件有效负载的信息。 | InputSchemaMapping |
publicNetworkAccess | 这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置 <seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules” /> |
“Disabled” “Enabled” |
IdentityInfo
名字 | 描述 | 价值 |
---|---|---|
principalId | 资源标识的主体 ID。 | 字符串 |
tenantId | 资源的租户 ID。 | 字符串 |
类型 | 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID: “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用,并保留以供将来使用。 |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
名字 | 描述 | 价值 |
---|
InboundIpRule
名字 | 描述 | 价值 |
---|---|---|
行动 | 根据匹配项或 IpMask 的匹配项执行的操作。 | “允许” |
ipMask | CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 | 字符串 |
InputSchemaMapping
名字 | 描述 | 价值 |
---|---|---|
inputSchemaMappingType | 对于 JsonInputSchemaMapping,请设置为“Json”。 | “Json”(必需) |
JsonField
名字 | 描述 | 价值 |
---|---|---|
sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonFieldWithDefault
名字 | 描述 | 价值 |
---|---|---|
defaultValue | 如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性,则用于映射的默认值。 | 字符串 |
sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonInputSchemaMapping
名字 | 描述 | 价值 |
---|---|---|
inputSchemaMappingType | 自定义映射的类型 | “Json”(必需) |
性能 | 输入架构映射的 JSON 属性 | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
名字 | 描述 | 价值 |
---|---|---|
dataVersion | 事件网格事件的 DataVersion 属性的映射信息。 | JsonFieldWithDefault |
eventTime | 事件网格事件的 EventTime 属性的映射信息。 | JsonField |
eventType | 事件网格事件的 EventType 属性的映射信息。 | JsonFieldWithDefault |
id | 事件网格事件的 Id 属性的映射信息。 | JsonField |
主题 | 事件网格事件的 Subject 属性的映射信息。 | JsonFieldWithDefault |
主题 | 事件网格事件的 Topic 属性的映射信息。 | JsonField |
Microsoft.EventGrid/domains
名字 | 描述 | 价值 |
---|---|---|
身份 | 资源的标识信息。 | IdentityInfo |
位置 | 资源的位置。 | string (必需) |
名字 | 资源名称 | string (必需) |
性能 | 域的属性。 | DomainProperties |
sku | 域的 SKU 定价层。 | ResourceSku |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
ResourceSku
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源的 SKU 名称。 可能的值包括:基本值或高级值。 | “Basic” “Premium” |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
UserIdentityProperties
名字 | 描述 | 价值 |
---|---|---|
clientId | 用户分配标识的客户端 ID。 | 字符串 |
principalId | 用户分配标识的主体 ID。 | 字符串 |
ARM 模板资源定义
可以使用目标操作部署域资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/domains 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.EventGrid/domains",
"apiVersion": "2020-10-15-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"inboundIpRules": [
{
"action": "string",
"ipMask": "string"
}
],
"inputSchema": "string",
"inputSchemaMapping": {
"inputSchemaMappingType": "string"
// For remaining properties, see InputSchemaMapping objects
},
"publicNetworkAccess": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
InputSchemaMapping 对象
设置 inputSchemaMappingType 属性以指定对象的类型。
对于 Json,请使用:
{
"inputSchemaMappingType": "Json",
"properties": {
"dataVersion": {
"defaultValue": "string",
"sourceField": "string"
},
"eventTime": {
"sourceField": "string"
},
"eventType": {
"defaultValue": "string",
"sourceField": "string"
},
"id": {
"sourceField": "string"
},
"subject": {
"defaultValue": "string",
"sourceField": "string"
},
"topic": {
"sourceField": "string"
}
}
}
属性值
DomainProperties
名字 | 描述 | 价值 |
---|---|---|
inboundIpRules | 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 | InboundIpRule[] |
inputSchema | 这决定了事件网格应期望用于发布到域的传入事件的格式。 | “CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema” |
inputSchemaMapping | 有关 InputSchemaMapping 的信息,其中指定了映射事件有效负载的信息。 | InputSchemaMapping |
publicNetworkAccess | 这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置 <seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules” /> |
“Disabled” “Enabled” |
IdentityInfo
名字 | 描述 | 价值 |
---|---|---|
principalId | 资源标识的主体 ID。 | 字符串 |
tenantId | 资源的租户 ID。 | 字符串 |
类型 | 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID: “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用,并保留以供将来使用。 |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
名字 | 描述 | 价值 |
---|
InboundIpRule
名字 | 描述 | 价值 |
---|---|---|
行动 | 根据匹配项或 IpMask 的匹配项执行的操作。 | “允许” |
ipMask | CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 | 字符串 |
InputSchemaMapping
名字 | 描述 | 价值 |
---|---|---|
inputSchemaMappingType | 对于 JsonInputSchemaMapping,请设置为“Json”。 | “Json”(必需) |
JsonField
名字 | 描述 | 价值 |
---|---|---|
sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonFieldWithDefault
名字 | 描述 | 价值 |
---|---|---|
defaultValue | 如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性,则用于映射的默认值。 | 字符串 |
sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonInputSchemaMapping
名字 | 描述 | 价值 |
---|---|---|
inputSchemaMappingType | 自定义映射的类型 | “Json”(必需) |
性能 | 输入架构映射的 JSON 属性 | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
名字 | 描述 | 价值 |
---|---|---|
dataVersion | 事件网格事件的 DataVersion 属性的映射信息。 | JsonFieldWithDefault |
eventTime | 事件网格事件的 EventTime 属性的映射信息。 | JsonField |
eventType | 事件网格事件的 EventType 属性的映射信息。 | JsonFieldWithDefault |
id | 事件网格事件的 Id 属性的映射信息。 | JsonField |
主题 | 事件网格事件的 Subject 属性的映射信息。 | JsonFieldWithDefault |
主题 | 事件网格事件的 Topic 属性的映射信息。 | JsonField |
Microsoft.EventGrid/domains
名字 | 描述 | 价值 |
---|---|---|
apiVersion | API 版本 | '2020-10-15-preview' |
身份 | 资源的标识信息。 | IdentityInfo |
位置 | 资源的位置。 | string (必需) |
名字 | 资源名称 | string (必需) |
性能 | 域的属性。 | DomainProperties |
sku | 域的 SKU 定价层。 | ResourceSku |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
类型 | 资源类型 | “Microsoft.EventGrid/domains” |
ResourceSku
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源的 SKU 名称。 可能的值包括:基本值或高级值。 | “Basic” “Premium” |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
UserIdentityProperties
名字 | 描述 | 价值 |
---|---|---|
clientId | 用户分配标识的客户端 ID。 | 字符串 |
principalId | 用户分配标识的主体 ID。 | 字符串 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署域资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/domains 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/domains@2020-10-15-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
inboundIpRules = [
{
action = "string"
ipMask = "string"
}
]
inputSchema = "string"
inputSchemaMapping = {
inputSchemaMappingType = "string"
// For remaining properties, see InputSchemaMapping objects
}
publicNetworkAccess = "string"
}
})
}
InputSchemaMapping 对象
设置 inputSchemaMappingType 属性以指定对象的类型。
对于 Json,请使用:
{
inputSchemaMappingType = "Json"
properties = {
dataVersion = {
defaultValue = "string"
sourceField = "string"
}
eventTime = {
sourceField = "string"
}
eventType = {
defaultValue = "string"
sourceField = "string"
}
id = {
sourceField = "string"
}
subject = {
defaultValue = "string"
sourceField = "string"
}
topic = {
sourceField = "string"
}
}
}
属性值
DomainProperties
名字 | 描述 | 价值 |
---|---|---|
inboundIpRules | 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 | InboundIpRule[] |
inputSchema | 这决定了事件网格应期望用于发布到域的传入事件的格式。 | “CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema” |
inputSchemaMapping | 有关 InputSchemaMapping 的信息,其中指定了映射事件有效负载的信息。 | InputSchemaMapping |
publicNetworkAccess | 这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置 <seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules” /> |
“Disabled” “Enabled” |
IdentityInfo
名字 | 描述 | 价值 |
---|---|---|
principalId | 资源标识的主体 ID。 | 字符串 |
tenantId | 资源的租户 ID。 | 字符串 |
类型 | 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned” |
userAssignedIdentities | 与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID: “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用,并保留以供将来使用。 |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
名字 | 描述 | 价值 |
---|
InboundIpRule
名字 | 描述 | 价值 |
---|---|---|
行动 | 根据匹配项或 IpMask 的匹配项执行的操作。 | “允许” |
ipMask | CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 | 字符串 |
InputSchemaMapping
名字 | 描述 | 价值 |
---|---|---|
inputSchemaMappingType | 对于 JsonInputSchemaMapping,请设置为“Json”。 | “Json”(必需) |
JsonField
名字 | 描述 | 价值 |
---|---|---|
sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonFieldWithDefault
名字 | 描述 | 价值 |
---|---|---|
defaultValue | 如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性,则用于映射的默认值。 | 字符串 |
sourceField | 要用作映射源的输入事件架构中的字段的名称。 | 字符串 |
JsonInputSchemaMapping
名字 | 描述 | 价值 |
---|---|---|
inputSchemaMappingType | 自定义映射的类型 | “Json”(必需) |
性能 | 输入架构映射的 JSON 属性 | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
名字 | 描述 | 价值 |
---|---|---|
dataVersion | 事件网格事件的 DataVersion 属性的映射信息。 | JsonFieldWithDefault |
eventTime | 事件网格事件的 EventTime 属性的映射信息。 | JsonField |
eventType | 事件网格事件的 EventType 属性的映射信息。 | JsonFieldWithDefault |
id | 事件网格事件的 Id 属性的映射信息。 | JsonField |
主题 | 事件网格事件的 Subject 属性的映射信息。 | JsonFieldWithDefault |
主题 | 事件网格事件的 Topic 属性的映射信息。 | JsonField |
Microsoft.EventGrid/domains
名字 | 描述 | 价值 |
---|---|---|
身份 | 资源的标识信息。 | IdentityInfo |
位置 | 资源的位置。 | string (必需) |
名字 | 资源名称 | string (必需) |
性能 | 域的属性。 | DomainProperties |
sku | 域的 SKU 定价层。 | ResourceSku |
标签 | 资源标记 | 标记名称和值的字典。 |
类型 | 资源类型 | “Microsoft.EventGrid/domains@2020-10-15-preview” |
ResourceSku
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源的 SKU 名称。 可能的值包括:基本值或高级值。 | “Basic” “Premium” |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
UserIdentityProperties
名字 | 描述 | 价值 |
---|---|---|
clientId | 用户分配标识的客户端 ID。 | 字符串 |
principalId | 用户分配标识的主体 ID。 | 字符串 |