Share via


Microsoft.EventGrid-domäner 2020-04-01-preview

Bicep-resursdefinition

Domänresurstypen kan distribueras med åtgärder som är mål:

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

Resursformat

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

resource symbolicname 'Microsoft.EventGrid/domains@2020-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
  }
}

InputSchemaMapping-objekt

Ange egenskapen inputSchemaMappingType för att ange objekttypen.

För Json anvä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

Domäner

Name Beskrivning Värde
name Resursnamnet sträng (krävs)

Teckengräns: 3–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck.
location Platsen för resursen. sträng (krävs)
tags Taggar för resursen. Ordlista med taggnamn och värden. Se Taggar i mallar
sku SKU-prisnivån för domänen. ResourceSku
identity Identitetsinformation för resursen. IdentityInfo
properties Egenskaper för domänen. DomainProperties

IdentityInfo

Name Beskrivning Värde
principalId Huvud-ID för resursidentitet. sträng
tenantId Klientorganisations-ID för resursen. 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"
"Användartilldelade"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Referenserna för användaridentitetsordlistenyckeln ä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

Name Beskrivning Värde
{anpassad egenskap} UserIdentityProperties

UserIdentityProperties

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

DomainProperties

Name Beskrivning Värde
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 vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till domänen. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Information om InputSchemaMapping som angav information om nyttolasten för mappningshändelser. InputSchemaMapping
privateEndpointConnections Lista över privata slutpunktsanslutningar. PrivateEndpointConnection[]
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.DomainProperties.InboundIpRules" /}
"Inaktiverad"
"Aktiverad"

InkommandeipRule

Name Beskrivning Värde
åtgärd Åtgärd att utföra 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

Name Beskrivning Värde
inputSchemaMappingType Ange objekttyp Json (krävs)

JsonInputSchemaMapping

Name Beskrivning Värde
inputSchemaMappingType Typ av anpassad mappning "Json" (krävs)
properties JSON-egenskaper för mappningen av indataschemat JsonInputSchemaMappingEgenskaper

JsonInputSchemaMappingEgenskaper

Name Beskrivning Värde
Dataversion Mappningsinformationen för egenskapen DataVersion för Event Grid-händelsen. JsonFieldWithDefault
Händelsetid Mappningsinformationen för EventTime-egenskapen för Event Grid-händelsen. JsonField
Händelsetyp 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
ämne 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

JsonFieldWithDefault

Name Beskrivning Värde
Standardvärde 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 Namn på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonField

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

PrivateEndpointConnection

Name Beskrivning Värde
properties Egenskaper för PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beskrivning Värde
groupIds GroupIds från private link-tjänstresursen. string[]
privateEndpoint Den privata slutpunktsresursen för den här anslutningen. PrivateEndpoint
privateLinkServiceConnectionState Information om anslutningens tillstånd. ConnectionState
provisioningState Etableringstillstånd för den privata slutpunktsanslutningen. "Avbruten"
"Skapar"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"

PrivateEndpoint

Name Beskrivning Värde
id ARM-identifieraren för privat slutpunkt. sträng

ConnectionState

Name Beskrivning Värde
actionsRequired Åtgärder som krävs (om sådana finns). sträng
beskrivning Beskrivning av anslutningstillståndet. sträng
status Status för anslutningen. "Godkänd"
"Frånkopplad"
"Väntar"
"Avvisad"

ResourceSku

Name Beskrivning Värde
name Resursens SKU-namn. Möjliga värden är: Basic eller Premium. "Grundläggande"
"Premium"

Resursdefinition för ARM-mall

Domänernas resurstyp 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/domains-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string"
  }
}

InputSchemaMapping-objekt

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

För Json anvä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

Domäner

Name Beskrivning Värde
typ Resurstypen "Microsoft.EventGrid/domains"
apiVersion Resurs-API-versionen "2020-04-01-preview"
name Resursnamnet sträng (krävs)

Teckengräns: 3–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck.
location Platsen för resursen. sträng (krävs)
tags Taggar för resursen. Ordlista med taggnamn och värden. Se Taggar i mallar
sku Sku-prisnivån för domänen. ResourceSku
identity Identitetsinformation för resursen. IdentityInfo
properties Egenskaper för domänen. DomainProperties

IdentityInfo

Name 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"
"Användartilldelade"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Referenserna för användaridentitetsordlistenyckeln ä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

Name Beskrivning Värde
{anpassad egenskap} UserIdentityProperties

UserIdentityProperties

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

DomainProperties

Name Beskrivning Värde
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 beaktas endast om PublicNetworkAccess är aktiverat. InboundIpRule[]
inputSchema Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till domänen. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Information om InputSchemaMapping som angav information om att mappa händelsenyttolasten. InputSchemaMapping
privateEndpointConnections Lista över privata slutpunktsanslutningar. PrivateEndpointConnection[]
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.DomainProperties.InboundIpRules" /}
"Inaktiverad"
"Aktiverad"

InboundIpRule

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

InputSchemaMapping

Name Beskrivning Värde
inputSchemaMappingType Ange objekttyp Json (krävs)

JsonInputSchemaMapping

Name Beskrivning Värde
inputSchemaMappingType Typ av anpassad mappning "Json" (krävs)
properties JSON-egenskaper för indataschemamappningen JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Name Beskrivning Värde
Dataversion Mappningsinformationen för egenskapen DataVersion för Event Grid-händelsen. JsonFieldWithDefault
Händelsetid Mappningsinformationen för eventtime-egenskapen för Event Grid-händelsen. JsonField
Händelsetyp 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
ämne Mappningsinformationen för egenskapen Ämne för Event Grid-händelsen. JsonFieldWithDefault
ämne Mappningsinformationen för egenskapen Topic för Event Grid-händelsen. JsonField

JsonFieldWithDefault

Name Beskrivning Värde
Standardvärde 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 Namn på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonField

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

PrivateEndpointConnection

Name Beskrivning Värde
properties Egenskaper för PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beskrivning Värde
groupIds GroupIds från private link-tjänstresursen. string[]
privateEndpoint Den privata slutpunktsresursen för den här anslutningen. PrivateEndpoint
privateLinkServiceConnectionState Information om anslutningens tillstånd. ConnectionState
provisioningState Etableringstillstånd för den privata slutpunktsanslutningen. "Avbruten"
"Skapar"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"

PrivateEndpoint

Name Beskrivning Värde
id ARM-identifieraren för privat slutpunkt. sträng

ConnectionState

Name Beskrivning Värde
actionsRequired Åtgärder som krävs (om sådana finns). sträng
beskrivning Beskrivning av anslutningstillståndet. sträng
status Status för anslutningen. "Godkänd"
"Frånkopplad"
"Väntar"
"Avvisad"

ResourceSku

Name Beskrivning Värde
name Resursens SKU-namn. Möjliga värden är: Basic eller Premium. "Grundläggande"
"Premium"

Resursdefinition för Terraform (AzAPI-provider)

Domänernas resurstyp 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/domains-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-04-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
    }
    sku = {
      name = "string"
    }
  })
}

InputSchemaMapping-objekt

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

För Json anvä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

Domäner

Name Beskrivning Värde
typ Resurstypen "Microsoft.EventGrid/domains@2020-04-01-preview"
name Resursnamnet sträng (krävs)

Teckengräns: 3–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck.
location Platsen för resursen. sträng (krävs)
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Taggar för resursen. Ordlista med taggnamn och värden.
sku Sku-prisnivån för domänen. ResourceSku
identity Identitetsinformation för resursen. IdentityInfo
properties Egenskaper för domänen. DomainProperties

IdentityInfo

Name Beskrivning Värde
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. "SystemTilldelade"
"SystemAssigned, UserAssigned"
"Användartilldelade"
identity_ids 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.
Matris med användaridentitets-ID:t.

IdentityInfoUserAssignedIdentities

Name Beskrivning Värde
{anpassad egenskap} UserIdentityEgenskaper

UserIdentityEgenskaper

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

DomainProperties

Name Beskrivning Värde
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 vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till domänen. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Information om InputSchemaMapping som angav information om nyttolasten för mappningshändelser. InputSchemaMapping
privateEndpointConnections Lista över privata slutpunktsanslutningar. PrivateEndpointConnection[]
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.DomainProperties.InboundIpRules" /}
"Inaktiverad"
"Aktiverad"

InkommandeipRule

Name Beskrivning Värde
åtgärd Åtgärd att utföra 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

Name Beskrivning Värde
inputSchemaMappingType Ange objekttyp Json (krävs)

JsonInputSchemaMapping

Name Beskrivning Värde
inputSchemaMappingType Typ av anpassad mappning "Json" (krävs)
properties JSON-egenskaper för mappningen av indataschemat JsonInputSchemaMappingEgenskaper

JsonInputSchemaMappingEgenskaper

Name Beskrivning Värde
Dataversion Mappningsinformationen för egenskapen DataVersion för Event Grid-händelsen. JsonFieldWithDefault
Händelsetid Mappningsinformationen för EventTime-egenskapen för Event Grid-händelsen. JsonField
Händelsetyp 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
ämne 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

JsonFieldWithDefault

Name Beskrivning Värde
Standardvärde 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 Namn på ett fält i indatahändelseschemat som ska användas som källa för en mappning. sträng

JsonField

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

PrivateEndpointConnection

Name Beskrivning Värde
properties Egenskaper för PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beskrivning Värde
groupIds GroupIds från private link-tjänstresursen. string[]
privateEndpoint Den privata slutpunktsresursen för den här anslutningen. PrivateEndpoint
privateLinkServiceConnectionState Information om anslutningens tillstånd. ConnectionState
provisioningState Etableringstillstånd för den privata slutpunktsanslutningen. "Avbruten"
"Skapa"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"

PrivateEndpoint

Name Beskrivning Värde
id ARM-identifieraren för privat slutpunkt. sträng

ConnectionState

Name Beskrivning Värde
actionsRequired Åtgärder som krävs (om sådana finns). sträng
beskrivning Beskrivning av anslutningstillståndet. sträng
status Status för anslutningen. "Godkänd"
"Frånkopplad"
"Väntar"
"Avvisad"

ResourceSku

Name Beskrivning Värde
name Resursens SKU-namn. Möjliga värden är: Basic eller Premium. "Basic"
"Premium"