New-AzEventGridSubscription

Buat langganan peristiwa baru secara asinkron atau buat langganan peristiwa yang sudah ada berdasarkan cakupan yang ditentukan.

Sintaks

CreateExpanded (Default)

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

Deskripsi

Buat langganan peristiwa baru secara asinkron atau buat langganan peristiwa yang sudah ada berdasarkan cakupan yang ditentukan.

Contoh

Contoh 1: Secara asinkron membuat langganan peristiwa baru atau memperbarui langganan peristiwa yang ada berdasarkan cakupan yang ditentukan.

$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

Secara asinkron membuat langganan peristiwa baru atau memperbarui langganan peristiwa yang ada berdasarkan cakupan yang ditentukan.

Contoh 2: Secara asinkron membuat langganan peristiwa baru atau memperbarui langganan peristiwa yang ada berdasarkan cakupan yang ditentukan.

$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

Secara asinkron membuat langganan peristiwa baru atau memperbarui langganan peristiwa yang ada berdasarkan cakupan yang ditentukan.

Parameter

-AsJob

Jalankan perintah sebagai pekerjaan

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Cf

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DeadLetterWithResourceIdentityType

Jenis identitas terkelola yang digunakan. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

Identitas pengguna yang terkait dengan sumber daya.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DefaultProfile

Parameter DefaultProfile tidak berfungsi. Gunakan parameter SubscriptionId saat tersedia jika menjalankan cmdlet terhadap langganan yang berbeda.

Properti parameter

Jenis:PSObject
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AzureRMContext, AzureCredential

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DeliveryWithResourceIdentityDestination

Informasi tentang tujuan tempat peristiwa harus dikirimkan untuk langganan peristiwa. Menggunakan identitas Azure Event Grid untuk memperoleh token autentikasi yang digunakan selama pengiriman / dead-lettering.

Properti parameter

Jenis:IEventSubscriptionDestination
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DeliveryWithResourceIdentityType

Jenis identitas terkelola yang digunakan. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DeliveryWithResourceIdentityUserAssignedIdentity

Identitas pengguna yang terkait dengan sumber daya.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Destination

Informasi tentang tujuan tempat peristiwa harus dikirimkan untuk langganan peristiwa. Menggunakan identitas Azure Event Grid untuk memperoleh token autentikasi yang digunakan selama pengiriman / dead-lettering.

Properti parameter

Jenis:IEventSubscriptionDestination
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-EventDeliverySchema

Skema pengiriman peristiwa untuk langganan peristiwa.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:DeliverySchema

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ExpirationTimeUtc

Waktu kedaluwarsa langganan peristiwa.

Properti parameter

Jenis:DateTime
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Tanggal Kedaluwarsa

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FilterAdvancedFilter

Array filter tingkat lanjut yang digunakan untuk memfilter langganan peristiwa.

Properti parameter

Jenis:

IAdvancedFilter[]

Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AdvancedFilter

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FilterEnableAdvancedFilteringOnArray

Memungkinkan filter tingkat lanjut dievaluasi terhadap array nilai alih-alih mengharapkan nilai tunggal.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AdvancedFilteringOnArray

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FilterIncludedEventType

Daftar jenis peristiwa yang berlaku yang perlu menjadi bagian dari langganan peristiwa. Jika diinginkan untuk berlangganan semua jenis peristiwa default, atur IncludedEventTypes ke null.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:IncludedEventType

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FilterIsSubjectCaseSensitive

Menentukan apakah properti SubjectBeginsWith dan SubjectEndsWith filter harus dibandingkan dengan cara peka huruf besar/kecil.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:SubjectCaseSensitive

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FilterSubjectBeginsWith

String opsional untuk memfilter peristiwa untuk langganan peristiwa berdasarkan awalan jalur sumber daya. Format ini tergantung pada penerbit peristiwa. Karakter kartubebas tidak didukung di jalur ini.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:SubjectBeginsWith

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FilterSubjectEndsWith

String opsional untuk memfilter peristiwa untuk langganan peristiwa berdasarkan akhiran jalur sumber daya. Karakter kartubebas tidak didukung di jalur ini.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:SubjectEndsWith

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-InputObject

Parameter Identitas

Properti parameter

Jenis:IEventGridIdentity
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateViaIdentityExpanded
Position:Named
Wajib:True
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-JsonFilePath

Jalur file Json yang disediakan ke operasi Buat

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateViaJsonFilePath
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-JsonString

String Json yang disediakan ke operasi Buat

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateViaJsonString
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Label

Daftar label yang ditentukan pengguna.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Name

Nama langganan acara. Panjang nama langganan peristiwa harus antara 3 dan 64 karakter dan harus menggunakan huruf alfanumerik saja.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:NamaLanggananAcara

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaJsonString
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaJsonFilePath
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-NoWait

Jalankan perintah secara asinkron

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PassThru

Mengembalikan true ketika perintah berhasil

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-RetryPolicyEventTimeToLiveInMinute

Time To Live (dalam menit) untuk acara.

Properti parameter

Jenis:Int32
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:EventTtl

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-RetryPolicyMaxDeliveryAttempt

Jumlah maksimum upaya coba lagi pengiriman untuk peristiwa.

Properti parameter

Jenis:Int32
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:MaxDeliveryAttempt

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaIdentityExpanded
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Scope

Pengidentifikasi sumber daya tempat langganan peristiwa perlu dibuat atau diperbarui. Cakupan dapat berupa langganan, atau grup sumber daya, atau sumber daya tingkat atas milik namespace penyedia sumber daya, atau topik EventGrid. Misalnya, gunakan '/subscriptions/{subscriptionId}/' untuk langganan, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' untuk grup sumber daya, dan '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' untuk sumber daya, dan '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. EventGrid/topics/{topicName}' untuk topik EventGrid.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

CreateExpanded
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaJsonString
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
CreateViaJsonFilePath
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:wi

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

IEventGridIdentity

Output

IEventSubscription