New-AzEventGridSubscription

Módulo:

Az.EventGrid

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.

Sintaxis

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

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.

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

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.

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

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.

Parámetros

-AsJob

Ejecución del comando como trabajo

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:	SwitchParameter
Alias:	cf
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Identidad de usuario asociada al recurso.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-DefaultProfile

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

Tipo:	PSObject
Alias:	AzureRMContext, AzureCredential
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	IEventSubscriptionDestination
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-DeliveryWithResourceIdentityUserAssignedIdentity

Identidad de usuario asociada al recurso.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	IEventSubscriptionDestination
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-EventDeliverySchema

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

Tipo:	String
Alias:	DeliverySchema
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-ExpirationTimeUtc

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

Tipo:	DateTime
Alias:	ExpirationDate
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-FilterAdvancedFilter

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

Tipo:	IAdvancedFilter[]
Alias:	AdvancedFilter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-FilterEnableAdvancedFilteringOnArray

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

Tipo:	SwitchParameter
Alias:	AdvancedFilteringOnArray
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String[]
Alias:	IncludedEventType
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-FilterIsSubjectCaseSensitive

Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith de los filtros se deben comparar de forma confidencial entre mayúsculas y minúsculas.

Tipo:	SwitchParameter
Alias:	SubjectCaseSensitive
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Alias:	SubjectBeginsWith
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Alias:	SubjectEndsWith
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-InputObject

Parámetro de identidad

Tipo:	IEventGridIdentity
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-JsonFilePath

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

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-JsonString

Cadena JSON proporcionada a la operación Create

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Label

Lista de etiquetas definidas por el usuario.

Tipo:	String[]
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Alias:	EventSubscriptionName
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-NoWait

Ejecutar el comando de forma asincrónica

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-PassThru

Devuelve true cuando el comando se ejecuta correctamente.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-RetryPolicyEventTimeToLiveInMinute

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

Tipo:	Int32
Alias:	EventTtl
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-RetryPolicyMaxDeliveryAttempt

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

Tipo:	Int32
Alias:	MaxDeliveryAttempt
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

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

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-WhatIf

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

Tipo:	SwitchParameter
Alias:	wi
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

Entradas

IEventGridIdentity

Salidas

IEventSubscription