Поделиться через


Update-AzEventGridSubscription

Асинхронно обновляет существующую подписку на события.

Синтаксис

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

Описание

Асинхронно обновляет существующую подписку на события.

Примеры

Пример 1. Асинхронно обновляет существующую подписку на события.

$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

Асинхронно обновляет существующую подписку на события.

Параметры

-AsJob

Выполнение команды в качестве задания

Тип:SwitchParameter
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Запрос подтверждения перед выполнением командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadLetterWithResourceIdentityType

Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Удостоверение пользователя, связанное с ресурсом.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Параметр DefaultProfile не работает. Используйте параметр SubscriptionId, если он доступен при выполнении командлета в другой подписке.

Тип:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryWithResourceIdentityDestination

Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки.

Тип:IEventSubscriptionDestination
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryWithResourceIdentityType

Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryWithResourceIdentityUserAssignedIdentity

Удостоверение пользователя, связанное с ресурсом.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Destination

Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки.

Тип:IEventSubscriptionDestination
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-EventDeliverySchema

Схема доставки событий для подписки на события.

Тип:String
Aliases:DeliverySchema
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpirationTimeUtc

Сведения об истечении срока действия подписки на событие.

Тип:DateTime
Aliases:ExpirationDate
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterAdvancedFilter

Массив расширенных фильтров, используемых для фильтрации подписок на события.

Тип:IAdvancedFilter[]
Aliases:AdvancedFilter
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterEnableAdvancedFilteringOnArray

Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения.

Тип:SwitchParameter
Aliases:AdvancedFilteringOnArray
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterIncludedEventType

Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL.

Тип:String[]
Aliases:IncludedEventType
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterIsSubjectCaseSensitive

Указывает, сравниваются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра с учетом регистра.

Тип:SwitchParameter
Aliases:SubjectCaseSensitive
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterSubjectBeginsWith

Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу. Формат этого зависит от издателя событий. Символы wild карта не поддерживаются в этом пути.

Тип:String
Aliases:SubjectBeginsWith
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-FilterSubjectEndsWith

Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу. Символы wild карта не поддерживаются в этом пути.

Тип:String
Aliases:SubjectEndsWith
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Параметр удостоверения

Тип:IEventGridIdentity
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:True
Accept wildcard characters:False

-JsonFilePath

Путь к json-файлу, предоставленному операции обновления

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:False
Accept wildcard characters:False

-JsonString

Строка JSON, предоставленная операции обновления

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:False
Accept wildcard characters:False

-Label

Список определяемых пользователем меток.

Тип:String[]
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Имя обновляемой подписки на события.

Тип:String
Aliases:EventSubscriptionName
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Асинхронное выполнение команды

Тип:SwitchParameter
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Возвращает значение true, когда команда завершается успешно

Тип:SwitchParameter
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-RetryPolicyEventTimeToLiveInMinute

Время жизни (в минутах) для событий.

Тип:Int32
Aliases:EventTtl
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-RetryPolicyMaxDeliveryAttempt

Максимальное количество попыток повторных попыток доставки для событий.

Тип:Int32
Aliases:MaxDeliveryAttempt
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Область существующей подписки на события. Область может быть подпиской, группой ресурсов или ресурсом верхнего уровня, принадлежащим пространству имен поставщика ресурсов или разделу EventGrid. Например, используйте "/subscriptions/{subscriptionId}/" для подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для группы ресурсов, и "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" для ресурса и "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}" для раздела EventGrid.

Тип:String
Position:Named
значение по умолчанию:None
Обязательно:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
значение по умолчанию:None
Обязательно:False
Accept pipeline input:False
Accept wildcard characters:False

Входные данные

IEventGridIdentity

Выходные данные

IEventSubscription