Compartilhar via

Update-AzEventGridSubscription

  • Referência
Módulo:
Az.EventGrid

Atualize de forma assíncrona uma assinatura de evento existente.

Sintaxe

Update-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>]
Update-AzEventGridSubscription
      -Name <String>
      -Scope <String>
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      -Name <String>
      -Scope <String>
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-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

Atualize de forma assíncrona uma assinatura de evento existente.

Exemplos

Exemplo 1: atualiza de forma assíncrona uma assinatura de evento existente.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
Update-AzEventGridSubscription -Name azps-eventsub -Scope "subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" -Destination $obj -FilterIsSubjectCaseSensitive:$false

Name          ResourceGroupName
----          -----------------
azps-eventsub

Atualiza de forma assíncrona uma assinatura de evento existente.

Parâmetros

-AsJob

Executar o comando como um trabalho

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeadLetterWithResourceIdentityType

O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

A identidade do usuário associada ao recurso.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

O parâmetro DefaultProfile não está funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeliveryWithResourceIdentityDestination

Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.

Tipo:IEventSubscriptionDestination
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeliveryWithResourceIdentityType

O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeliveryWithResourceIdentityUserAssignedIdentity

A identidade do usuário associada ao recurso.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Destination

Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.

Tipo:IEventSubscriptionDestination
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.

Tipo:String
Aliases:DeliverySchema
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ExpirationTimeUtc

Informações sobre a hora de expiração da assinatura do evento.

Tipo:DateTime
Aliases:ExpirationDate
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-FilterAdvancedFilter

Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos.

Tipo:IAdvancedFilter[]
Aliases:AdvancedFilter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-FilterEnableAdvancedFilteringOnArray

Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.

Tipo:SwitchParameter
Aliases:AdvancedFilteringOnArray
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-FilterIncludedEventType

Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo.

Tipo:String[]
Aliases:IncludedEventType
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-FilterIsSubjectCaseSensitive

Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith dos filtros devem ser comparadas de maneira sensível a maiúsculas de minúsculas.

Tipo:SwitchParameter
Aliases:SubjectCaseSensitive
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-FilterSubjectBeginsWith

Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.

Tipo:String
Aliases:SubjectBeginsWith
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-FilterSubjectEndsWith

Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.

Tipo:String
Aliases:SubjectEndsWith
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Parâmetro de identidade

Tipo:IEventGridIdentity
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-JsonFilePath

Caminho do arquivo Json fornecido para a operação De atualização

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-JsonString

Cadeia de caracteres Json fornecida para a operação De atualização

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Label

Lista de rótulos definidos pelo usuário.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Name

Nome da assinatura do evento a ser atualizada.

Tipo:String
Aliases:EventSubscriptionName
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NoWait

Executar o comando de forma assíncrona

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-PassThru

Retorna true quando o comando é bem-sucedido

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RetryPolicyEventTimeToLiveInMinute

Vida útil (em minutos) para eventos.

Tipo:Int32
Aliases:EventTtl
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RetryPolicyMaxDeliveryAttempt

Número máximo de tentativas de repetição de entrega para eventos.

Tipo:Int32
Aliases:MaxDeliveryAttempt
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Scope

O escopo da assinatura de evento existente. O escopo pode ser uma assinatura ou um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou um tópico eventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico eventGrid.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

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

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

IEventGridIdentity

Saídas

IEventSubscription