Partilhar via

New-AzEventGridSubscription

Módulo:
Az.EventGrid Module

Crie de forma assíncrona uma nova assinatura de evento ou crie uma assinatura de evento existente com base no escopo especificado.

Sintaxe

CreateExpanded (Predefinição) 

New-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>]

CreateViaJsonString 

New-AzEventGridSubscription
    -Name <String>
    -Scope <String>
    -JsonString <String>
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaJsonFilePath 

New-AzEventGridSubscription
    -Name <String>
    -Scope <String>
    -JsonFilePath <String>
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded 

New-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

Crie de forma assíncrona uma nova assinatura de evento ou crie uma assinatura de evento existente com base no escopo especificado.

Exemplos

Exemplo 1: cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

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

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

Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

Exemplo 2: Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
$topic = Get-AzEventGridTopic -ResourceGroupName azps_test_group_eventgrid -Name azps-topic
New-AzEventGridSubscription -Name azps-eventsub -Scope $topic.Id -Destination $obj -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix"

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

Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.

Parâmetros

-AsJob

Executar o comando como um trabalho

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

A identidade do usuário associada ao recurso.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:PSObject
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:IEventSubscriptionDestination
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DeliveryWithResourceIdentityUserAssignedIdentity

A identidade do usuário associada ao recurso.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:IEventSubscriptionDestination
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-EventDeliverySchema

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:DeliverySchema

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ExpirationTimeUtc

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

Propriedades dos parâmetros

Tipo:DateTime
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:ExpirationDate

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-FilterAdvancedFilter

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

Propriedades dos parâmetros

Tipo:

IAdvancedFilter[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AdvancedFilter

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-FilterEnableAdvancedFilteringOnArray

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AdvancedFilteringOnArray

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:IncludedEventType

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-FilterIsSubjectCaseSensitive

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AssuntoSensível a maiúsculas e minúsculas

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AssuntoComeçaCom

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AssuntoTermina Com

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Parâmetro de identidade

Propriedades dos parâmetros

Tipo:IEventGridIdentity
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateViaIdentityExpanded
Position:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-JsonFilePath

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateViaJsonFilePath
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-JsonString

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateViaJsonString
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Label

Lista de rótulos definidos pelo usuário.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

Nome da assinatura do evento. Os nomes das assinaturas de eventos devem ter entre 3 e 64 caracteres e devem usar apenas letras alfanuméricas.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:EventSubscriptionName

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaJsonString
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaJsonFilePath
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-NoWait

Execute o comando de forma assíncrona

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PassThru

Retorna true quando o comando é bem-sucedido

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-RetryPolicyEventTimeToLiveInMinute

Time To Live (em minutos) para eventos.

Propriedades dos parâmetros

Tipo:Int32
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:EventTtl

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-RetryPolicyMaxDeliveryAttempt

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

Propriedades dos parâmetros

Tipo:Int32
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:MaxDeliveryAttempt

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaIdentityExpanded
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Scope

O identificador do recurso para o qual a assinatura de evento precisa ser criada ou atualizada. O escopo pode ser uma assinatura ou um grupo de recursos, ou um recurso de nível superior pertencente a um namespace de 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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

CreateExpanded
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaJsonString
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
CreateViaJsonFilePath
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

IEventGridIdentity

Saídas

IEventSubscription