Topics - Get

Dapatkan topik.
Mendapatkan properti topik.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-15

Parameter URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nama grup sumber daya dalam langganan pengguna.

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

topicName
path True
  • string

Nama topik.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Respons

Name Type Description
200 OK

OK

Other Status Codes

Respons Kesalahan: ***

  • 400 Permintaan Buruk.

  • Kesalahan Server Internal 500.

Contoh

Topics_Get

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2?api-version=2022-06-15

Sample Response

{
  "properties": {
    "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
  "location": "westcentralus",
  "name": "exampletopic2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/topics"
}

Definisi

ConnectionState

Informasi ConnectionState.

createdByType

Jenis identitas yang membuat sumber daya.

DataResidencyBoundary

Data Residency Batas sumber daya.

IdentityInfo

Informasi identitas untuk sumber daya.

IdentityType

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.

InboundIpRule
InputSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke Sumber Daya Domain Event Grid.

IpActionType

Tindakan yang harus dilakukan berdasarkan kecocokan atau tidak ada kecocokan ipMask.

JsonField

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Ini saat ini digunakan dalam pemetaan untuk properti 'id', 'topik' dan 'eventtime'. Ini mewakili bidang dalam skema peristiwa input.

JsonFieldWithDefault

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Ini saat ini digunakan dalam pemetaan untuk properti 'subjek', 'eventtype' dan 'dataversion'. Ini mewakili bidang dalam skema peristiwa input bersama dengan nilai default yang akan digunakan, dan setidaknya salah satu dari dua properti ini harus disediakan.

JsonInputSchemaMapping

Ini memungkinkan penerbitan ke Event Grid menggunakan skema input kustom. Ini dapat digunakan untuk memetakan properti dari skema JSON input kustom ke skema peristiwa Event Grid.

PersistedConnectionStatus

Status koneksi.

PrivateEndpoint

Informasi PrivateEndpoint.

PrivateEndpointConnection
PublicNetworkAccess

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

ResourceProvisioningState

Status penyediaan Koneksi Titik Akhir Privat.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Topic

Topik EventGrid

TopicProvisioningState

Status penyediaan topik.

UserIdentityProperties

Informasi tentang identitas pengguna.

ConnectionState

Informasi ConnectionState.

Name Type Description
actionsRequired
  • string

Tindakan yang diperlukan (jika ada).

description
  • string

Deskripsi status koneksi.

status

Status koneksi.

createdByType

Jenis identitas yang membuat sumber daya.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataResidencyBoundary

Data Residency Batas sumber daya.

Name Type Description
WithinGeopair
  • string
WithinRegion
  • string

IdentityInfo

Informasi identitas untuk sumber daya.

Name Type Description
principalId
  • string

ID utama identitas sumber daya.

tenantId
  • string

ID penyewa sumber daya.

type

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.

userAssignedIdentities

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Properti ini saat ini tidak digunakan dan dicadangkan untuk penggunaan di masa mendatang.

IdentityType

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.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

InboundIpRule

Name Type Description
action

Tindakan yang harus dilakukan berdasarkan kecocokan atau tidak ada kecocokan ipMask.

ipMask
  • string

Alamat IP dalam notasi CIDR misalnya, 10.0.0.0/8.

InputSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke Sumber Daya Domain Event Grid.

Name Type Description
CloudEventSchemaV1_0
  • string
CustomEventSchema
  • string
EventGridSchema
  • string

IpActionType

Tindakan yang harus dilakukan berdasarkan kecocokan atau tidak ada kecocokan ipMask.

Name Type Description
Allow
  • string

JsonField

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Ini saat ini digunakan dalam pemetaan untuk properti 'id', 'topik' dan 'eventtime'. Ini mewakili bidang dalam skema peristiwa input.

Name Type Description
sourceField
  • string

Nama bidang dalam skema peristiwa input yang akan digunakan sebagai sumber pemetaan.

JsonFieldWithDefault

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Ini saat ini digunakan dalam pemetaan untuk properti 'subjek', 'eventtype' dan 'dataversion'. Ini mewakili bidang dalam skema peristiwa input bersama dengan nilai default yang akan digunakan, dan setidaknya salah satu dari dua properti ini harus disediakan.

Name Type Description
defaultValue
  • string

Nilai default yang akan digunakan untuk pemetaan ketika SourceField tidak disediakan atau jika tidak ada properti dengan nama yang ditentukan dalam payload peristiwa JSON yang diterbitkan.

sourceField
  • string

Nama bidang dalam skema peristiwa input yang akan digunakan sebagai sumber pemetaan.

JsonInputSchemaMapping

Ini memungkinkan penerbitan ke Event Grid menggunakan skema input kustom. Ini dapat digunakan untuk memetakan properti dari skema JSON input kustom ke skema peristiwa Event Grid.

Name Type Description
inputSchemaMappingType string:
  • Json

Jenis pemetaan kustom

properties.dataVersion

Informasi pemetaan untuk properti DataVersion dari Peristiwa Event Grid.

properties.eventTime

Informasi pemetaan untuk properti EventTime dari Peristiwa Event Grid.

properties.eventType

Informasi pemetaan untuk properti EventType dari Peristiwa Event Grid.

properties.id

Informasi pemetaan untuk properti Id dari Peristiwa Event Grid.

properties.subject

Informasi pemetaan untuk properti Subjek dari Peristiwa Event Grid.

properties.topic

Informasi pemetaan untuk properti Topik dari Peristiwa Event Grid.

PersistedConnectionStatus

Status koneksi.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateEndpoint

Informasi PrivateEndpoint.

Name Type Description
id
  • string

Pengidentifikasi ARM untuk Titik Akhir Privat.

PrivateEndpointConnection

Name Type Description
id
  • string

Pengidentifikasi sumber daya yang sepenuhnya memenuhi syarat.

name
  • string

Nama sumber daya.

properties.groupIds
  • string[]

GroupIds dari sumber daya layanan tautan privat.

properties.privateEndpoint

Sumber daya Titik Akhir Privat untuk Koneksi ini.

properties.privateLinkServiceConnectionState

Detail tentang status koneksi.

properties.provisioningState

Status penyediaan Koneksi Titik Akhir Privat.

type
  • string

Jenis sumber daya.

PublicNetworkAccess

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceProvisioningState

Status penyediaan Koneksi Titik Akhir Privat.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt
  • string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy
  • string

Identitas yang terakhir memodifikasi sumber daya.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

Topic

Topik EventGrid

Name Type Default Value Description
id
  • string

Pengidentifikasi sumber daya yang sepenuhnya memenuhi syarat.

identity

Informasi identitas untuk sumber daya.

location
  • string

Lokasi sumber daya.

name
  • string

Nama sumber daya.

properties.dataResidencyBoundary

Data Residency Batas sumber daya.

properties.disableLocalAuth
  • boolean
False

Boolean ini digunakan untuk mengaktifkan atau menonaktifkan autentikasi lokal. Nilai defaultnya adalah false. Ketika properti diatur ke true, hanya token AAD yang akan digunakan untuk mengautentikasi jika pengguna diizinkan untuk menerbitkan ke topik tersebut.

properties.endpoint
  • string

Titik akhir untuk topik tersebut.

properties.inboundIpRules

Ini dapat digunakan untuk membatasi lalu lintas dari IP tertentu alih-alih semua IP. Catatan: Ini hanya dipertimbangkan jika PublicNetworkAccess diaktifkan.

properties.inputSchema EventGridSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke topik tersebut.

properties.inputSchemaMapping InputSchemaMapping:

Ini memungkinkan penerbitan menggunakan skema peristiwa kustom. InputSchemaMapping dapat ditentukan untuk memetakan berbagai properti skema sumber ke berbagai properti skema EventGridEvent yang diperlukan.

properties.metricResourceId
  • string

Id sumber daya metrik untuk topik tersebut.

properties.privateEndpointConnections
properties.provisioningState

Status penyediaan topik.

properties.publicNetworkAccess Enabled

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

systemData

Metadata sistem yang berkaitan dengan sumber daya Topik.

tags
  • object

Tag sumber daya.

type
  • string

Jenis sumber daya.

TopicProvisioningState

Status penyediaan topik.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

UserIdentityProperties

Informasi tentang identitas pengguna.

Name Type Description
clientId
  • string

Id klien identitas yang ditetapkan pengguna.

principalId
  • string

Id utama identitas yang ditetapkan pengguna.