New-AzureRmEventGridSubscription

Référence

Module:: AzureRM.EventGrid

Crée un abonnement aux événements Azure Event Grid dans une rubrique, une ressource Azure, un abonnement Azure ou un groupe de ressources.

Avertissement

Le module AzureRM PowerShell a été officiellement déconseillé depuis le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Bien que le module AzureRM puisse toujours fonctionner, il n’est plus conservé ou pris en charge, plaçant toute utilisation continue à la discrétion et au risque de l’utilisateur. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntaxe

New-AzureRmEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [[-ResourceGroupName] <String>]
   [[-EndpointType] <String>]
   [[-SubjectBeginsWith] <String>]
   [[-SubjectEndsWith] <String>]
   [-SubjectCaseSensitive]
   [[-IncludedEventType] <String[]>]
   [[-Label] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzureRmEventGridSubscription
   [-ResourceId] <String>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [[-EndpointType] <String>]
   [[-SubjectBeginsWith] <String>]
   [[-SubjectEndsWith] <String>]
   [-SubjectCaseSensitive]
   [[-IncludedEventType] <String[]>]
   [[-Label] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzureRmEventGridSubscription
   [-InputObject] <PSTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [[-EndpointType] <String>]
   [[-SubjectBeginsWith] <String>]
   [[-SubjectEndsWith] <String>]
   [-SubjectCaseSensitive]
   [[-IncludedEventType] <String[]>]
   [[-Label] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzureRmEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-TopicName] <String>
   [[-EndpointType] <String>]
   [[-SubjectBeginsWith] <String>]
   [[-SubjectEndsWith] <String>]
   [-SubjectCaseSensitive]
   [[-IncludedEventType] <String[]>]
   [[-Label] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Créez un abonnement aux événements à une rubrique Azure Event Grid, une ressource Azure prise en charge, un abonnement Azure ou un groupe de ressources. Pour créer un abonnement aux événements à l’abonnement Azure actuellement sélectionné, spécifiez le nom de l’abonnement à l’événement et le point de terminaison de destination. Pour créer un abonnement aux événements à un groupe de ressources, spécifiez le nom du groupe de ressources en plus du nom de l’abonnement à l’événement et du point de terminaison de destination. Pour créer un abonnement aux événements à une rubrique Azure Event Grid, spécifiez également le nom de la rubrique. Pour créer un abonnement aux événements à une ressource Azure prise en charge, spécifiez l’ID de ressource complet de la ressource. Pour afficher la liste des types pris en charge, exécutez l’applet de commande Get-AzureRmEventGridTopicType.

Exemples

Exemple 1

PS C:\> New-AzureRmEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Crée un abonnement aux événements « EventSubscription1 » à une rubrique Azure Event Grid « Topic1 » dans le groupe de ressources « MyResourceGroupName » avec le point de terminaison https://requestb.in/19qlscd1de destination du webhook. Cet abonnement aux événements utilise des filtres par défaut.

Exemple 2

PS C:\> New-AzureRmEventGridSubscription -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Crée un abonnement aux événements « EventSubscription1 » à un groupe de ressources « MyResourceGroupName » avec le point de terminaison https://requestb.in/19qlscd1de destination du webhook. Cet abonnement aux événements utilise des filtres par défaut.

Exemple 3

PS C:\> New-AzureRmEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Exemple 4

PS C:\> $includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess"
PS C:\> $labels = "Finance", "HR"
PS C:\> New-AzureRmEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels

Crée un abonnement d’événement « EventSubscription1 » à l’abonnement Azure actuellement sélectionné avec le point de terminaison https://requestb.in/19qlscd1de destination du webhook. Cet abonnement aux événements spécifie les filtres supplémentaires pour les types d’événements et l’objet, et seuls les événements correspondant à ces filtres sont remis au point de terminaison de destination.

Exemple 5

PS C:\> New-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"

Crée un abonnement d’événement « EventSubscription1 » à l’abonnement Azure actuellement sélectionné avec le hub d’événements spécifié comme destination pour les événements. Cet abonnement aux événements utilise des filtres par défaut.

Exemple 6

PS C:\> New-AzureRmEventGridSubscription -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Crée un abonnement d’événement « EventSubscription1 » à un espace de noms EventHub avec le point de terminaison https://requestb.in/19qlscd1de destination webhhok spécifié. Cet abonnement aux événements utilise des filtres par défaut.

Paramètres

-Confirm

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

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Alias:	AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	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.

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-EndpointType

Type de point de terminaison. Il peut s’agir d’un webhook ou d’eventhub

Type:	String
Valeurs acceptées:	webhook, eventhub, webhook, eventhub
Position:	4
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-EventSubscriptionName

Nom de l’abonnement aux événements

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	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:	7
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-InputObject

Objet EventGrid Topic.

Type:	PSTopic
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Label

Étiquettes pour l’abonnement aux événements

Type:	String[]
Position:	8
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceGroupName

Groupe de ressources de la rubrique.

Type:	String
Alias:	ResourceGroup
Position:	2
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceId

Identificateur de la ressource à laquelle l’abonnement à l’événement doit être créé.

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	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:	5
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SubjectCaseSensitive

Filtre qui spécifie que le champ objet doit être comparé de manière sensible à la casse. S’il n’est pas spécifié, le sujet sera comparé de manière insensible à la casse.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	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:	6
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-TopicName

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

Type:	String
Position:	3
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	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
Alias:	wi
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

String

PSTopic

Paramètres : InputObject (ByValue)

String[]

Sorties

PSEventSubscription

Partager via