Partager via

Microsoft.EventGrid partnerTopics 2023-06-01-preview

  • Article

Définition de ressource Bicep

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

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

Format des ressources

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

resource symbolicname 'Microsoft.EventGrid/partnerTopics@2023-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    activationState: 'string'
    eventTypeInfo: {
      inlineEventTypes: {
        {customized property}: {
          dataSchemaUrl: 'string'
          description: 'string'
          displayName: 'string'
          documentationUrl: 'string'
        }
      }
      kind: 'Inline'
    }
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerRegistrationImmutableId: 'string'
    partnerTopicFriendlyDescription: 'string'
    source: 'string'
  }
}

Valeurs de propriétés

partnerTopics

Nom Description Valeur
name Nom de la ressource string (obligatoire)
location Emplacement de la ressource. string (obligatoire)
tags Étiquettes de la ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité Informations d’identité pour la ressource Rubrique partenaire. IdentityInfo
properties Propriétés de la rubrique partenaire. PartnerTopicProperties

IdentityInfo

Nom Description Valeur
principalId ID principal de l’identité de ressource. string
tenantId ID de locataire de la ressource. string
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé du dictionnaire d’identité utilisateur seront des ID de ressource ARM au format :
« /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».
Cette propriété n’est actuellement pas utilisée et réservée pour une utilisation ultérieure.
 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

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

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. string
principalId ID principal de l’identité affectée par l’utilisateur. string

PartnerTopicProperties

Nom Description Valeur
activationState État d’activation de la rubrique partenaire. 'Activé'
'Désactivé'
'NeverActivated'
eventTypeInfo Informations sur le type d’événement du canal d’événements correspondant. EventTypeInfo
expirationTimeIfNotActivatedUtc Délai d’expiration de la rubrique partenaire. Si ce minuteur expire alors que la rubrique partenaire n’est toujours jamais activée,
la rubrique partenaire et le canal d’événements correspondant sont supprimés.		 string
messageForActivation Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné. string
partnerRegistrationImmutableId ImmutableId de l’inscription de partenaire correspondante. string

Contraintes :
Longueur minimale = 36
Longueur maximale = 36
Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
partnerTopicFriendlyDescription Description conviviale du sujet. Cela peut être défini par l’éditeur/partenaire pour afficher une description personnalisée pour la rubrique partenaire client.
Cela sera utile pour lever toute ambiguïté quant à l’origine de la création de la rubrique partenaire pour le client.		 string
source Source associée à cette rubrique partenaire. Il s’agit d’une ressource partenaire unique. 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

Définition de ressources de modèle ARM

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

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

Format des ressources

Pour créer une ressource Microsoft.EventGrid/partnerTopics, ajoutez le json suivant à votre modèle.

{
  "type": "Microsoft.EventGrid/partnerTopics",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "activationState": "string",
    "eventTypeInfo": {
      "inlineEventTypes": {
        "{customized property}": {
          "dataSchemaUrl": "string",
          "description": "string",
          "displayName": "string",
          "documentationUrl": "string"
        }
      },
      "kind": "Inline"
    },
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerRegistrationImmutableId": "string",
    "partnerTopicFriendlyDescription": "string",
    "source": "string"
  }
}

Valeurs de propriétés

partnerTopics

Nom Description Valeur
type Type de ressource 'Microsoft.EventGrid/partnerTopics'
apiVersion Version de l’API de ressource '2023-06-01-preview'
name Nom de la ressource string (obligatoire)
location Emplacement de la ressource. string (obligatoire)
tags Étiquettes de la ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité Informations d’identité pour la ressource Rubrique partenaire. IdentityInfo
properties Propriétés de la rubrique partenaire. PartnerTopicProperties

IdentityInfo

Nom Description Valeur
principalId ID principal de l’identité de ressource. string
tenantId ID de locataire de la ressource. string
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé du dictionnaire d’identité utilisateur seront des ID de ressource ARM au format :
« /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».
Cette propriété n’est actuellement pas utilisée et réservée pour une utilisation ultérieure.
 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

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

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. string
principalId ID principal de l’identité affectée par l’utilisateur. string

PartnerTopicProperties

Nom Description Valeur
activationState État d’activation de la rubrique partenaire. 'Activé'
'Désactivé'
'NeverActivated'
eventTypeInfo Informations sur le type d’événement du canal d’événements correspondant. EventTypeInfo
expirationTimeIfNotActivatedUtc Délai d’expiration de la rubrique partenaire. Si ce minuteur expire alors que la rubrique partenaire n’est toujours jamais activée,
la rubrique partenaire et le canal d’événements correspondant sont supprimés.		 string
messageForActivation Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné. string
partnerRegistrationImmutableId ImmutableId de l’inscription de partenaire correspondante. string

Contraintes :
Longueur minimale = 36
Longueur maximale = 36
Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
partnerTopicFriendlyDescription Description conviviale du sujet. Cela peut être défini par l’éditeur/partenaire pour afficher une description personnalisée pour la rubrique partenaire client.
Cela sera utile pour lever toute ambiguïté quant à l’origine de la création de la rubrique partenaire pour le client.		 string
source Source associée à cette rubrique partenaire. Il s’agit d’une ressource partenaire unique. 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

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource partnerTopics 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 d’API, consultez journal des modifications.

Format des ressources

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerTopics@2023-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      activationState = "string"
      eventTypeInfo = {
        inlineEventTypes = {
          {customized property} = {
            dataSchemaUrl = "string"
            description = "string"
            displayName = "string"
            documentationUrl = "string"
          }
        }
        kind = "Inline"
      }
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerRegistrationImmutableId = "string"
      partnerTopicFriendlyDescription = "string"
      source = "string"
    }
  })
}

Valeurs de propriétés

partnerTopics

Nom Description Valeur
type Type de ressource « Microsoft.EventGrid/partnerTopics@2023-06-01-preview »
name Nom de la ressource string (obligatoire)
location Emplacement de la ressource. string (obligatoire)
parent_id Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. string (obligatoire)
tags Étiquettes de la ressource. Dictionnaire de noms et de valeurs d’étiquettes.
identité Informations d’identité pour la ressource Rubrique partenaire. IdentityInfo
properties Propriétés de la rubrique partenaire. PartnerTopicProperties

IdentityInfo

Nom Description Valeur
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. « SystemAssigned »
« SystemAssigned, UserAssigned »
« UserAssigned »
identity_ids Liste des identités utilisateur associées à la ressource. Les références de clé du dictionnaire d’identité utilisateur seront des ID de ressource ARM au format :
« /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».
Cette propriété n’est actuellement pas utilisée et réservée pour une utilisation ultérieure.
 Tableau d’ID d’identité utilisateur.

IdentityInfoUserAssignedIdentities

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

UserIdentityProperties

Nom Description Valeur
clientId ID client de l’identité affectée par l’utilisateur. string
principalId ID principal de l’identité affectée par l’utilisateur. string

PartnerTopicProperties

Nom Description Valeur
activationState État d’activation de la rubrique partenaire. « Activé »
« Désactivé »
« NeverActivated »
eventTypeInfo Informations sur le type d’événement du canal d’événements correspondant. EventTypeInfo
expirationTimeIfNotActivatedUtc Délai d’expiration de la rubrique partenaire. Si ce minuteur expire alors que la rubrique partenaire n’est toujours jamais activée,
la rubrique partenaire et le canal d’événements correspondant sont supprimés.		 string
messageForActivation Contexte ou message utile qui peut être utilisé pendant le processus d’approbation par l’abonné. string
partnerRegistrationImmutableId ImmutableId de l’inscription de partenaire correspondante. string

Contraintes :
Longueur minimale = 36
Longueur maximale = 36
Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
partnerTopicFriendlyDescription Description conviviale du sujet. Cela peut être défini par l’éditeur/partenaire pour afficher une description personnalisée pour la rubrique partenaire client.
Cela sera utile pour lever toute ambiguïté quant à l’origine de la création de la rubrique partenaire pour le client.		 string
source Source associée à cette rubrique partenaire. Il s’agit d’une ressource partenaire unique. 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