New-AzEventGridSystemTopicEventSubscription

  • Referência
Módulo:
Az.EventGrid

Cria ou atualiza de forma assíncrona uma assinatura de evento com os parâmetros especificados. As subscrições de eventos existentes serão atualizadas com esta API.

Sintaxe

New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <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-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <String>
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <String>
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -SystemTopicInputObject <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>]
New-AzEventGridSystemTopicEventSubscription
   -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

Cria ou atualiza de forma assíncrona uma assinatura de evento com os parâmetros especificados. As subscrições de eventos existentes serão atualizadas com esta API.

Exemplos

Exemplo 1: Criar de forma assíncrona uma assinatura de evento com os parâmetros especificados.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net"
New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName azps-evnetsub -ResourceGroupName azps_test_group_eventgrid -SystemTopicName azps-systopic -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix" -Destination $obj

Name          ResourceGroupName
----          -----------------
azps-evnetsub azps_test_group_eventgrid

Crie de forma assíncrona uma assinatura de evento com os parâmetros especificados. As subscrições de eventos existentes serão atualizadas com esta API.

Parâmetros

-AsJob

Executar o comando como um trabalho

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 'Nenhum' removerá qualquer identidade.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

A identidade do usuário associada ao recurso.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultProfile

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

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DeliveryWithResourceIdentityDestination

Informações sobre o destino onde 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/dead-lettering.

Tipo:IEventSubscriptionDestination
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 'Nenhum' removerá qualquer identidade.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DeliveryWithResourceIdentityUserAssignedIdentity

A identidade do usuário associada ao recurso.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Destination

Informações sobre o destino onde 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/dead-lettering.

Tipo:IEventSubscriptionDestination
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-EventDeliverySchema

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

Tipo:String
Aliases:DeliverySchema
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-EventSubscriptionName

Nome da assinatura de evento a ser criada. Os nomes das assinaturas de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExpirationTimeUtc

Tempo de expiração da subscrição do evento.

Tipo:DateTime
Aliases:ExpirationDate
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-FilterAdvancedFilter

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

Tipo:IAdvancedFilter[]
Aliases:AdvancedFilter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-FilterIncludedEventType

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

Tipo:String[]
Aliases:IncludedEventType
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-FilterIsSubjectCaseSensitive

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

Tipo:SwitchParameter
Aliases:SubjectCaseSensitive
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.

Tipo:String
Aliases:SubjectBeginsWith
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Parâmetro de identidade

Tipo:IEventGridIdentity
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-JsonFilePath

Caminho do arquivo Json fornecido para a operação Create

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-JsonString

Cadeia de caracteres Json fornecida para a operação Create

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Label

Lista de rótulos definidos pelo usuário.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-NoWait

Execute o comando de forma assíncrona

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PassThru

Retorna true quando o comando é bem-sucedido

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ResourceGroupName

O nome do grupo de recursos dentro da assinatura do usuário.

Tipo:String
Aliases:ResourceGroup
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-RetryPolicyEventTimeToLiveInMinute

Time To Live (em minutos) para eventos.

Tipo:Int32
Aliases:EventTtl
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-RetryPolicyMaxDeliveryAttempt

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

Tipo:Int32
Aliases:MaxDeliveryAttempt
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-SubscriptionId

Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

Tipo:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-SystemTopicInputObject

Parâmetro de identidade

Tipo:IEventGridIdentity
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SystemTopicName

Nome do tópico do sistema.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

IEventGridIdentity

Saídas

IEventSubscription