Event Hubs - List By Namespace

Referensi

Service:: Event Hubs

API Version:: 2021-06-01-preview

Mendapatkan semua Azure Event Hubs di Namespace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2021-06-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2021-06-01-preview&$skip={$skip}&$top={$top}

Parameter URI

Name	In	Required	Type	Description
namespaceName	path	True	string	Nama Namespace
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan azure.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API Klien.
$skip	query		integer	Lewati hanya digunakan jika operasi sebelumnya mengembalikan hasil parsial. Jika respons sebelumnya berisi elemen nextLink, nilai elemen nextLink akan menyertakan parameter lewati yang menentukan titik awal yang akan digunakan untuk panggilan berikutnya.
$top	query		integer	Dapat digunakan untuk membatasi jumlah hasil ke N usageDetails terbaru.

Respons

Name	Type	Description
200 OK	EventHubListResult	Berhasil mengambil daftar Azure Event Hubs.
Other Status Codes	ErrorResponse	Respons kesalahan Eventhub yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

EventHubsListAll

Sample Request

HTTP

GET https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5357/eventhubs?api-version=2021-06-01-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-eventhub-10",
      "name": "sdk-eventhub-10",
      "type": "Microsoft.EventHub/Namespaces/EventHubs",
      "properties": {
        "messageRetentionInDays": 4,
        "partitionCount": 4,
        "status": "Active",
        "createdAt": "2017-06-28T02:45:55.877Z",
        "updatedAt": "2017-06-28T02:46:05.877Z",
        "partitionIds": [
          "0",
          "1",
          "2",
          "3"
        ],
        "captureDescription": {
          "enabled": true,
          "encoding": "Avro",
          "destination": {
            "name": "EventHubArchive.AzureBlockBlob",
            "properties": {
              "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage",
              "blobContainer": "container",
              "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
            }
          },
          "intervalInSeconds": 120,
          "sizeLimitInBytes": 10485763
        }
      }
    }
  ]
}

Definisi

CaptureDescription	Properti untuk mengonfigurasi deskripsi pengambilan untuk eventhub
createdByType	Jenis identitas yang membuat sumber daya.
Destination	Mengambil detail penyimpanan untuk deskripsi pengambilan
EncodingCaptureDescription	Menghitung nilai yang mungkin untuk format pengodean deskripsi tangkapan. Catatan: 'AvroDeflate' tidak akan digunakan lagi di Versi API Baru
EntityStatus	Menghitung nilai yang mungkin untuk status Pusat Aktivitas.
ErrorResponse	Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
Eventhub	Item tunggal dalam operasi Daftar atau Dapatkan Pusat Aktivitas
EventHubListResult	Hasil dari operasi List EventHubs.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CaptureDescription

Properti untuk mengonfigurasi deskripsi pengambilan untuk eventhub

Name	Type	Description
destination	Destination	Properti Tujuan tempat pengambilan akan disimpan. (Akun Storage, Nama Blob)
enabled	boolean	Nilai yang menunjukkan apakah deskripsi pengambilan diaktifkan.
encoding	EncodingCaptureDescription	Menghitung nilai yang mungkin untuk format pengodean deskripsi tangkapan. Catatan: 'AvroDeflate' tidak akan digunakan lagi di Versi API Baru
intervalInSeconds	integer	Jendela waktu memungkinkan Anda mengatur frekuensi pengambilan ke Azure Blobs akan terjadi, nilai harus antara 60 hingga 900 detik
sizeLimitInBytes	integer	Jendela ukuran menentukan jumlah data yang dibangun di Pusat Aktivitas Anda sebelum operasi penangkapan, nilai harus antara 10485760 hingga byte 524288000
skipEmptyArchives	boolean	Nilai yang menunjukkan apakah akan Melewati Arsip Kosong

createdByType

Jenis identitas yang membuat sumber daya.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Mengambil detail penyimpanan untuk deskripsi pengambilan

Name	Type	Description
name	string	Nama untuk tujuan pengambilan
properties.archiveNameFormat	string	Konvensi penamaan blob untuk arsip, misalnya {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Di sini semua parameter (Namespace, EventHub .. dll) wajib terlepas dari urutannya
properties.blobContainer	string	Nama kontainer blob
properties.storageAccountResourceId	string	Id sumber daya akun penyimpanan yang akan digunakan untuk membuat blob

EncodingCaptureDescription

Menghitung nilai yang mungkin untuk format pengodean deskripsi tangkapan. Catatan: 'AvroDeflate' tidak akan digunakan lagi di Versi API Baru

Name	Type	Description
Avro	string
AvroDeflate	string

EntityStatus

Menghitung nilai yang mungkin untuk status Pusat Aktivitas.

Name	Type	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorResponse

Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Eventhub

Item tunggal dalam operasi Daftar atau Dapatkan Pusat Aktivitas

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.captureDescription	CaptureDescription	Properti deskripsi penangkapan
properties.createdAt	string	Waktu yang tepat pusat aktivitas dibuat.
properties.messageRetentionInDays	integer	Jumlah hari untuk mempertahankan peristiwa untuk Pusat Aktivitas ini, nilainya harus 1 hingga 7 hari
properties.partitionCount	integer	Jumlah partisi yang dibuat untuk Pusat Aktivitas, nilai yang diizinkan adalah dari 1 hingga 32 partisi.
properties.partitionIds	string[]	Jumlah pecahan saat ini di Pusat Aktivitas.
properties.status	EntityStatus	Menghitung nilai yang mungkin untuk status Pusat Aktivitas.
properties.updatedAt	string	Waktu yang tepat pesan diperbarui.
systemData	systemData	Data meta sistem yang berkaitan dengan sumber daya ini.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

EventHubListResult

Hasil dari operasi List EventHubs.

Name	Type	Description
nextLink	string	Tautkan ke kumpulan hasil berikutnya. Tidak kosong jika Nilai berisi daftar EventHubs yang tidak lengkap.
value	Eventhub[]	Hasil operasi List EventHubs.

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	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Jenis identitas yang terakhir mengubah sumber daya.
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.