New-AzEventGridSubscription

Sintaxis

CreateExpanded (valor predeterminado)

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

Ejemplos

Ejemplo 1: Crea de forma asincrónica una nueva suscripción de eventos o actualiza una suscripción de eventos existente en función del ámbito especificado.

$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

Ejemplo 2: Crea de forma asincrónica una nueva suscripción de eventos o actualiza una suscripción de eventos existente en función del ámbito especificado.

$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

Parámetros

-AsJob

Ejecución del comando como trabajo

Propiedades de parámetro

Conjuntos de parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades de parámetro

Conjuntos de parámetros

-DeadLetterWithResourceIdentityType

Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.

Propiedades de parámetro

Conjuntos de parámetros

-DeadLetterWithResourceIdentityUserAssignedIdentity

Identidad de usuario asociada al recurso.

Propiedades de parámetro

Conjuntos de parámetros

-DefaultProfile

El parámetro DefaultProfile no es funcional. Use el parámetro SubscriptionId cuando esté disponible si ejecuta el cmdlet en otra suscripción.

Propiedades de parámetro

Conjuntos de parámetros

-DeliveryWithResourceIdentityDestination

Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.

Propiedades de parámetro

Conjuntos de parámetros

-DeliveryWithResourceIdentityType

Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.

Propiedades de parámetro

Conjuntos de parámetros

-DeliveryWithResourceIdentityUserAssignedIdentity

Identidad de usuario asociada al recurso.

Propiedades de parámetro

Conjuntos de parámetros

-Destination

Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o mensajes fallidos.

Propiedades de parámetro

Conjuntos de parámetros

-EventDeliverySchema

Esquema de entrega de eventos para la suscripción de eventos.

Propiedades de parámetro

Conjuntos de parámetros

-ExpirationTimeUtc

Hora de expiración de la suscripción de eventos.

Propiedades de parámetro

Conjuntos de parámetros

-FilterAdvancedFilter

Matriz de filtros avanzados que se usan para filtrar suscripciones de eventos.

Propiedades de parámetro

Conjuntos de parámetros

-FilterEnableAdvancedFilteringOnArray

Permite evaluar filtros avanzados en una matriz de valores en lugar de esperar un valor singular.

Propiedades de parámetro

Conjuntos de parámetros

-FilterIncludedEventType

Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos predeterminados, establezca IncludedEventTypes en null.

Propiedades de parámetro

Conjuntos de parámetros

-FilterIsSubjectCaseSensitive

Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro deben compararse de una manera que distingue mayúsculas de minúsculas.

Propiedades de parámetro

Conjuntos de parámetros

-FilterSubjectBeginsWith

Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso. El formato de esto depende del publicador de los eventos. Los caracteres comodín no se admiten en esta ruta de acceso.

Propiedades de parámetro

Conjuntos de parámetros

-FilterSubjectEndsWith

Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso. Los caracteres comodín no se admiten en esta ruta de acceso.

Propiedades de parámetro

Conjuntos de parámetros

-InputObject

Parámetro de identidad

Propiedades de parámetro

Conjuntos de parámetros

-JsonFilePath

Ruta de acceso del archivo Json proporcionado a la operación Create

Propiedades de parámetro

Conjuntos de parámetros

-JsonString

Cadena JSON proporcionada a la operación Create

Propiedades de parámetro

Conjuntos de parámetros

-Label

Lista de etiquetas definidas por el usuario.

Propiedades de parámetro

Conjuntos de parámetros

-Name

Nombre de la suscripción de eventos. Los nombres de suscripción de eventos deben tener entre 3 y 64 caracteres de longitud y solo deben usar letras alfanuméricas.

Propiedades de parámetro

Conjuntos de parámetros

-NoWait

Ejecutar el comando de forma asincrónica

Propiedades de parámetro

Conjuntos de parámetros

-PassThru

Devuelve true cuando el comando se ejecuta correctamente.

Propiedades de parámetro

Conjuntos de parámetros

-RetryPolicyEventTimeToLiveInMinute

Período de vida (en minutos) para eventos.

Propiedades de parámetro

Conjuntos de parámetros

-RetryPolicyMaxDeliveryAttempt

Número máximo de reintentos de entrega para eventos.

Propiedades de parámetro

Conjuntos de parámetros

-Scope

Identificador del recurso al que se debe crear o actualizar la suscripción de eventos. El ámbito puede ser una suscripción, un grupo de recursos o un recurso de nivel superior que pertenezca a un espacio de nombres del proveedor de recursos o un tema de EventGrid. Por ejemplo, use '/subscriptions/{subscriptionId}/' para una suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para un grupo de recursos, y '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para un recurso y '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para un tema de EventGrid.

Propiedades de parámetro

Conjuntos de parámetros

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Propiedades de parámetro

Conjuntos de parámetros

CommonParameters

Entradas

IEventGridIdentity

Salidas

IEventSubscription