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

Article
12/16/2024

Définition de ressource Bicep

Le type de ressource partnerNamespaces/canaux peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.EventGrid/partnerNamespaces/channels, ajoutez le bicep suivant à votre modèle.

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

Objets PartnerClientAuthentication

Définissez la propriété clientAuthenticationType pour spécifier le type d’objet.

Pour AzureAD, utilisez :

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

Objets PartnerDestinationInfo

Définissez la propriété endpointType pour spécifier le type d’objet.

Pour WebHook, utilisez :

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

Valeurs de propriété

AzureADPartnerClientAuthentication

Nom	Description	Valeur
clientAuthenticationType	Type d’authentification du client	'AzureAD' (obligatoire)
Propriétés	Propriétés d’AzureAD ClientAuthentication	AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nom	Description	Valeur
azureActiveDirectoryApplicationIdOrUri	ID d’application Azure Active Directory ou URI pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise.	corde
azureActiveDirectoryTenantId	ID de locataire Azure Active Directory pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise.	corde

ChannelProperties

Nom	Description	Valeur
channelType	Type du canal d’événements qui représente le flux de direction des événements.	'PartnerDestination' 'PartnerTopic'
expirationTimeIfNotActivatedUtc	Délai d’expiration du canal. Si ce minuteur expire alors que la rubrique partenaire correspondante n’est jamais activée, le canal et la rubrique partenaire correspondante sont supprimés.	corde
messageForActivation	Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné.	corde
partnerDestinationInfo	Cette propriété doit être remplie lorsque channelType est PartnerDestination et représente des informations sur la ressource de destination du partenaire correspondant au canal.	PartnerDestinationInfo
partnerTopicInfo	Cette propriété doit être remplie lorsque channelType est PartnerTopic et représente des informations sur la ressource de rubrique partenaire correspondant au canal.	PartnerTopicInfo
provisioningState	État d’approvisionnement du canal.	'Annulé' 'Création' 'Suppression' 'Échec' 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' 'Réussi' 'Mise à jour'
readinessState	État de préparation de la rubrique partenaire correspondante.	'Activé' 'NeverActivated'

EventTypeInfo

Nom	Description	Valeur
inlineEventTypes	Collection de types d’événements inline pour la ressource. Les clés de type d’événement inline sont de type chaîne qui représente le nom de l’événement. Un exemple de nom d’événement inline valide est « Contoso.OrderCreated ». Les valeurs de type d’événement inline sont de type InlineEventProperties et contiennent des informations supplémentaires pour chaque type d’événement inline.	EventTypeInfoInlineEventTypes
gentil	Type d’événement utilisé.	'Inline'

EventTypeInfoInlineEventTypes

Nom	Description	Valeur

InlineEventProperties

Nom	Description	Valeur
dataSchemaUrl	DataSchemaUrl pour l’événement inline.	corde
description	Description de l’événement inline.	corde
displayName	DisplayName pour l’événement inline.	corde
documentationUrl	DocumentationUrl de l’événement inline.	corde