New-AzEventGridSubscription

Модуль:

Az.EventGrid Module

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

Синтаксис

CreateExpanded (По умолчанию)

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

Описание

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

Примеры

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

$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

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

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

$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

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

Параметры

-AsJob

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

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	cf

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DeadLetterWithResourceIdentityType

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DeadLetterWithResourceIdentityUserAssignedIdentity

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DefaultProfile

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

Свойства параметров

Тип:	PSObject
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DeliveryWithResourceIdentityDestination

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

Свойства параметров

Тип:	IEventSubscriptionDestination
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DeliveryWithResourceIdentityType

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DeliveryWithResourceIdentityUserAssignedIdentity

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Destination

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

Свойства параметров

Тип:	IEventSubscriptionDestination
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-EventDeliverySchema

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	DeliverySchema

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ExpirationTimeUtc

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

Свойства параметров

Тип:	DateTime
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	ExpirationDate

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FilterAdvancedFilter

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

Свойства параметров

Тип:	IAdvancedFilter[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AdvancedFilter

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FilterEnableAdvancedFilteringOnArray

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

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AdvancedFilteringOnArray

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FilterIncludedEventType

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

Свойства параметров

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	ВключенныйEventType

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FilterIsSubjectCaseSensitive

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

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	SubjectCaseSensitive

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FilterSubjectBeginsWith

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	SubjectBeginsWith

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FilterSubjectEndsWith

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	SubjectEndsWith

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-InputObject

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

Свойства параметров

Тип:	IEventGridIdentity
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateViaIdentityExpanded

Position:	Named
Обязательно:	True
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-JsonFilePath

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateViaJsonFilePath

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-JsonString

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

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateViaJsonString

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Label

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

Свойства параметров

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Name

Имя подписки на событие. Имена подписок на события должны быть от 3 до 64 символов длиной и должны использовать только буквенно-цифровые буквы.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	EventSubscriptionName

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaJsonString

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaJsonFilePath

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-NoWait

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

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-PassThru

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

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-RetryPolicyEventTimeToLiveInMinute

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

Свойства параметров

Тип:	Int32
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	EventTtl

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-RetryPolicyMaxDeliveryAttempt

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

Свойства параметров

Тип:	Int32
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	MaxDeliveryAttempt

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaIdentityExpanded

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	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
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

CreateExpanded

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaJsonString

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CreateViaJsonFilePath

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WhatIf

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

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	wi

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

IEventGridIdentity

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

IEventSubscription