Update-AzEventGridSubscription

  • Référence
Module:
Az.EventGrid

Mise à jour des propriétés d’un abonnement aux événements Event Grid.

Syntax

Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [[-ResourceGroupName] <String>]
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-ResourceId] <String>
      [-EventSubscriptionName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-InputObject] <PSEventSubscription>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-TopicName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-DomainName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-DomainName] <String>
      [-DomainTopicName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Mise à jour des propriétés d’un abonnement aux événements Event Grid. Cela peut être utilisé pour mettre à jour le filtre, la destination ou les étiquettes d’un abonnement à un événement existant.

Exemples

Exemple 1

Update-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1

Mises à jour le point de terminaison de l’abonnement aux événements « ES1 » pour la rubrique « Topic1 » dans le groupe de ressources « MyResourceGroupName » sur «https://requestb.in/1kxxoui1 »

Exemple 2

Get-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName | Update-AzEventGridSubscription -Endpoint https://requestb.in/1kxxoui1

Mises à jour le point de terminaison de l’abonnement aux événements « ES1 » pour la rubrique « Topic1 » dans le groupe de ressources « MyResourceGroupName » sur «https://requestb.in/1kxxoui1 »

Exemple 3

Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg"

Mises à jour les propriétés de l’abonnement aux événements « ES1 » pour l’espace de noms EventHub ContosoNamespace avec le nouveau point de terminaison en tant que «https://requestb.in/1kxxoui1 » et le nouveau filtre SubjectEndsWith en tant que « jpg »

Exemple 4

$labels = "Finance", "HR"
Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceGroup MyResourceGroupName -Label $labels

Mises à jour les propriétés de l’abonnement aux événements « ES1 » pour le groupe de ressources « MyResourceGroupName » avec les nouvelles étiquettes $labels.

Paramètres

-AdvancedFilter

Filtre avancé qui spécifie un tableau de plusieurs valeurs de table de hachage utilisées pour le filtrage basé sur les attributs. Chaque valeur de table de hachage contient les informations clés-valeur suivantes : Opération, Clé et Valeur ou Valeurs. L’opérateur peut être l’une des valeurs suivantes : NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith ou StringContains. La clé représente la propriété de charge utile dans laquelle les stratégies de filtrage avancées sont appliquées. Enfin, La valeur ou les valeurs représentent la valeur ou l’ensemble de valeurs à mettre en correspondance. Il peut s’agir d’une valeur unique du type correspondant ou d’un tableau de valeurs. Par exemple, les paramètres de filtre avancés : $AdvancedFilters=@($AdvFilter 1, $AdvFilter 2) où $AdvFilter 1=@{operator="NumberIn » ; key="Data.Key1 » ; Values=@(1,2)} et $AdvFilter 2=@{operator="StringBeginsWith » ; key="Subject » ; Values=@(« SubjectPrefix1 »,"SubjectPrefix2 »)}

Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AzureActiveDirectoryApplicationIdOrUri

ID d’application microsoft Entra ou URI pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise. Applicable uniquement pour le webhook comme destination.

Type:String
Aliases:AliasAadAppIdUri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AzureActiveDirectoryTenantId

ID de locataire Microsoft Entra pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise. Applicable uniquement pour le webhook comme destination.

Type:String
Aliases:AliasAadTenantId
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadLetterEndpoint

Point de terminaison utilisé pour stocker des événements non remis. Spécifiez l’ID de ressource Azure d’un conteneur d’objets blob Stockage. Par exemple : /subscriptions/[SubscriptionId]/resourceGroups/[ResourceGroupName]/providers/Microsoft. Stockage/storageAccounts/[Stockage AccountName]/blobServices/default/containers/[ContainerName].

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryAttributeMapping

Mappages d’attributs de remise pour cet abonnement aux événements de rubrique système. Chaque mappage d’attributs de remise doit contenir les deux champs obligatoires suivants : Nom et Type. Le type peut être « Statique » ou « Dynamique ». Si le type est « Static », les propriétés « Value » et « IsSecret » sont requises. Si le type est « Dynamic », la propriété « SourceField » est requise. Exemple des paramètres DynamicAttributeMapping : $DeliveryAttributeMapping=@($DeliveryAttributeMapping 1, $DeliveryAttributeMapping 2) où $DeliveryAttributeMapping 1=@{Name="Name1 » ; Type="Static » ; Values="value » ; IsSecret="false"} et $DeliveryAttributeMapping 2=@{Name="Name2 » ; Type="Dynamic » ; SourceField="data.prop1"}

Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DomainName

Nom du domaine auquel l’abonnement à l’événement doit être créé.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DomainTopicName

Nom de la rubrique de domaine à laquelle l’abonnement aux événements doit être créé.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Endpoint

Point de terminaison de destination de l’abonnement aux événements. Il peut s’agir d’une URL de webhook ou de l’ID de ressource Azure d’un EventHub, d’une file d’attente de stockage, d’une connexion hybride ou d’un servicebusqueue. Par exemple, l’ID de ressource d’une connexion hybride prend la forme suivante : /subscriptions/[ID d’abonnement Azure]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybrid Connecter ions/[Hybrid Connecter ionName]. Il est prévu que le point de terminaison de destination soit créé et disponible pour une utilisation avant d’exécuter des applets de commande Event Grid.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndpointType

Type de point de terminaison. Il peut s’agir de webhook, eventhub, storagequeue, hybridconnection ou servicebusqueue. La valeur par défaut est webhook.

Type:String
Accepted values:webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventSubscriptionName

Nom de l’abonnement aux événements

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-EventTtl

Heure en minutes de la remise de l’événement. Cette valeur doit être comprise entre 1 et 1440

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpirationDate

Détermine l’expiration de DateTime pour l’abonnement à l’événement après lequel l’abonnement à l’événement sera mis hors service.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludedEventType

Filtre qui spécifie une liste de types d’événements à inclure. Si ce n’est pas spécifié, tous les types d’événements sont inclus.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Objet EventGridSubscription.

Type:PSEventSubscription
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Label

Étiquettes pour l’abonnement aux événements

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxDeliveryAttempt

Nombre maximal de tentatives de remise de l’événement. Cette valeur doit être comprise entre 1 et 30

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxEventsPerBatch

Nombre maximal d’événements dans un lot. Cette valeur doit être comprise entre 1 et 5 000. Ce paramètre est valide lorsque le type Endpint est webhook uniquement.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PreferredBatchSizeInKiloByte

Taille de lot préférée en kilo-octets. Cette valeur doit être comprise entre 1 et 1024. Ce paramètre est valide lorsque le type Endpint est webhook uniquement.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Groupe de ressources de la rubrique.

Type:String
Aliases:ResourceGroup
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Identificateur de la ressource à laquelle l’abonnement à l’événement a été créé.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SubjectBeginsWith

Filtre qui spécifie que seuls les événements correspondant au préfixe d’objet spécifié sont inclus. Si ce n’est pas spécifié, les événements avec tous les préfixes d’objet sont inclus.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubjectEndsWith

Filtre qui spécifie que seuls les événements correspondant au suffixe d’objet spécifié sont inclus. S’il n’est pas spécifié, les événements avec tous les suffixes d’objet sont inclus.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TopicName

Nom de la rubrique à laquelle l’abonnement à l’événement doit être créé.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

String

PSEventSubscription

Sorties

PSEventSubscription