New-AzEventGridSubscription

Référence

Module:: Az.EventGrid

Crée de façon asynchrone un abonnement aux événements ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

Syntaxe

New-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   [-DeadLetterWithResourceIdentityType <String>]
   [-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
   [-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
   [-DeliveryWithResourceIdentityType <String>]
   [-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
   [-Destination <IEventSubscriptionDestination>]
   [-EventDeliverySchema <String>]
   [-ExpirationTimeUtc <DateTime>]
   [-FilterAdvancedFilter <IAdvancedFilter[]>]
   [-FilterEnableAdvancedFilteringOnArray]
   [-FilterIncludedEventType <String[]>]
   [-FilterIsSubjectCaseSensitive]
   [-FilterSubjectBeginsWith <String>]
   [-FilterSubjectEndsWith <String>]
   [-Label <String[]>]
   [-RetryPolicyEventTimeToLiveInMinute <Int32>]
   [-RetryPolicyMaxDeliveryAttempt <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventGridSubscription
   -InputObject <IEventGridIdentity>
   [-DeadLetterWithResourceIdentityType <String>]
   [-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
   [-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
   [-DeliveryWithResourceIdentityType <String>]
   [-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
   [-Destination <IEventSubscriptionDestination>]
   [-EventDeliverySchema <String>]
   [-ExpirationTimeUtc <DateTime>]
   [-FilterAdvancedFilter <IAdvancedFilter[]>]
   [-FilterEnableAdvancedFilteringOnArray]
   [-FilterIncludedEventType <String[]>]
   [-FilterIsSubjectCaseSensitive]
   [-FilterSubjectBeginsWith <String>]
   [-FilterSubjectEndsWith <String>]
   [-Label <String[]>]
   [-RetryPolicyEventTimeToLiveInMinute <Int32>]
   [-RetryPolicyMaxDeliveryAttempt <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Crée de façon asynchrone un abonnement aux événements ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

Exemples

Exemple 1 : crée de façon asynchrone un abonnement à un événement ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
New-AzEventGridSubscription -Name azps-eventsub -Scope "subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" -Destination $obj -FilterIsSubjectCaseSensitive:$false

Name          ResourceGroupName
----          -----------------
azps-eventsub

Crée de façon asynchrone un abonnement aux événements ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

Exemple 2 : crée de façon asynchrone un abonnement à un événement ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
$topic = Get-AzEventGridTopic -ResourceGroupName azps_test_group_eventgrid -Name azps-topic
New-AzEventGridSubscription -Name azps-eventsub -Scope $topic.Id -Destination $obj -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix"

Name          ResourceGroupName
----          -----------------
azps-eventsub azps_test_group_eventgrid

Crée de façon asynchrone un abonnement aux événements ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

Paramètres

-AsJob

Exécuter la commande en tant que travail

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

-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

-DeadLetterWithResourceIdentityType

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é.

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

-DeadLetterWithResourceIdentityUserAssignedIdentity

Identité de l’utilisateur associée à la ressource.

Type:	String
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

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Type:	PSObject
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

-DeliveryWithResourceIdentityDestination

Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise l’identité d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.

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

-DeliveryWithResourceIdentityType

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

-DeliveryWithResourceIdentityUserAssignedIdentity

Identité de l’utilisateur associée à la ressource.

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

-Destination

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

-EventDeliverySchema

Schéma de remise d’événements pour l’abonnement aux événements.

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

-ExpirationTimeUtc

Délai d’expiration de l’abonnement à l’événement.

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

-FilterAdvancedFilter

Tableau de filtres avancés utilisés pour filtrer les abonnements aux événements.

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

-FilterEnableAdvancedFilteringOnArray

Permet aux filtres avancés d’être évalués par rapport à un tableau de valeurs au lieu d’attendre une valeur singulière.

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

-FilterIncludedEventType

Liste des types d’événements applicables qui doivent faire partie de l’abonnement aux événements. Si vous souhaitez vous abonner à tous les types d’événements par défaut, définissez les IncludedEventTypes sur Null.

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

-FilterIsSubjectCaseSensitive

Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith des filtres doivent être comparées de manière sensible à la casse.

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

-FilterSubjectBeginsWith

Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin d’accès aux ressources. Le format de ce paramètre dépend de l’éditeur des événements. Les caractères génériques carte ne sont pas pris en charge dans ce chemin d’accès.

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

-FilterSubjectEndsWith

Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources. Les caractères génériques carte ne sont pas pris en charge dans ce chemin d’accès.

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

-InputObject

Paramètre d’identité

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

-JsonFilePath

Chemin d’accès du fichier Json fourni à l’opération Créer

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

-JsonString

Chaîne Json fournie à l’opération Create

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

-Label

Liste des étiquettes définies par l’utilisateur.

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

-Name

Nom de l’abonnement aux événements. Les noms d’abonnement aux événements doivent être compris entre 3 et 64 caractères et doivent utiliser uniquement des lettres alphanumériques.

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

-NoWait

Exécuter la commande de manière asynchrone

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

-PassThru

Retourne true lorsque la commande réussit

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

-RetryPolicyEventTimeToLiveInMinute

Time To Live (en minutes) pour les événements.

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

-RetryPolicyMaxDeliveryAttempt

Nombre maximal de tentatives de remise pour les événements.

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

-Scope

Identificateur de la ressource à laquelle l’abonnement à l’événement doit être créé ou mis à jour. L’étendue peut être un abonnement, un groupe de ressources ou une ressource de niveau supérieur appartenant à un espace de noms de fournisseur de ressources ou une rubrique EventGrid. Par exemple, utilisez « /subscriptions/{subscriptionId}/ » pour un abonnement, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pour un groupe de ressources, et « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » pour une ressource et « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName} » pour une rubrique EventGrid.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
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

IEventGridIdentity

Sorties

IEventSubscription

Partager via

New-AzEventGridSubscription

Syntaxe

Description

Exemples

Exemple 1 : crée de façon asynchrone un abonnement à un événement ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

Exemple 2 : crée de façon asynchrone un abonnement à un événement ou met à jour un abonnement à un événement existant en fonction de l’étendue spécifiée.

Paramètres

-AsJob

-Confirm

-DeadLetterWithResourceIdentityType

-DeadLetterWithResourceIdentityUserAssignedIdentity

-DefaultProfile

-DeliveryWithResourceIdentityDestination

-DeliveryWithResourceIdentityType

-DeliveryWithResourceIdentityUserAssignedIdentity

-Destination

-EventDeliverySchema

-ExpirationTimeUtc

-FilterAdvancedFilter

-FilterEnableAdvancedFilteringOnArray

-FilterIncludedEventType

-FilterIsSubjectCaseSensitive

-FilterSubjectBeginsWith

-FilterSubjectEndsWith

-InputObject

-JsonFilePath

-JsonString

-Label

-Name

-NoWait

-PassThru

-RetryPolicyEventTimeToLiveInMinute

-RetryPolicyMaxDeliveryAttempt

-Scope

-WhatIf

Entrées

Sorties

Ressources supplémentaires