New-AzEventGridSubscription
Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente com base no escopo especificado.
Syntax
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>] New-AzEventGridSubscription
-Name <String>
-Scope <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventGridSubscription
-Name <String>
-Scope <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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
Cria de forma assíncrona uma nova assinatura de evento ou atualiza 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-eventsubCria 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_eventgridCria 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
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-DeadLetterWithResourceIdentityType
O tipo de identidade gerenciada usado. 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadLetterWithResourceIdentityUserAssignedIdentity
A identidade do usuário associada ao recurso.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeliveryWithResourceIdentityDestination
Informações sobre o destino onde os eventos devem ser entregues para a inscrição 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/deadlettering.
| Type: | IEventSubscriptionDestination |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeliveryWithResourceIdentityType
O tipo de identidade gerenciada usado. 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeliveryWithResourceIdentityUserAssignedIdentity
A identidade do usuário associada ao recurso.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Destination
Informações sobre o destino onde os eventos devem ser entregues para a inscrição 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/deadlettering.
| Type: | IEventSubscriptionDestination |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventDeliverySchema
O esquema de entrega de eventos para a assinatura do evento.
| Type: | String |
| Aliases: | DeliverySchema |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpirationTimeUtc
Tempo de expiração da assinatura do evento.
| Type: | DateTime |
| Aliases: | ExpirationDate |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterAdvancedFilter
Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos.
| Type: | IAdvancedFilter[] |
| Aliases: | AdvancedFilter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterEnableAdvancedFilteringOnArray
Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.
| Type: | SwitchParameter |
| Aliases: | AdvancedFilteringOnArray |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String[] |
| Aliases: | IncludedEventType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterIsSubjectCaseSensitive
Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro devem ser comparadas de maneira sensível a maiúsculas e minúsculas.
| Type: | SwitchParameter |
| Aliases: | SubjectCaseSensitive |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 nesse caminho.
| Type: | String |
| Aliases: | SubjectBeginsWith |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 nesse caminho.
| Type: | String |
| Aliases: | SubjectEndsWith |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Parâmetro de identidade
| Type: | IEventGridIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JsonFilePath
Caminho do arquivo Json fornecido para a operação Create
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JsonString
Cadeia de caracteres Json fornecida à operação Create
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Label
Lista de rótulos definidos pelo usuário.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Nome da assinatura do evento. Os nomes de assinatura de eventos devem ter entre 3 e 64 caracteres e devem usar apenas letras alfanuméricas.
| Type: | String |
| Aliases: | EventSubscriptionName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Execute o comando de forma assíncrona
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Retorna true quando o comando é bem-sucedido
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetryPolicyEventTimeToLiveInMinute
Time To Live (em minutos) para eventos.
| Type: | Int32 |
| Aliases: | EventTtl |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetryPolicyMaxDeliveryAttempt
Número máximo de tentativas de repetição de entrega para eventos.
| Type: | Int32 |
| Aliases: | MaxDeliveryAttempt |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
O identificador do recurso para o qual a assinatura do 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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
Saídas
Azure PowerShell
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de