New-AzEventGridSubscription

Crea una nueva suscripción de eventos de Azure Event Grid a un tema, un recurso de Azure, una suscripción de Azure o un grupo de recursos.

Syntax

New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [[-ResourceGroupName] <String>]
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-ResourceId] <String>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-InputObject] <PSTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-DomainInputObject] <PSDomain>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-DomainTopicInputObject] <PSDomainTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-TopicName] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-DomainName] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-DomainName] <String>
   -DomainTopicName <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <Hashtable[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cree una nueva suscripción de eventos a un tema de Azure Event Grid, un recurso de Azure compatible, una suscripción de Azure o un grupo de recursos. Para crear una suscripción de eventos a la suscripción de Azure seleccionada actualmente, especifique el nombre de la suscripción de eventos y el punto de conexión de destino. Para crear una suscripción de eventos a un grupo de recursos, especifique el nombre del grupo de recursos además del nombre de la suscripción de eventos y el punto de conexión de destino. Para crear una suscripción de eventos a un tema de Azure Event Grid, especifique también el nombre del tema. Para crear una suscripción de eventos a un recurso de Azure compatible, especifique el identificador de recurso completo del recurso. Para ver la lista de tipos admitidos, ejecute el cmdlet Get-AzEventGridTopicType.

Ejemplos

Ejemplo 1

New-AzEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Crea una nueva suscripción de eventos "EventSubscription1" a un tema de Azure Event Grid "Topic1" en el grupo de recursos "MyResourceGroupName" con el punto de conexión https://requestb.in/19qlscd1de destino de webhook . Esta suscripción de eventos usa filtros predeterminados.

Ejemplo 2

New-AzEventGridSubscription -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Crea una nueva suscripción de eventos "EventSubscription1" a un grupo de recursos "MyResourceGroupName" con el punto de conexión https://requestb.in/19qlscd1de destino de webhook . Esta suscripción de eventos usa filtros predeterminados.

Ejemplo 3

New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

Crea una nueva suscripción de eventos "EventSubscription1" a la suscripción de Azure seleccionada actualmente con el punto de conexión https://requestb.in/19qlscd1de destino de webhook . Esta suscripción de eventos usa filtros predeterminados.

Ejemplo 4

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

Crea una nueva suscripción de eventos "EventSubscription1" a la suscripción de Azure seleccionada actualmente con el punto de conexión https://requestb.in/19qlscd1de destino de webhook . Esta suscripción de eventos especifica los filtros adicionales para los tipos de eventos y el asunto, y solo los eventos que coinciden con esos filtros se entregarán al punto de conexión de destino.

Ejemplo 5

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

Crea una nueva suscripción de eventos "EventSubscription1" a la suscripción de Azure seleccionada actualmente con el centro de eventos especificado como destino para los eventos. Esta suscripción de eventos usa filtros predeterminados.

Ejemplo 6

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

Crea una nueva suscripción de eventos "EventSubscription1" a un espacio de nombres de EventHub con el punto de conexión https://requestb.in/19qlscd1de destino de webhook especificado. Esta suscripción de eventos usa filtros predeterminados.

Parámetros

-AdvancedFilter

Filtro avanzado que especifica una matriz de varios valores hashtable que se usan para el filtrado basado en atributos. Cada valor hashtable tiene la siguiente información de clave-valor: Operación, Clave y Valor o Valores. Operator puede ser uno de los siguientes valores: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith o StringContains. Clave representa la propiedad de carga donde se aplican las directivas de filtrado avanzadas. Por último, Value o Values representan el valor o conjunto de valores que se van a coincidir. Puede ser un valor único del tipo correspondiente o una matriz de valores. Como ejemplo de los parámetros de filtro avanzados: $AdvancedFilters=@($AdvFilter 1, $AdvFilter 2) donde $AdvFilter 1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} y $AdvFilter 2=@{operator="StringBringsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")}

Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdvancedFilteringOnArray

La presencia de este parámetro indica que el filtrado avanzado en matrices está habilitado.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureActiveDirectoryApplicationIdOrUri

Identificador de aplicación o URI de Microsoft Entra para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. Solo se aplica al webhook como destino.

Type:String
Aliases:AliasAadAppIdUri
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureActiveDirectoryTenantId

Identificador de inquilino de Microsoft Entra para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. Solo se aplica al webhook como destino.

Type:String
Aliases:AliasAadTenantId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadLetterEndpoint

Punto de conexión usado para almacenar eventos no entregados. Especifique el identificador de recurso de Azure de un contenedor de blobs de Storage. Por ejemplo: /subscriptions/[SubscriptionId]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Storage/storageAccounts/[StorageAccountName]/blobServices/default/containers/[ContainerName].

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryAttributeMapping

Asignaciones de atributos de entrega para esta suscripción de eventos del tema del sistema. Cada asignación de atributos de entrega debe contener dos campos obligatorios: Nombre y Tipo. El tipo puede ser "Estático" o "Dinámico". Si el tipo es "Static", se requieren las propiedades "Value" y "IsSecret". Si el tipo es "Dinámico", se requiere la propiedad "SourceField". Ejemplo de los parámetros DynamicAttributeMapping: $DeliveryAttributeMapping=@($DeliveryAttributeMapping 1, $DeliveryAttributeMapping 2) donde $DeliveryAttributeMapping 1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} y $DeliveryAttributeMapping 2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"}

Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DeliverySchema

Esquema que se va a usar al entregar eventos al destino. Los valores posibles son: eventgridschema, CustomInputSchema o cloudeventv01schema. El valor predeterminado es CustomInputSchema.

Type:String
Accepted values:EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0, EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DomainInputObject

Objeto Domain de EventGrid.

Type:PSDomain
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DomainName

Nombre del dominio de Event Grid al que se debe crear la suscripción de eventos.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DomainTopicInputObject

Objeto EventGrid Domain Topic.

Type:PSDomainTopic
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DomainTopicName

Nombre del tema de dominio al que se debe crear la suscripción de eventos.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Endpoint

Punto de conexión de destino de la suscripción de eventos. Puede ser una dirección URL de webhook o el identificador de recurso de Azure de eventHub, cola de almacenamiento, hybridconnection o servicebusqueue. Por ejemplo, el identificador de recurso de una conexión híbrida tiene el siguiente formato: /subscriptions/[Id. de suscripción de Azure]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybrid Conectar ions/[Hybrid Conectar ionName]. Se espera que el punto de conexión de destino se cree y esté disponible para su uso antes de ejecutar los cmdlets de Event Grid.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-EndpointType

Tipo de punto de conexión. Puede ser webhook, eventhub, storagequeue, hybridconnection o servicebusqueue. El valor predeterminado es webhook.

Type:String
Accepted values:webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction, webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EventSubscriptionName

El nombre de la suscripción de eventos

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-EventTtl

Tiempo en minutos para la entrega del evento. Este valor debe estar comprendido entre 1 y 1440.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExpirationDate

Determina la fecha de expiración de la suscripción de eventos después de la cual se retirará la suscripción de eventos.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludedEventType

Filtro que especifica una lista de tipos de eventos que se van a incluir. Si no se especifica, se incluirán todos los tipos de eventos.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Objeto EventGrid Topic.

Type:PSTopic
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Label

Etiquetas para la suscripción de eventos

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxDeliveryAttempt

Número máximo de intentos para entregar el evento. Este valor debe estar comprendido entre 1 y 30.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxEventsPerBatch

Número máximo de eventos en un lote. Este valor debe estar comprendido entre 1 y 5000. Este parámetro es válido cuando El tipo endpint solo es webhook.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PreferredBatchSizeInKiloByte

Tamaño de lote preferido en kilobytes. Este valor debe estar comprendido entre 1 y 1024. Este parámetro es válido cuando El tipo endpint solo es webhook.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

El grupo de recursos del tema.

Type:String
Aliases:ResourceGroup
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Identificador del recurso al que se debe crear la suscripción de eventos.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageQueueMessageTtl

El tiempo en milisegundos para que el período de vida de un mensaje de cola de almacenamiento

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubjectBeginsWith

Filtro que especifica que solo se incluirán los eventos que coincidan con el prefijo de asunto especificado. Si no se especifica, se incluirán eventos con todos los prefijos de asunto.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubjectCaseSensitive

Filtro que especifica que el campo de asunto se debe comparar de forma confidencial entre mayúsculas y minúsculas. Si no se especifica, el asunto se comparará de forma no distingue mayúsculas de minúsculas.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubjectEndsWith

Filtro que especifica que solo se incluirán los eventos que coincidan con el sufijo de asunto especificado. Si no se especifica, se incluirán eventos con todos los sufijos del firmante.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TopicName

Nombre del tema al que se debe crear la suscripción de eventos.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

PSTopic

PSDomain

PSDomainTopic

String[]

Int32

Salidas

PSEventSubscription