Partager via

Microsoft.EventGrid partnerNamespaces/channels 2023-06-01-preview

  • Article

Définition de ressource Bicep

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

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

Format des ressources

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

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2023-06-01-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'
  }
}

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

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

Valeurs de propriétés

partnerNamespaces/canaux

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : partnerNamespaces
properties Propriétés du canal. Channelproperties

Channelproperties

Nom Description Valeur
channelType Type du canal d’événements qui représente le flux de direction des événements. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Heure 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.		 string
messageForActivation Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné. string
partnerDestinationInfo Cette propriété doit être renseignée lorsque channelType est PartnerDestination et représente des informations sur la ressource de destination partenaire correspondant au canal. PartnerDestinationInfo
partnerTopicInfo Cette propriété doit être renseignée 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'

PartnerDestinationInfo

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de l’abonné. La destination partenaire associée au canal sera
créé dans le cadre de cet abonnement Azure.		 string
endpointServiceContext Contexte supplémentaire du point de terminaison de destination du partenaire. string
name Nom de la destination partenaire associée au canal. string
resourceGroupName Groupe de ressources Azure de l’abonné. La destination partenaire associée au canal sera
créé sous ce groupe de ressources.		 string
resourceMoveChangeHistory Historique des modifications du déplacement des ressources. ResourceMoveChangeHistory[]
endpointType Définir le type d’objet WebHook (obligatoire)

ResourceMoveChangeHistory

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de la ressource. string
changedTimeUtc Horodatage UTC de la modification de la ressource. string
resourceGroupName Groupe de ressources Azure de la ressource. string

WebhookPartnerDestinationInfo

Nom Description Valeur
endpointType Type du point de terminaison pour la destination du partenaire 'WebHook' (obligatoire)
properties Propriétés webHook de la destination du partenaire. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nom Description Valeur
clientAuthentication Authentification du client partenaire PartnerClientAuthentication
endpointBaseUrl URL de base qui représente le point de terminaison de la destination du partenaire. string
endpointUrl URL qui représente le point de terminaison de la destination du partenaire. string

PartnerClientAuthentication

Nom Description Valeur
clientAuthenticationType Définir le type d’objet AzureAD (obligatoire)

AzureADPartnerClientAuthentication

Nom Description Valeur
clientAuthenticationType Type d’authentification client 'AzureAD' (obligatoire)
properties AzureAD ClientAuthentication Properties AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

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

PartnerTopicInfo

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de l’abonné. La rubrique partenaire associée au canal sera
créé dans le cadre de cet abonnement Azure.		 string
eventTypeInfo Informations sur le type d’événement pour la rubrique partenaire. Ces informations sont fournies par l’éditeur et peuvent être utilisées par le
abonné pour afficher les différents types d’événements publiés.		 EventTypeInfo
name Nom de la rubrique partenaire associée au canal. string
resourceGroupName Groupe de ressources Azure de l’abonné. La rubrique partenaire associée au canal sera
créé sous ce groupe de ressources.		 string
source Les informations sources sont fournies par l’éditeur pour déterminer l’étendue ou le contexte à partir duquel les événements
sont d’origine. Ces informations peuvent être utilisées par l’abonné pendant le processus d’approbation du
rubrique de partenaire créée.
 string

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
kind Type d’événement utilisé. 'Inline'

EventTypeInfoInlineEventTypes

Nom Description Valeur
{propriété personnalisée} InlineEventProperties

InlineEventProperties

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

Définition de ressources de modèle ARM

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

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

Format des ressources

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

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2023-06-01-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"
  }
}

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

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

Valeurs de propriétés

partnerNamespaces/canaux

Nom Description Valeur
type Type de ressource « Microsoft.EventGrid/partnerNamespaces/channels »
apiVersion Version de l’API de ressource « 2023-06-01-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 chaîne (obligatoire)
properties Propriétés du canal. Channelproperties

Channelproperties

Nom Description Valeur
channelType Type du canal d’événements qui représente le flux de direction des événements. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Heure 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.		 string
messageForActivation Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné. string
partnerDestinationInfo Cette propriété doit être renseignée lorsque channelType est PartnerDestination et représente des informations sur la ressource de destination partenaire correspondant au canal. PartnerDestinationInfo
partnerTopicInfo Cette propriété doit être renseignée 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'

PartnerDestinationInfo

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de l’abonné. La destination partenaire associée au canal sera
créé dans le cadre de cet abonnement Azure.		 string
endpointServiceContext Contexte supplémentaire du point de terminaison de destination du partenaire. string
name Nom de la destination partenaire associée au canal. string
resourceGroupName Groupe de ressources Azure de l’abonné. La destination partenaire associée au canal sera
créé sous ce groupe de ressources.		 string
resourceMoveChangeHistory Historique des modifications du déplacement des ressources. ResourceMoveChangeHistory[]
endpointType Définir le type d’objet WebHook (obligatoire)

ResourceMoveChangeHistory

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de la ressource. string
changedTimeUtc Horodatage UTC du moment où la ressource a été modifiée. string
resourceGroupName Groupe de ressources Azure de la ressource. string

WebhookPartnerDestinationInfo

Nom Description Valeur
endpointType Type du point de terminaison pour la destination du partenaire 'WebHook' (obligatoire)
properties WebHook Propriétés de la destination partenaire. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nom Description Valeur
clientAuthentication Authentification du client partenaire PartnerClientAuthentication
endpointBaseUrl URL de base qui représente le point de terminaison de la destination du partenaire. string
endpointUrl URL qui représente le point de terminaison de la destination partenaire. string

PartnerClientAuthentication

Nom Description Valeur
clientAuthenticationType Définir le type d’objet AzureAD (obligatoire)

AzureADPartnerClientAuthentication

Nom Description Valeur
clientAuthenticationType Type d’authentification client 'AzureAD' (obligatoire)
properties AzureAD ClientAuthentication, propriétés AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

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

PartnerTopicInfo

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de l’abonné. La rubrique partenaire associée au canal sera
créé dans le cadre de cet abonnement Azure.		 string
eventTypeInfo Informations sur le type d’événement pour la rubrique partenaire. Ces informations sont fournies par l’éditeur et peuvent être utilisées par le
abonné pour afficher les différents types d’événements publiés.		 EventTypeInfo
name Nom de la rubrique partenaire associée au canal. string
resourceGroupName Groupe de ressources Azure de l’abonné. La rubrique partenaire associée au canal sera
créé sous ce groupe de ressources.		 string
source Les informations sources sont fournies par l’éditeur pour déterminer l’étendue ou le contexte à partir duquel les événements
sont d’origine. Ces informations peuvent être utilisées par l’abonné pendant le processus d’approbation du
rubrique partenaire créée.
 string

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
kind Type d’événement utilisé. 'Inline'

EventTypeInfoInlineEventTypes

Nom Description Valeur
{propriété personnalisée} InlineEventProperties

InlineEventProperties

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

Définition de ressource Terraform (fournisseur AzAPI)

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

  • Groupes de ressources

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

Format des ressources

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2023-06-01-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"
    }
  })
}

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

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

Valeurs de propriétés

partnerNamespaces/canaux

Nom Description Valeur
type Type de ressource « Microsoft.EventGrid/partnerNamespaces/channels@2023-06-01-preview »
name Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : partnerNamespaces
properties Propriétés du canal. Channelproperties

Channelproperties

Nom Description Valeur
channelType Type du canal d’événements qui représente le flux de direction des événements. « PartnerDestination »
« PartnerTopic »
expirationTimeIfNotActivatedUtc Heure 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.		 string
messageForActivation Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné. string
partnerDestinationInfo Cette propriété doit être renseignée lorsque channelType est PartnerDestination et représente des informations sur la ressource de destination partenaire correspondant au canal. PartnerDestinationInfo
partnerTopicInfo Cette propriété doit être renseignée 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 »

PartnerDestinationInfo

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de l’abonné. La destination partenaire associée au canal sera
créé dans le cadre de cet abonnement Azure.		 string
endpointServiceContext Contexte supplémentaire du point de terminaison de destination du partenaire. string
name Nom de la destination partenaire associée au canal. string
resourceGroupName Groupe de ressources Azure de l’abonné. La destination partenaire associée au canal sera
créé sous ce groupe de ressources.		 string
resourceMoveChangeHistory Historique des modifications du déplacement des ressources. ResourceMoveChangeHistory[]
endpointType Définir le type d’objet WebHook (obligatoire)

ResourceMoveChangeHistory

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de la ressource. string
changedTimeUtc Horodatage UTC du moment où la ressource a été modifiée. string
resourceGroupName Groupe de ressources Azure de la ressource. string

WebhookPartnerDestinationInfo

Nom Description Valeur
endpointType Type du point de terminaison pour la destination du partenaire « WebHook » (obligatoire)
properties WebHook Propriétés de la destination partenaire. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nom Description Valeur
clientAuthentication Authentification du client partenaire PartnerClientAuthentication
endpointBaseUrl URL de base qui représente le point de terminaison de la destination du partenaire. string
endpointUrl URL qui représente le point de terminaison de la destination partenaire. string

PartnerClientAuthentication

Nom Description Valeur
clientAuthenticationType Définir le type d’objet AzureAD (obligatoire)

AzureADPartnerClientAuthentication

Nom Description Valeur
clientAuthenticationType Type d’authentification client « AzureAD » (obligatoire)
properties AzureAD ClientAuthentication, propriétés AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

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

PartnerTopicInfo

Nom Description Valeur
azureSubscriptionId ID d’abonnement Azure de l’abonné. La rubrique partenaire associée au canal sera
créé dans le cadre de cet abonnement Azure.		 string
eventTypeInfo Informations sur le type d’événement pour la rubrique partenaire. Ces informations sont fournies par l’éditeur et peuvent être utilisées par le
abonné pour afficher les différents types d’événements publiés.		 EventTypeInfo
name Nom de la rubrique partenaire associée au canal. string
resourceGroupName Groupe de ressources Azure de l’abonné. La rubrique partenaire associée au canal sera
créé sous ce groupe de ressources.		 string
source Les informations sources sont fournies par l’éditeur pour déterminer l’étendue ou le contexte à partir duquel les événements
sont d’origine. Ces informations peuvent être utilisées par l’abonné pendant le processus d’approbation du
rubrique de partenaire créée.
 string

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
kind Type d’événement utilisé. « Inline »

EventTypeInfoInlineEventTypes

Nom Description Valeur
{propriété personnalisée} InlineEventProperties

InlineEventProperties

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