New-AzEventGridSubscription

Cria uma nova Assinatura de Evento de Grade de Eventos do Azure para um tópico, recurso do Azure, assinatura do Azure ou 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

Crie uma nova assinatura de evento para um tópico da Grade de Eventos do Azure, um recurso do Azure com suporte, uma assinatura do Azure ou um Grupo de Recursos. Para criar uma assinatura de evento para a assinatura do Azure selecionada no momento, especifique o nome da assinatura do evento e o ponto de extremidade de destino. Para criar uma assinatura de evento para um grupo de recursos, especifique o nome do grupo de recursos, além do nome da assinatura do evento e do ponto de extremidade de destino. Para criar uma assinatura de evento para um tópico da Grade de Eventos do Azure, especifique também o nome do tópico. Para criar uma assinatura de evento para um recurso do Azure com suporte, especifique a ID de recurso completa do recurso. Para exibir a lista de tipos com suporte, execute o cmdlet Get-AzEventGridTopicType.

Exemplos

Exemplo 1

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

Cria uma nova assinatura de evento 'EventSubscription1' para um tópico da Grade de Eventos do Azure 'Topic1' no grupo de recursos 'MyResourceGroupName' com o ponto de extremidade https://requestb.in/19qlscd1de destino do webhook. Essa assinatura de evento usa filtros padrão.

Exemplo 2

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

Cria uma nova assinatura de evento 'EventSubscription1' para um grupo de recursos 'MyResourceGroupName' com o ponto de extremidade https://requestb.in/19qlscd1de destino do webhook . Essa assinatura de evento usa filtros padrão.

Exemplo 3

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

Cria uma nova assinatura de evento 'EventSubscription1' para a assinatura do Azure selecionada no momento com o ponto de extremidade https://requestb.in/19qlscd1de destino do webhook. Essa assinatura de evento usa filtros padrão.

Exemplo 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

Cria uma nova assinatura de evento 'EventSubscription1' para a assinatura do Azure selecionada no momento com o ponto de extremidade https://requestb.in/19qlscd1de destino do webhook. Esta assinatura de evento especifica os filtros adicionais para tipos de evento e assunto, e somente os eventos correspondentes a esses filtros serão entregues ao ponto de extremidade de destino.

Exemplo 5

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

Cria uma nova assinatura de evento 'EventSubscription1' para a assinatura do Azure atualmente selecionada com o hub de eventos especificado como destino para eventos. Essa assinatura de evento usa filtros padrão.

Exemplo 6

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

Cria uma nova assinatura de evento 'EventSubscription1' para um namespace EventHub com o ponto de extremidade https://requestb.in/19qlscd1de destino webhook especificado. Essa assinatura de evento usa filtros padrão.

Parâmetros

-AdvancedFilter

Filtro avançado que especifica uma matriz de vários valores de Hashtable que são usados para a filtragem baseada em atributos. Cada valor de Hashtable tem as seguintes informações de chave-valor: Operação, Chave e Valor ou Valores. O operador pode ser um dos seguintes valores: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith ou StringContains. Key representa a propriedade de carga útil onde as políticas de filtragem avançadas são aplicadas. Finalmente, Valor ou Valores representam o valor ou conjunto de valores a serem correspondidos. Isso pode ser um único valor do tipo correspondente ou uma matriz de valores. Como exemplo dos parâmetros de filtro avançados: $AdvancedFilters=@($AdvFilter 1, $AdvFilter 2) onde $AdvFilter 1=@{operator="NumberIn"; key="Data.Key1"; Valores=@(1,2)} e $AdvFilter 2=@{operator="StringBringsWith"; key="Assunto"; Values=@("SubjectPrefix1","SubjectPrefix2")}

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

-AdvancedFilteringOnArray

A presença desse parâmetro indica que a filtragem avançada em matrizes está habilitada

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

-AzureActiveDirectoryApplicationIdOrUri

O Microsoft Entra Application Id ou Uri para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável apenas para webhook como destino.

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

-AzureActiveDirectoryTenantId

A ID do locatário do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável apenas para webhook como destino.

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

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-DeadLetterEndpoint

O ponto de extremidade usado para armazenar eventos não entregues. Especifique a ID de recurso do Azure de um contêiner de blob de armazenamento. Por exemplo: /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

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

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

-DeliveryAttributeMapping

Os mapeamentos de atributo de entrega para esta assinatura de evento de tópico do sistema. Cada mapeamento de atributo de entrega deve conter dois campos obrigatórios a seguir: Nome e Tipo. O Tipo pode ser 'Estático' ou 'Dinâmico'. Se o tipo for 'Static', as propriedades 'Value' e 'IsSecret' são necessárias. Se o tipo for 'Dynamic', a propriedade 'SourceField' será necessária. Um exemplo dos parâmetros DynamicAttributeMapping: $DeliveryAttributeMapping=@($DeliveryAttributeMapping 1, $DeliveryAttributeMapping 2) onde $DeliveryAttributeMapping 1=@{Name="Name1"; Type="Estático"; Valores="valor"; IsSecret="false"} e $DeliveryAttributeMapping 2=@{Name="Name2"; Tipo="Dinâmico"; SourceField="data.prop1"}

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

-DeliverySchema

O esquema a ser usado ao entregar eventos para o destino. Os valores possíveis são: eventgridschema, CustomInputSchema ou cloudeventv01schema. O valor padrão é 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 EventGrid Domain.

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

-DomainName

O nome do domínio da Grade de Eventos para o qual a assinatura do evento deve ser criada.

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

-DomainTopicInputObject

Objeto Tópico de domínio EventGrid.

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

-DomainTopicName

O nome do tópico de domínio para o qual a assinatura do evento deve ser criada.

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

-Endpoint

Ponto de extremidade de destino da assinatura do evento. Isso pode ser uma URL de webhook ou a ID de recurso do Azure de um EventHub, fila de armazenamento, conexão híbrida ou servicebusqueue. Por exemplo, a ID do recurso para uma conexão híbrida assume a seguinte forma: /subscriptions/[ID de Assinatura do Azure]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]. Espera-se que o ponto de extremidade de destino seja criado e esteja disponível para uso antes de executar qualquer cmdlet de Grade de Eventos.

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

-EndpointType

Tipo de ponto de extremidade. Isso pode ser webhook, eventhub, storagequeue, hybridconnection ou servicebusqueue. O valor padrão é 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

O nome da assinatura de evento

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

-EventTtl

O tempo em minutos para a entrega do evento. Esse valor deve estar entre 1 e 1440

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

-ExpirationDate

Determina a expiração DateTime para a assinatura do evento após o qual a assinatura do evento será desativada.

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

-IncludedEventType

Filtro que especifica uma lista de tipos de eventos a serem incluídos. Se não for especificado, todos os tipos de evento serão incluídos.

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

Rótulos para a assinatura do evento

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

-MaxDeliveryAttempt

O número máximo de tentativas de entregar o evento. Esse valor deve estar entre 1 e 30

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

-MaxEventsPerBatch

O número máximo de eventos em um lote. Esse valor deve estar entre 1 e 5000. Esse parâmetro é válido quando Endpint Type é somente webhook.

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

-PreferredBatchSizeInKiloByte

O tamanho de lote preferencial em quilobytes. Esse valor deve estar entre 1 e 1024. Esse parâmetro é válido quando Endpint Type é somente webhook.

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

-ResourceGroupName

O grupo de recursos do tópico.

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

-ResourceId

O identificador do recurso para o qual a assinatura de evento deve ser criada.

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

-StorageQueueMessageTtl

O tempo, em milissegundos, de uma mensagem de fila de armazenamento

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

-SubjectBeginsWith

Filtro que especifica que somente eventos correspondentes ao prefixo de assunto especificado serão incluídos. Se não for especificado, eventos com todos os prefixos de assunto serão incluídos.

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

-SubjectCaseSensitive

Filtro que especifica que o campo de assunto deve ser comparado de maneira sensível a maiúsculas e minúsculas. Se não for especificado, o assunto será comparado de maneira que não diferencie maiú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 somente eventos correspondentes ao sufixo de assunto especificado serão incluídos. Se não for especificado, eventos com todos os sufixos de assunto serão incluídos.

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

-TopicName

O nome do tópico para o qual a assinatura do evento deve ser criada.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Saídas

PSEventSubscription