Update-AzEventGridSubscription

Referência

Módulo:: Az.EventGrid

Atualize as propriedades de uma subscrição de eventos do Event Grid.

Syntax

Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [[-ResourceGroupName] <String>]
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzEventGridSubscription
      [-ResourceId] <String>
      [-EventSubscriptionName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzEventGridSubscription
      [-InputObject] <PSEventSubscription>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-TopicName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-DomainName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-DomainName] <String>
      [-DomainTopicName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Atualize as propriedades de uma subscrição de eventos do Event Grid. Isso pode ser usado para atualizar o filtro, o destino ou os rótulos de uma assinatura de evento existente.

Exemplos

Exemplo 1

Update-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1

Atualiza o ponto de extremidade da assinatura de evento 'ES1' para o tópico 'Topic1' no grupo de recursos 'MyResourceGroupName' para 'https://requestb.in/1kxxoui1'

Exemplo 2

Get-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName | Update-AzEventGridSubscription -Endpoint https://requestb.in/1kxxoui1

Atualiza o ponto de extremidade da assinatura de evento 'ES1' para o tópico 'Topic1' no grupo de recursos 'MyResourceGroupName' para 'https://requestb.in/1kxxoui1'

Exemplo 3

Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg"

Atualiza as propriedades da assinatura de evento 'ES1' para o namespace ContosoNamespace do EventHub com o novo ponto de extremidade como 'https://requestb.in/1kxxoui1' e o novo filtro SubjectEndsWith como 'jpg'

Exemplo 4

$labels = "Finance", "HR"
Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceGroup MyResourceGroupName -Label $labels

Atualiza as propriedades da assinatura de evento 'ES1' para o grupo de recursos 'MyResourceGroupName' com os novos rótulos $labels.

Parâmetros

-AdvancedFilter

Filtro avançado que especifica uma matriz de vários valores Hashtable que são usados para a filtragem baseada em atributos. Cada valor Hashtable tem as seguintes informações 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 payload onde as políticas avançadas de filtragem são aplicadas. Finalmente, Value ou Values representam o valor ou conjunto de valores a serem correspondidos. Pode ser um único valor do tipo correspondente ou uma matriz de valores. Como exemplo dos parâmetros avançados do filtro: $AdvancedFilters=@($AdvFilter 1, $AdvFilter 2) onde $AdvFilter 1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} e $AdvFilter 2=@{operator="StringBeginsWith"; key="Subject"; Valores=@("SubjectPrefix1","SubjectPrefix2")}

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

-AzureActiveDirectoryApplicationIdOrUri

O ID ou Uri do Aplicativo 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:	AliasAadAppIdUri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AzureActiveDirectoryTenantId

O 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:	False
Accept wildcard characters:	False

-Confirm

Solicita a 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 do 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:	False
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 os seguintes dois campos obrigatórios: 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' é 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"; Type="Dinâmico"; SourceField="data.prop1"}

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

-DomainName

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

Type:	String
Position:	2
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:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Endpoint

Ponto de extremidade de destino da assinatura do evento. Pode ser uma URL de webhook ou a ID de recurso do Azure de um EventHub, fila de armazenamento, hybridconnection ou servicebusqueue. Por exemplo, a ID de recurso para uma conexão híbrida assume a seguinte forma: /subscriptions/[Azure Subscription ID]/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:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EndpointType

Tipo de ponto final. 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
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EventSubscriptionName

O nome da assinatura do 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. Este valor deve estar entre 1 e 1440

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

-ExpirationDate

Determina o DateTime de expiração 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:	False
Accept wildcard characters:	False

-InputObject

EventGridSubscription objeto.

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

-Label

Etiquetas para a subscrição do evento

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

-MaxDeliveryAttempt

O número máximo de tentativas de entrega do evento. Este valor deve estar entre 1 e 30

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

-MaxEventsPerBatch

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

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

-PreferredBatchSizeInKiloByte

O tamanho de lote preferido em kilobytes. Este valor deve estar entre 1 e 1024. Este parâmetro é válido quando Endpint Type é apenas webhook.

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

-ResourceGroupName

O grupo de recursos do tópico.

Type:	String
Aliases:	ResourceGroup
Position:	1
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 foi criada.

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

-SubjectBeginsWith

Filtro que especifica que apenas os 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:	False
Accept wildcard characters:	False

-SubjectEndsWith

Filtro que especifica que apenas os 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:	False
Accept wildcard characters:	False

-TopicName

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

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

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. 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

PSEventSubscription

Saídas