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

Artikel
12/16/2024

Bicep-Ressourcendefinition

Der Ressourcentyp "partnerNamespaces/channels" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/partnerNamespaces/channels-Ressource zu erstellen, fügen Sie ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview' = {
  parent: resourceSymbolicName
  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: 'string'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

PartnerClientAuthentication-Objekte

Legen Sie den clientAuthenticationType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureAD-:

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

PartnerDestinationInfo-Objekte

Legen Sie den endpointType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für WebHook-:

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

Eigenschaftswerte

AzureADPartnerClientAuthentication

Name	Beschreibung	Wert
clientAuthenticationType	Typ der Clientauthentifizierung	"AzureAD" (erforderlich)
Eigenschaften	AzureAD ClientAuthentication-Eigenschaften	AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Name	Beschreibung	Wert
azureActiveDirectoryApplicationIdOrUri	Die Azure Active Directory-Anwendungs-ID oder der URI zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen eingeschlossen wird.	Schnur
azureActiveDirectoryTenantId	Die Azure Active Directory-Mandanten-ID, um das Zugriffstoken abzurufen, das als Bearertoken in Übermittlungsanforderungen eingeschlossen wird.	Schnur

ChannelProperties

Name	Beschreibung	Wert
channelType	Der Typ des Ereigniskanals, der den Richtungsfluss von Ereignissen darstellt.	'PartnerDestination' 'PartnerTopic'
expirationTimeIfNotActivatedUtc	Ablaufzeit des Kanals. Wenn dieser Timer abläuft, während das entsprechende Partnerthema nie aktiviert wird, der Kanal und das entsprechende Partnerthema werden gelöscht.	Schnur
messageForActivation	Kontext- oder hilfreiche Nachricht, die während des Genehmigungsprozesses vom Abonnenten verwendet werden kann.	Schnur
partnerDestinationInfo	Diese Eigenschaft sollte aufgefüllt werden, wenn channelType PartnerDestination ist und Informationen zur Partnerzielressource darstellt, die dem Kanal entspricht.	PartnerDestinationInfo-
partnerTopicInfo	Diese Eigenschaft sollte aufgefüllt werden, wenn channelType PartnerTopic ist und Informationen zur Partnerthemaressource darstellt, die dem Kanal entspricht.	PartnerTopicInfo-
provisioningState	Bereitstellungsstatus des Kanals.	'Abgebrochen' "Erstellen" "Löschen" 'Fehler' 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' "Erfolgreich" "Aktualisieren"
readinessState	Der Bereitschaftsstatus des entsprechenden Partnerthemas.	"Aktiviert" "NeverActivated"

EventTypeInfo

Name	Beschreibung	Wert
inlineEventTypes	Eine Auflistung von Inlineereignistypen für die Ressource. Die Inlineereignistypschlüssel sind vom Typ Zeichenfolge, die den Namen des Ereignisses darstellt. Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated". Die Inlineereignistypwerte sind vom Typ "InlineEventProperties" und enthalten zusätzliche Informationen für jeden Inlineereignistyp.	EventTypeInfoInlineEventTypes-
Art	Die Art des verwendeten Ereignistyps.	"Inline"

EventTypeInfoInlineEventTypes

Name	Beschreibung	Wert

InlineEventProperties

Name	Beschreibung	Wert
dataSchemaUrl	The dataSchemaUrl for the inline event.	Schnur
Beschreibung	Die Beschreibung für das Inlineereignis.	Schnur
displayName	Der displayName für das Inlineereignis.	Schnur
documentationUrl	Die documentationUrl für das Inlineereignis.	Schnur