Dela via


Microsoft.EventGrid-ämnen 2022-06-15

Bicep-resursdefinition

Resurstypen ämnen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/topics-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.EventGrid/topics@2022-06-15' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    dataResidencyBoundary: 'string'
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

InputSchemaMapping-objekt

Ange egenskapen inputSchemaMappingType för att ange typ av objekt.

För Jsonanvänder du:

{
  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'
    }
  }
}

Egenskapsvärden

IdentityInfo

Namn Beskrivning Värde
principalId Huvud-ID för resursidentitet. sträng
tenantId Resursens klientorganisations-ID. sträng
typ Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter. "Ingen"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:t i formuläret:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Den här egenskapen används för närvarande inte och är reserverad för framtida användning.
IdentityInfoUserAssignedIdentiteter

IdentityInfoUserAssignedIdentiteter

Namn Beskrivning Värde

InkommandeIpRule

Namn Beskrivning Värde
handling Åtgärd som ska utföras baserat på matchningen eller ingen matchning av IpMask. "Tillåt"
ipMask IP-adress i CIDR-notation, t.ex. 10.0.0.0/8. sträng

InputSchemaMapping

Namn Beskrivning Värde
inputSchemaMappingType Ange till Json för typen JsonInputSchemaMapping. "Json" (krävs)

JsonField

Namn Beskrivning Värde
sourceField Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonFieldWithDefault

Namn Beskrivning Värde
defaultValue Standardvärdet som ska användas för mappning när ett SourceField inte har angetts eller om det inte finns någon egenskap med det angivna namnet i den publicerade JSON-händelsenyttolasten. sträng
sourceField Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonInputSchemaMapping

Namn Beskrivning Värde
inputSchemaMappingType Typ av anpassad mappning "Json" (krävs)
Egenskaper JSON-egenskaper för indataschemamappningen JsonInputSchemaMappingEgenskaper

JsonInputSchemaMappingEgenskaper

Namn Beskrivning Värde
dataVersion Mappningsinformationen för dataversionsegenskapen för Event Grid-händelsen. JsonFieldWithDefault
eventTime Mappningsinformationen för eventtime-egenskapen för Event Grid-händelsen. JsonField
eventType Mappningsinformationen för eventtype-egenskapen för Event Grid-händelsen. JsonFieldWithDefault
Id Mappningsinformationen för ID-egenskapen för Event Grid-händelsen. JsonField
subjekt Mappningsinformationen för egenskapen Subject för Event Grid-händelsen. JsonFieldWithDefault
ämne Mappningsinformationen för egenskapen Topic för Event Grid-händelsen. JsonField

Microsoft.EventGrid/topics

Namn Beskrivning Värde
identitet Identitetsinformation för resursen. IdentityInfo
plats Resursens plats. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för ämnet. TopicProperties
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

TopicProperties

Namn Beskrivning Värde
dataResidencyBoundary Dataplaceringsgräns för resursen. "WithinGeopair"
"Inomregion"
disableLocalAuth Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet. Bool
inkommandeIpRules Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat. InboundIpRule[]
inputSchema Detta avgör det format som Event Grid bör förvänta sig för inkommande händelser som publicerats i ämnet. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Detta möjliggör publicering med hjälp av anpassade händelsescheman. En InputSchemaMapping kan anges för att mappa olika egenskaper för ett källschema till olika obligatoriska egenskaper för EventGridEvent-schemat. InputSchemaMapping
publicNetworkAccess Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad.
Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />
"Inaktiverad"
"Aktiverad"

TrackedResourceTags

Namn Beskrivning Värde

UserIdentityProperties

Namn Beskrivning Värde
clientId Klient-ID för användartilldelad identitet. sträng
principalId Huvud-ID för användartilldelad identitet. sträng

Användningsexempel

Azure-verifierade moduler

Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.

Modul Beskrivning
Event Grid-ämne AVM-resursmodul för Event Grid-ämne

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil Beskrivning
Skapa anpassad Azure Event Grid-ämne och köprenumeration Skapar ett anpassat Azure Event Grid-ämne och en service bus-köprenumeration. Mall ursprungligen författad av Markus Meyer.
Skapa anpassat ämne och prenumerationsavsnitt för Azure Event Grid Skapar ett anpassat Azure Event Grid-ämne och en webhook-prenumeration. Mall som ursprungligen skapades av John Downs.

Resursdefinition för ARM-mall

Resurstypen ämnen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/topics-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2022-06-15",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "dataResidencyBoundary": "string",
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

InputSchemaMapping-objekt

Ange egenskapen inputSchemaMappingType för att ange typ av objekt.

För Jsonanvänder du:

{
  "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"
    }
  }
}

Egenskapsvärden

IdentityInfo

Namn Beskrivning Värde
principalId Huvud-ID för resursidentitet. sträng
tenantId Resursens klientorganisations-ID. sträng
typ Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter. "Ingen"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:t i formuläret:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Den här egenskapen används för närvarande inte och är reserverad för framtida användning.
IdentityInfoUserAssignedIdentiteter

IdentityInfoUserAssignedIdentiteter

Namn Beskrivning Värde

InkommandeIpRule

Namn Beskrivning Värde
handling Åtgärd som ska utföras baserat på matchningen eller ingen matchning av IpMask. "Tillåt"
ipMask IP-adress i CIDR-notation, t.ex. 10.0.0.0/8. sträng

InputSchemaMapping

Namn Beskrivning Värde
inputSchemaMappingType Ange till Json för typen JsonInputSchemaMapping. "Json" (krävs)

JsonField

Namn Beskrivning Värde
sourceField Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonFieldWithDefault

Namn Beskrivning Värde
defaultValue Standardvärdet som ska användas för mappning när ett SourceField inte har angetts eller om det inte finns någon egenskap med det angivna namnet i den publicerade JSON-händelsenyttolasten. sträng
sourceField Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonInputSchemaMapping

Namn Beskrivning Värde
inputSchemaMappingType Typ av anpassad mappning "Json" (krävs)
Egenskaper JSON-egenskaper för indataschemamappningen JsonInputSchemaMappingEgenskaper

JsonInputSchemaMappingEgenskaper

Namn Beskrivning Värde
dataVersion Mappningsinformationen för dataversionsegenskapen för Event Grid-händelsen. JsonFieldWithDefault
eventTime Mappningsinformationen för eventtime-egenskapen för Event Grid-händelsen. JsonField
eventType Mappningsinformationen för eventtype-egenskapen för Event Grid-händelsen. JsonFieldWithDefault
Id Mappningsinformationen för ID-egenskapen för Event Grid-händelsen. JsonField
subjekt Mappningsinformationen för egenskapen Subject för Event Grid-händelsen. JsonFieldWithDefault
ämne Mappningsinformationen för egenskapen Topic för Event Grid-händelsen. JsonField

Microsoft.EventGrid/topics

Namn Beskrivning Värde
apiVersion API-versionen '2022-06-15'
identitet Identitetsinformation för resursen. IdentityInfo
plats Resursens plats. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för ämnet. TopicProperties
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.EventGrid/topics"

TopicProperties

Namn Beskrivning Värde
dataResidencyBoundary Dataplaceringsgräns för resursen. "WithinGeopair"
"Inomregion"
disableLocalAuth Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet. Bool
inkommandeIpRules Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat. InboundIpRule[]
inputSchema Detta avgör det format som Event Grid bör förvänta sig för inkommande händelser som publicerats i ämnet. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Detta möjliggör publicering med hjälp av anpassade händelsescheman. En InputSchemaMapping kan anges för att mappa olika egenskaper för ett källschema till olika obligatoriska egenskaper för EventGridEvent-schemat. InputSchemaMapping
publicNetworkAccess Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad.
Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />
"Inaktiverad"
"Aktiverad"

TrackedResourceTags

Namn Beskrivning Värde

UserIdentityProperties

Namn Beskrivning Värde
clientId Klient-ID för användartilldelad identitet. sträng
principalId Huvud-ID för användartilldelad identitet. sträng

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall Beskrivning
Skapa anpassad Azure Event Grid-ämne och köprenumeration

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en service bus-köprenumeration. Mall ursprungligen författad av Markus Meyer.
Skapa anpassat ämne och prenumerationsavsnitt för Azure Event Grid

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en webhook-prenumeration. Mall som ursprungligen skapades av John Downs.
Skapa en anpassad prenumeration på Azure Event Grid

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en service bus-ämnesprenumeration. Mall ursprungligen författad av Markus Meyer.
Skapa anpassat Event Grid-ämne och händelsehubbhanterare

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en händelsehubb för att hantera händelserna.
Anpassat Azure Event Grid-ämne/prenumeration med CloudEvents

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne, en webhook-prenumeration med CloudEvents-schema och en logikapp som händelsehanterare. Mall ursprungligen författad av Justin Yoo.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen ämnen kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/topics-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2022-06-15"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      dataResidencyBoundary = "string"
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      publicNetworkAccess = "string"
    }
  })
}

InputSchemaMapping-objekt

Ange egenskapen inputSchemaMappingType för att ange typ av objekt.

För Jsonanvänder du:

{
  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"
    }
  }
}

Egenskapsvärden

IdentityInfo

Namn Beskrivning Värde
principalId Huvud-ID för resursidentitet. sträng
tenantId Resursens klientorganisations-ID. sträng
typ Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter. "Ingen"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:t i formuläret:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Den här egenskapen används för närvarande inte och är reserverad för framtida användning.
IdentityInfoUserAssignedIdentiteter

IdentityInfoUserAssignedIdentiteter

Namn Beskrivning Värde

InkommandeIpRule

Namn Beskrivning Värde
handling Åtgärd som ska utföras baserat på matchningen eller ingen matchning av IpMask. "Tillåt"
ipMask IP-adress i CIDR-notation, t.ex. 10.0.0.0/8. sträng

InputSchemaMapping

Namn Beskrivning Värde
inputSchemaMappingType Ange till Json för typen JsonInputSchemaMapping. "Json" (krävs)

JsonField

Namn Beskrivning Värde
sourceField Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonFieldWithDefault

Namn Beskrivning Värde
defaultValue Standardvärdet som ska användas för mappning när ett SourceField inte har angetts eller om det inte finns någon egenskap med det angivna namnet i den publicerade JSON-händelsenyttolasten. sträng
sourceField Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonInputSchemaMapping

Namn Beskrivning Värde
inputSchemaMappingType Typ av anpassad mappning "Json" (krävs)
Egenskaper JSON-egenskaper för indataschemamappningen JsonInputSchemaMappingEgenskaper

JsonInputSchemaMappingEgenskaper

Namn Beskrivning Värde
dataVersion Mappningsinformationen för dataversionsegenskapen för Event Grid-händelsen. JsonFieldWithDefault
eventTime Mappningsinformationen för eventtime-egenskapen för Event Grid-händelsen. JsonField
eventType Mappningsinformationen för eventtype-egenskapen för Event Grid-händelsen. JsonFieldWithDefault
Id Mappningsinformationen för ID-egenskapen för Event Grid-händelsen. JsonField
subjekt Mappningsinformationen för egenskapen Subject för Event Grid-händelsen. JsonFieldWithDefault
ämne Mappningsinformationen för egenskapen Topic för Event Grid-händelsen. JsonField

Microsoft.EventGrid/topics

Namn Beskrivning Värde
identitet Identitetsinformation för resursen. IdentityInfo
plats Resursens plats. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för ämnet. TopicProperties
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.EventGrid/topics@2022-06-15"

TopicProperties

Namn Beskrivning Värde
dataResidencyBoundary Dataplaceringsgräns för resursen. "WithinGeopair"
"Inomregion"
disableLocalAuth Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet. Bool
inkommandeIpRules Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat. InboundIpRule[]
inputSchema Detta avgör det format som Event Grid bör förvänta sig för inkommande händelser som publicerats i ämnet. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Detta möjliggör publicering med hjälp av anpassade händelsescheman. En InputSchemaMapping kan anges för att mappa olika egenskaper för ett källschema till olika obligatoriska egenskaper för EventGridEvent-schemat. InputSchemaMapping
publicNetworkAccess Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad.
Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />
"Inaktiverad"
"Aktiverad"

TrackedResourceTags

Namn Beskrivning Värde

UserIdentityProperties

Namn Beskrivning Värde
clientId Klient-ID för användartilldelad identitet. sträng
principalId Huvud-ID för användartilldelad identitet. sträng