Dela via

Microsoft.EventGrid partnerNamespaces/channels 2023-12-15-preview

  • Artikel

Bicep-resursdefinition

Resurstypen partnerNamespaces/channels 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 Resurs för Microsoft.EventGrid/partnerNamespaces/channels lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    channelType: 'string'
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerDestinationInfo: {
      azureSubscriptionId: 'string'
      endpointServiceContext: 'string'
      name: 'string'
      resourceGroupName: 'string'
      resourceMoveChangeHistory: [
        {
          azureSubscriptionId: 'string'
          changedTimeUtc: 'string'
          resourceGroupName: 'string'
        }
      ]
      endpointType: 'string'
      // For remaining properties, see PartnerDestinationInfo objects
    }
    partnerTopicInfo: {
      azureSubscriptionId: 'string'
      eventTypeInfo: {
        inlineEventTypes: {
          {customized property}: {
            dataSchemaUrl: 'string'
            description: 'string'
            displayName: 'string'
            documentationUrl: 'string'
          }
        }
        kind: 'Inline'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

PartnerDestinationInfo-objekt

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

För WebHook använder du:

  endpointType: 'WebHook'
  properties: {
    clientAuthentication: {
      clientAuthenticationType: 'string'
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl: 'string'
    endpointUrl: 'string'
  }

PartnerClientAuthentication-objekt

Ange egenskapen clientAuthenticationType för att ange objekttypen.

För AzureAD använder du:

  clientAuthenticationType: 'AzureAD'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
  }

Egenskapsvärden

partnerNamespaces/kanaler

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: partnerNamespaces
properties Egenskaper för kanalen. ChannelProperties

ChannelProperties

Name Beskrivning Värde
channelType Typen av händelsekanal som representerar riktningsflödet för händelser. "PartnerDestination"
"PartnerTopic"
expirationTimeIfNotActivatedUtc Förfallotid för kanalen. Om den här timern upphör att gälla medan motsvarande partnerämne aldrig aktiveras,
kanalen och motsvarande partnerämne tas bort.		 sträng
messageForActivation Kontext eller användbart meddelande som kan användas under godkännandeprocessen av prenumeranten. sträng
partnerDestinationInfo Den här egenskapen ska fyllas i när channelType är PartnerDestination och representerar information om partnermålresursen som motsvarar kanalen. PartnerDestinationInfo
partnerTopicInfo Den här egenskapen ska fyllas i när channelType är PartnerTopic och representerar information om partnerämnesresursen som motsvarar kanalen. PartnerTopicInfo
provisioningState Etableringstillstånd för kanalen. "Avbruten"
"Skapar"
"Tar bort"
"Misslyckades"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Lyckades"
"Uppdaterar"
readinessState Beredskapstillståndet för motsvarande partnerämne. "Aktiverad"
"Aldrigaktiverad"

PartnerDestinationInfo

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för prenumeranten. Partnermålet som är associerat med kanalen kommer att
som skapats under den här Azure-prenumerationen.		 sträng
endpointServiceContext Ytterligare kontext för partnermålslutpunkten. sträng
name Namnet på partnermålet som är associerat med kanalen. sträng
resourceGroupName Azure-resursgruppen för prenumeranten. Partnermålet som är associerat med kanalen kommer att
som skapats under den här resursgruppen.		 sträng
resourceMoveChangeHistory Ändra historik för resursflytten. ResourceMoveChangeHistory[]
endpointType Ange objekttyp WebHook (krävs)

ResourceMoveChangeHistory

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för resursen. sträng
changedTimeUtc UTC-tidsstämpel för när resursen ändrades. sträng
resourceGroupName Azure-resursgruppen för resursen. sträng

WebhookPartnerDestinationInfo

Name Beskrivning Värde
endpointType Typ av slutpunkt för partnermålet "WebHook" (krävs)
properties WebHook Egenskaper för partnermålet. WebhookPartnerDestinationEgenskaper

WebhookPartnerDestinationEgenskaper

Name Beskrivning Värde
clientAuthentication Partnerklientautentisering PartnerClientAuthentication
endpointBaseUrl Bas-URL:en som representerar slutpunkten för partnermålet. sträng
endpointUrl Den URL som representerar slutpunkten för partnermålet. sträng

PartnerClientAuthentication

Name Beskrivning Värde
clientAuthenticationType Ange objekttyp AzureAD (krävs)

AzureADPartnerClientAuthentication

Name Beskrivning Värde
clientAuthenticationType Typ av klientautentisering "AzureAD" (krävs)
properties Egenskaper för AzureAD ClientAuthentication AzureADPartnerClientAuthenticationEgenskaper

AzureADPartnerClientAuthenticationEgenskaper

Name Beskrivning Värde
azureActiveDirectoryApplicationIdOrUri Azure Active Directory-program-ID eller URI för att hämta åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden. sträng
azureActiveDirectoryTenantId Klient-ID:t för Azure Active Directory för att hämta den åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden. sträng

PartnerTopicInfo

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för prenumeranten. Partnerämnet som är associerat med kanalen kommer att
skapats under den här Azure-prenumerationen.		 sträng
eventTypeInfo Händelsetypsinformation för partnerämnet. Den här informationen tillhandahålls av utgivaren och kan användas av
prenumerant för att visa olika typer av händelser som publiceras.		 EventTypeInfo
name Namnet på partnerämnet som är associerat med kanalen. sträng
resourceGroupName Azure-resursgruppen för prenumeranten. Partnerämnet som är associerat med kanalen kommer att
som skapats under den här resursgruppen.		 sträng
källa Källinformationen tillhandahålls av utgivaren för att fastställa omfattningen eller kontexten från vilken händelserna
har sitt ursprung. Den här informationen kan användas av prenumeranten under godkännandeprocessen för
skapat partnerämne.
 sträng

EventTypeInfo

Name Beskrivning Värde
inlineEventTypes En samling infogade händelsetyper för resursen. Nycklarna för den infogade händelsetypen är av typen sträng som representerar namnet på händelsen.
Ett exempel på ett giltigt infogat händelsenamn är "Contoso.OrderCreated".
Värdena för den infogade händelsetypen är av typen InlineEventProperties och innehåller ytterligare information för varje infogad händelsetyp.		 EventTypeInfoInlineEventTypes
Typ Den typ av händelsetyp som används. "Infogad"

EventTypeInfoInlineEventTypes

Name Beskrivning Värde
{anpassad egenskap} InlineEventEgenskaper

InlineEventEgenskaper

Name Beskrivning Värde
dataSchemaUrl dataSchemaUrl för den infogade händelsen. sträng
beskrivning Beskrivningen för den infogade händelsen. sträng
displayName displayName för den infogade händelsen. sträng
documentationUrl DocumentationUrl för den infogade händelsen. sträng

Resursdefinition för ARM-mall

Resurstypen partnerNamespaces/channels 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/partnerNamespaces/channels-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "properties": {
    "channelType": "string",
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerDestinationInfo": {
      "azureSubscriptionId": "string",
      "endpointServiceContext": "string",
      "name": "string",
      "resourceGroupName": "string",
      "resourceMoveChangeHistory": [
        {
          "azureSubscriptionId": "string",
          "changedTimeUtc": "string",
          "resourceGroupName": "string"
        }
      ],
      "endpointType": "string"
      // For remaining properties, see PartnerDestinationInfo objects
    },
    "partnerTopicInfo": {
      "azureSubscriptionId": "string",
      "eventTypeInfo": {
        "inlineEventTypes": {
          "{customized property}": {
            "dataSchemaUrl": "string",
            "description": "string",
            "displayName": "string",
            "documentationUrl": "string"
          }
        },
        "kind": "Inline"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "string"
  }
}

PartnerDestinationInfo-objekt

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

För WebHook använder du:

  "endpointType": "WebHook",
  "properties": {
    "clientAuthentication": {
      "clientAuthenticationType": "string"
      // For remaining properties, see PartnerClientAuthentication objects
    },
    "endpointBaseUrl": "string",
    "endpointUrl": "string"
  }

PartnerClientAuthentication-objekt

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

För AzureAD använder du:

  "clientAuthenticationType": "AzureAD",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string"
  }

Egenskapsvärden

partnerNamespaces/kanaler

Name Beskrivning Värde
typ Resurstypen "Microsoft.EventGrid/partnerNamespaces/channels"
apiVersion Resurs-API-versionen "2023-12-15-preview"
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
properties Egenskaper för kanalen. ChannelProperties

ChannelProperties

Name Beskrivning Värde
channelType Typen av händelsekanal som representerar händelseflödets riktning. "PartnerDestination"
"PartnerTopic"
expirationTimeIfNotActivatedUtc Förfallotid för kanalen. Om den här timern upphör att gälla medan motsvarande partnerämne aldrig aktiveras,
kanalen och motsvarande partnerämne tas bort.		 sträng
messageForActivation Kontext eller användbart meddelande som kan användas under godkännandeprocessen av prenumeranten. sträng
partnerDestinationInfo Den här egenskapen bör fyllas i när channelType är PartnerDestination och representerar information om partnermålresursen som motsvarar kanalen. PartnerDestinationInfo
partnerTopicInfo Den här egenskapen bör fyllas i när channelType är PartnerTopic och representerar information om partnerämnesresursen som motsvarar kanalen. PartnerTopicInfo
provisioningState Etableringstillstånd för kanalen. "Avbruten"
"Skapar"
"Ta bort"
"Misslyckades"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Lyckades"
"Uppdatera"
readinessState Beredskapstillståndet för motsvarande partnerämne. "Aktiverad"
"Aldrigaktiverad"

PartnerDestinationInfo

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för prenumeranten. Partnermålet som är associerat med kanalen kommer att
skapats under den här Azure-prenumerationen.		 sträng
endpointServiceContext Ytterligare kontext för partnermålslutpunkten. sträng
name Namnet på partnermålet som är associerat med kanalen. sträng
resourceGroupName Azure-resursgruppen för prenumeranten. Partnermålet som är associerat med kanalen kommer att
som skapats under den här resursgruppen.		 sträng
resourceMoveChangeHistory Ändra historik för resursflytten. ResourceMoveChangeHistory[]
endpointType Ange objekttyp WebHook (krävs)

ResourceMoveChangeHistory

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för resursen. sträng
changedTimeUtc UTC-tidsstämpel för när resursen ändrades. sträng
resourceGroupName Azure-resursgruppen för resursen. sträng

WebhookPartnerDestinationInfo

Name Beskrivning Värde
endpointType Typ av slutpunkt för partnermålet "WebHook" (krävs)
properties WebHook-egenskaper för partnermålet. WebhookPartnerDestinationEgenskaper

WebhookPartnerDestinationEgenskaper

Name Beskrivning Värde
clientAuthentication Partnerklientautentisering PartnerClientAuthentication
endpointBaseUrl Bas-URL:en som representerar slutpunkten för partnermålet. sträng
endpointUrl Den URL som representerar slutpunkten för partnermålet. sträng

PartnerClientAuthentication

Name Beskrivning Värde
clientAuthenticationType Ange objekttyp AzureAD (krävs)

AzureADPartnerClientAuthentication

Name Beskrivning Värde
clientAuthenticationType Typ av klientautentisering "AzureAD" (krävs)
properties Egenskaper för AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Name Beskrivning Värde
azureActiveDirectoryApplicationIdOrUri Azure Active Directory-program-ID eller URI för att hämta den åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden. sträng
azureActiveDirectoryTenantId Klient-ID:t för Azure Active Directory för att hämta den åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden. sträng

PartnerTopicInfo

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för prenumeranten. Partnerämnet som är associerat med kanalen kommer att
som skapats under den här Azure-prenumerationen.		 sträng
eventTypeInfo Information om händelsetyp för partnerämnet. Den här informationen tillhandahålls av utgivaren och kan användas av
prenumerant för att visa olika typer av händelser som publiceras.		 EventTypeInfo
name Namnet på partnerämnet som är associerat med kanalen. sträng
resourceGroupName Azure-resursgruppen för prenumeranten. Partnerämnet som är associerat med kanalen kommer att
som skapats under den här resursgruppen.		 sträng
källa Källinformationen tillhandahålls av utgivaren för att fastställa omfånget eller kontexten från vilken händelserna
har sitt ursprung. Den här informationen kan användas av prenumeranten under godkännandeprocessen för
skapat partnerämne.
 sträng

EventTypeInfo

Name Beskrivning Värde
inlineEventTypes En samling infogade händelsetyper för resursen. De infogade händelsetypsnycklarna är av typen sträng som representerar namnet på händelsen.
Ett exempel på ett giltigt infogat händelsenamn är "Contoso.OrderCreated".
Värdena för den infogade händelsetypen är av typen InlineEventProperties och innehåller ytterligare information för varje infogad händelsetyp.		 EventTypeInfoInlineEventTypes
Typ Den typ av händelsetyp som används. "Infogad"

EventTypeInfoInlineEventTypes

Name Beskrivning Värde
{anpassad egenskap} InlineEventProperties

InlineEventProperties

Name Beskrivning Värde
dataSchemaUrl dataSchemaUrl för den infogade händelsen. sträng
beskrivning Beskrivningen för den infogade händelsen. sträng
displayName displayName för den infogade händelsen. sträng
documentationUrl DocumentationUrl för den infogade händelsen. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen partnerNamespaces/channels 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 Resurs för Microsoft.EventGrid/partnerNamespaces/channels lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      channelType = "string"
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerDestinationInfo = {
        azureSubscriptionId = "string"
        endpointServiceContext = "string"
        name = "string"
        resourceGroupName = "string"
        resourceMoveChangeHistory = [
          {
            azureSubscriptionId = "string"
            changedTimeUtc = "string"
            resourceGroupName = "string"
          }
        ]
        endpointType = "string"
        // For remaining properties, see PartnerDestinationInfo objects
      }
      partnerTopicInfo = {
        azureSubscriptionId = "string"
        eventTypeInfo = {
          inlineEventTypes = {
            {customized property} = {
              dataSchemaUrl = "string"
              description = "string"
              displayName = "string"
              documentationUrl = "string"
            }
          }
          kind = "Inline"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "string"
    }
  })
}

PartnerDestinationInfo-objekt

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

För WebHook använder du:

  endpointType = "WebHook"
  properties = {
    clientAuthentication = {
      clientAuthenticationType = "string"
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl = "string"
    endpointUrl = "string"
  }

PartnerClientAuthentication-objekt

Ange egenskapen clientAuthenticationType för att ange objekttypen.

För AzureAD använder du:

  clientAuthenticationType = "AzureAD"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
  }

Egenskapsvärden

partnerNamespaces/kanaler

Name Beskrivning Värde
typ Resurstypen "Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview"
name Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: partnerNamespaces
properties Egenskaper för kanalen. ChannelProperties

ChannelProperties

Name Beskrivning Värde
channelType Typen av händelsekanal som representerar riktningsflödet för händelser. "PartnerDestination"
"PartnerTopic"
expirationTimeIfNotActivatedUtc Förfallotid för kanalen. Om den här timern upphör att gälla medan motsvarande partnerämne aldrig aktiveras,
kanalen och motsvarande partnerämne tas bort.		 sträng
messageForActivation Kontext eller användbart meddelande som kan användas under godkännandeprocessen av prenumeranten. sträng
partnerDestinationInfo Den här egenskapen ska fyllas i när channelType är PartnerDestination och representerar information om partnermålresursen som motsvarar kanalen. PartnerDestinationInfo
partnerTopicInfo Den här egenskapen ska fyllas i när channelType är PartnerTopic och representerar information om partnerämnesresursen som motsvarar kanalen. PartnerTopicInfo
provisioningState Etableringstillstånd för kanalen. "Avbruten"
"Skapar"
"Tar bort"
"Misslyckades"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Lyckades"
"Uppdatera"
readinessState Beredskapstillståndet för motsvarande partnerämne. "Aktiverad"
"NeverActivated"

PartnerDestinationInfo

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för prenumeranten. Partnermålet som är associerat med kanalen kommer att
skapats under den här Azure-prenumerationen.		 sträng
endpointServiceContext Ytterligare kontext för partnermålslutpunkten. sträng
name Namnet på partnermålet som är associerat med kanalen. sträng
resourceGroupName Azure-resursgruppen för prenumeranten. Partnermålet som är associerat med kanalen kommer att
som skapats under den här resursgruppen.		 sträng
resourceMoveChangeHistory Ändra historik för resursflytten. ResourceMoveChangeHistory[]
endpointType Ange objekttyp WebHook (krävs)

ResourceMoveChangeHistory

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för resursen. sträng
changedTimeUtc UTC-tidsstämpel för när resursen ändrades. sträng
resourceGroupName Azure-resursgruppen för resursen. sträng

WebhookPartnerDestinationInfo

Name Beskrivning Värde
endpointType Typ av slutpunkt för partnermålet "WebHook" (krävs)
properties WebHook Egenskaper för partnermålet. WebhookPartnerDestinationEgenskaper

WebhookPartnerDestinationEgenskaper

Name Beskrivning Värde
clientAuthentication Partnerklientautentisering PartnerClientAuthentication
endpointBaseUrl Bas-URL:en som representerar slutpunkten för partnermålet. sträng
endpointUrl Den URL som representerar slutpunkten för partnermålet. sträng

PartnerClientAuthentication

Name Beskrivning Värde
clientAuthenticationType Ange objekttyp AzureAD (krävs)

AzureADPartnerClientAuthentication

Name Beskrivning Värde
clientAuthenticationType Typ av klientautentisering "AzureAD" (krävs)
properties Egenskaper för AzureAD ClientAuthentication AzureADPartnerClientAuthenticationEgenskaper

AzureADPartnerClientAuthenticationEgenskaper

Name Beskrivning Värde
azureActiveDirectoryApplicationIdOrUri Azure Active Directory-program-ID eller URI för att hämta åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden. sträng
azureActiveDirectoryTenantId Klient-ID:t för Azure Active Directory för att hämta den åtkomsttoken som ska inkluderas som ägartoken i leveransbegäranden. sträng

PartnerTopicInfo

Name Beskrivning Värde
azureSubscriptionId Azure-prenumerations-ID för prenumeranten. Partnerämnet som är associerat med kanalen kommer att
som skapats under den här Azure-prenumerationen.		 sträng
eventTypeInfo Information om händelsetyp för partnerämnet. Den här informationen tillhandahålls av utgivaren och kan användas av
prenumerant för att visa olika typer av händelser som publiceras.		 EventTypeInfo
name Namnet på partnerämnet som är associerat med kanalen. sträng
resourceGroupName Azure-resursgruppen för prenumeranten. Partnerämnet som är associerat med kanalen kommer att
som skapats under den här resursgruppen.		 sträng
källa Källinformationen tillhandahålls av utgivaren för att fastställa omfånget eller kontexten från vilken händelserna
har sitt ursprung. Den här informationen kan användas av prenumeranten under godkännandeprocessen för
skapat partnerämne.
 sträng

EventTypeInfo

Name Beskrivning Värde
inlineEventTypes En samling infogade händelsetyper för resursen. De infogade händelsetypsnycklarna är av typen sträng som representerar namnet på händelsen.
Ett exempel på ett giltigt infogat händelsenamn är "Contoso.OrderCreated".
Värdena för den infogade händelsetypen är av typen InlineEventProperties och innehåller ytterligare information för varje infogad händelsetyp.		 EventTypeInfoInlineEventTypes
Typ Den typ av händelsetyp som används. "Infogad"

EventTypeInfoInlineEventTypes

Name Beskrivning Värde
{anpassad egenskap} InlineEventProperties

InlineEventProperties

Name Beskrivning Värde
dataSchemaUrl dataSchemaUrl för den infogade händelsen. sträng
beskrivning Beskrivningen för den infogade händelsen. sträng
displayName displayName för den infogade händelsen. sträng
documentationUrl DocumentationUrl för den infogade händelsen. sträng