Event Hubs - Create Or Update

Başvuru

Service:: Event Hubs

API Version:: 2024-01-01

Ad Alanı içinde iç içe yerleştirilmiş bir kaynak olarak yeni bir Olay Hub'ı oluşturur veya güncelleştirir.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}?api-version=2024-01-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
eventHubName	path	True	string	Olay Hub'ı adı
namespaceName	path	True	string	Ad alanı adı Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Azure aboneliğindeki kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API Sürümü.

İstek Gövdesi

Name	Tür	Description
properties.captureDescription	CaptureDescription	Yakalama açıklamasının özellikleri
properties.messageRetentionInDays	integer	Bu Olay Hub'ına ait olayların tutulacağı gün sayısı; değer 1 ile 7 gün aramalıdır
properties.partitionCount	integer	Olay Hub'ı için oluşturulan bölüm sayısı; izin verilen değerler 1 ile 32 bölüm olabilir.
properties.retentionDescription	RetentionDescription	Olay Hub'ı bekletme ayarları
properties.status	EntityStatus	Olay Hub'ının durumu için olası değerleri numaralandırır.
properties.userMetadata	string	Kullanıcının Meta Verilerini Alır ve Ayarlar.

Yanıtlar

Name	Tür	Description
200 OK	Eventhub	Olay Hub'ı başarıyla oluşturuldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan Eventhub hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

EventHubCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5357/eventhubs/sdk-EventHub-6547?api-version=2024-01-01

{
  "properties": {
    "messageRetentionInDays": 4,
    "partitionCount": 4,
    "status": "Active",
    "userMetadata": "key",
    "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}"
        },
        "identity": {
          "type": "UserAssigned",
          "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2"
        }
      },
      "intervalInSeconds": 120,
      "sizeLimitInBytes": 10485763
    },
    "retentionDescription": {
      "cleanupPolicy": "Compact",
      "retentionTimeInHours": 96,
      "tombstoneRetentionTimeInHours": 1
    }
  }
}

Sample Response

Status code:: 200

{
  "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",
    "userMetadata": "key",
    "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}"
        },
        "identity": {
          "type": "UserAssigned",
          "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2"
        }
      },
      "intervalInSeconds": 120,
      "sizeLimitInBytes": 10485763
    },
    "retentionDescription": {
      "cleanupPolicy": "Compact",
      "retentionTimeInHours": 96,
      "tombstoneRetentionTimeInHours": 1
    }
  }
}

Tanımlar

Name	Description
CaptureDescription	eventhub için yakalama açıklamasını yapılandıracak özellikler
CaptureIdentity	Yakalama açıklamasının etkinleştirilip etkinleştirilmediğini gösteren değer.
CaptureIdentityType	Azure Active Directory Yönetilen Kimliği türü.
CleanupPolicyRetentionDescription	Temizleme ilkesi için olası değerleri numaralandırır
createdByType	Kaynağı oluşturan kimliğin türü.
Destination	Yakalama açıklaması için depolama ayrıntılarını yakalama
EncodingCaptureDescription	Yakalama açıklamasının kodlama biçimi için olası değerleri numaralandırır. Not: 'AvroDeflate' Yeni API Sürümünde kullanım dışı bırakılacak
EntityStatus	Olay Hub'ının durumu için olası değerleri numaralandırır.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.
Eventhub	Listele veya Olay Hub'ı Al işlemindeki tek öğe
RetentionDescription	Eventhub için bekletme ayarlarını yapılandırma özellikleri
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CaptureDescription

eventhub için yakalama açıklamasını yapılandıracak özellikler

Name	Tür	Description
destination	Destination	Yakalamanın depolandığı Hedefin özellikleri. (Depolama Hesabı, Blob Adları)
enabled	boolean	Yakalama açıklamasının etkinleştirilip etkinleştirilmediğini gösteren değer.
encoding	EncodingCaptureDescription	Yakalama açıklamasının kodlama biçimi için olası değerleri numaralandırır. Not: 'AvroDeflate' Yeni API Sürümünde kullanım dışı bırakılacak
intervalInSeconds	integer	Zaman penceresi, Azure Bloblarına yakalamanın gerçekleşeceği sıklığı ayarlamanıza olanak tanır, değer 60 ila 900 saniye arasında olmalıdır
sizeLimitInBytes	integer	Boyut penceresi, bir yakalama işleminden önce Olay Hub'ınızda oluşturulan veri miktarını tanımlar, değer 10485760 ile 524288000 bayt arasında olmalıdır
skipEmptyArchives	boolean	Boş Arşivlerin Atlanıp Atlanmayacağını gösteren bir değer

CaptureIdentity

Yakalama açıklamasının etkinleştirilip etkinleştirilmediğini gösteren değer.

Name	Tür	Description
type	CaptureIdentityType	Azure Active Directory Yönetilen Kimliği türü.
userAssignedIdentity	string	Yönetilen Kullanıcı Kimliğinin ARM Kimliği. Bu özellik UserAssignedIdentity türünde gereklidir. Tür SystemAssigned ise, ad alanıyla ilişkili Sistem Tarafından Atanan Kimlik kullanılır.

CaptureIdentityType

Azure Active Directory Yönetilen Kimliği türü.

Name	Tür	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Temizleme ilkesi için olası değerleri numaralandırır

Name	Tür	Description
Compact	string
Delete	string

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Yakalama açıklaması için depolama ayrıntılarını yakalama

Name	Tür	Description
identity	CaptureIdentity	Yakalama açıklamasının etkinleştirilip etkinleştirilmediğini gösteren değer.
name	string	Yakalama hedefinin adı
properties.archiveNameFormat	string	Arşiv için blob adlandırma kuralı, örneğin {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Burada sıralamadan bağımsız olarak tüm parametreler (Namespace,EventHub .. vb.) zorunlu olarak bulunur
properties.blobContainer	string	Blob kapsayıcı adı
properties.dataLakeAccountName	string	Yakalanan olaylar için Azure Data Lake Store adı
properties.dataLakeFolderPath	string	Yakalanan olaylar için hedef klasör yolu
properties.dataLakeSubscriptionId	string	Azure Data Lake Store'un Abonelik Kimliği
properties.storageAccountResourceId	string	Blobları oluşturmak için kullanılacak depolama hesabının kaynak kimliği

EncodingCaptureDescription

Yakalama açıklamasının kodlama biçimi için olası değerleri numaralandırır. Not: 'AvroDeflate' Yeni API Sürümünde kullanım dışı bırakılacak

Name	Tür	Description
Avro	string
AvroDeflate	string

EntityStatus

Olay Hub'ının durumu için olası değerleri numaralandırır.

Name	Tür	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı, Event Hub hizmetinin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

Eventhub

Listele veya Olay Hub'ı Al işlemindeki tek öğe

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.captureDescription	CaptureDescription	Yakalama açıklamasının özellikleri
properties.createdAt	string	Olay Hub'ını tam olarak oluşturma zamanı.
properties.messageRetentionInDays	integer	Bu Olay Hub'ına ait olayların tutulacağı gün sayısı; değer 1 ile 7 gün aramalıdır
properties.partitionCount	integer	Olay Hub'ı için oluşturulan bölüm sayısı; izin verilen değerler 1 ile 32 bölüm olabilir.
properties.partitionIds	string[]	Olay Hub'ının geçerli parça sayısı.
properties.retentionDescription	RetentionDescription	Olay Hub'ı bekletme ayarları
properties.status	EntityStatus	Olay Hub'ının durumu için olası değerleri numaralandırır.
properties.updatedAt	string	İletinin tam olarak güncelleştirilişi.
properties.userMetadata	string	Kullanıcının Meta Verilerini Alır ve Ayarlar.
systemData	systemData	Bu kaynakla ilgili sistem meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.EventHub/Namespaces" veya "Microsoft.EventHub/Namespaces/EventHubs"

RetentionDescription

Eventhub için bekletme ayarlarını yapılandırma özellikleri

Name	Tür	Description
cleanupPolicy	CleanupPolicyRetentionDescription	Temizleme ilkesi için olası değerleri numaralandırır
retentionTimeInHours	integer	Bu Olay Hub'ına ait olayların tutulacak saat sayısı. Bu değer yalnızca cleanupPolicy Delete olduğunda kullanılır. cleanupPolicy Sıkıştır ise, bu özelliğin döndürülen değeri Long.MaxValue'dır
tombstoneRetentionTimeInHours	integer	Sıkıştırılmış bir Olay Hub'ının kaldırılmış işaretleyicilerinin tutulacak saat sayısı. Bu değer yalnızca cleanupPolicy Compact olduğunda kullanılır. Tüketici, sıkıştırılmış Olay Hub'ının içindeki silinmiş öğe işareti tarafından açıklanan belirli bir anahtar için geçerli bir anlık görüntü elde etmek üzere uzaklığı başlatmaya başlarsa, tüketicinin belirtilen süre içinde silinmiş öğe işareti okuma işlemini tamamlaması gerekir

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağı en son değiştiren kimliğin türü.
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

Share via