New-AzEventGridSubscription

Syntaxe

CreateExpanded (Par défaut)

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>]

CreateViaJsonString

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

CreateViaJsonFilePath

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

CreateViaIdentityExpanded

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

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

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

Paramètres

-AsJob

Exécuter la commande en tant que travail

Propriétés du paramètre

Jeux de paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Jeux de paramètres

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

Propriétés du paramètre

Jeux de paramètres

-DeadLetterWithResourceIdentityUserAssignedIdentity

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

Propriétés du paramètre

Jeux de paramètres

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

Propriétés du paramètre

Jeux de paramètres

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

Propriétés du paramètre

Jeux de paramètres

-DeliveryWithResourceIdentityType

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

Propriétés du paramètre

Jeux de paramètres

-DeliveryWithResourceIdentityUserAssignedIdentity

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

Propriétés du paramètre

Jeux de paramètres

-Destination

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.

Propriétés du paramètre

Jeux de paramètres

-EventDeliverySchema

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

Propriétés du paramètre

Jeux de paramètres

-ExpirationTimeUtc

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

Propriétés du paramètre

Jeux de paramètres

-FilterAdvancedFilter

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

Propriétés du paramètre

Jeux de paramètres

-FilterEnableAdvancedFilteringOnArray

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

Propriétés du paramètre

Jeux de paramètres

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

Propriétés du paramètre

Jeux de paramètres

-FilterIsSubjectCaseSensitive

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

Propriétés du paramètre

Jeux de paramètres

-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 ne sont pas pris en charge dans ce chemin d’accès.

Propriétés du paramètre

Jeux de paramètres

-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 ne sont pas pris en charge dans ce chemin d’accès.

Propriétés du paramètre

Jeux de paramètres

-InputObject

Paramètre d’identité

Propriétés du paramètre

Jeux de paramètres

-JsonFilePath

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

Propriétés du paramètre

Jeux de paramètres

-JsonString

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

Propriétés du paramètre

Jeux de paramètres

-Label

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

Propriétés du paramètre

Jeux de paramètres

-Name

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

Propriétés du paramètre

Jeux de paramètres

-NoWait

Exécuter la commande de manière asynchrone

Propriétés du paramètre

Jeux de paramètres

-PassThru

Retourne true lorsque la commande réussit

Propriétés du paramètre

Jeux de paramètres

-RetryPolicyEventTimeToLiveInMinute

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

Propriétés du paramètre

Jeux de paramètres

-RetryPolicyMaxDeliveryAttempt

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

Propriétés du paramètre

Jeux de paramètres

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

Propriétés du paramètre

Jeux de paramètres

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Jeux de paramètres

CommonParameters

Entrées

IEventGridIdentity

Sorties

IEventSubscription