Event Hubs - Create Or Update

Referencia

Service:: Event Hubs

API Version:: 2024-01-01

Létrehoz vagy frissít egy új eseményközpontot beágyazott erőforrásként egy névtéren belül.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
eventHubName	path	True	string	Az Eseményközpont neve
namespaceName	path	True	string	A névtér neve Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Az azure-előfizetésben található erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
properties.captureDescription	CaptureDescription	A rögzítési leírás tulajdonságai
properties.messageRetentionInDays	integer	Az eseményközpont eseményeinek megőrzéséhez szükséges napok száma, az értéknek 1–7 napnak kell lennie
properties.partitionCount	integer	Az Eseményközponthoz létrehozott partíciók száma, az engedélyezett értékek 1 és 32 partíció között vannak.
properties.retentionDescription	RetentionDescription	Az Event Hub adatmegőrzési beállításai
properties.status	EntityStatus	Az Eseményközpont állapotának lehetséges értékeinek számbavétele.
properties.userMetadata	string	Lekéri és beállítja a felhasználó metaadatait.

Válaszok

Name	Típus	Description
200 OK	Eventhub	Az Event Hub létrehozása sikerült.
Other Status Codes	ErrorResponse	Az EventHub hibaválasza, amely leírja, hogy a művelet miért nem sikerült.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
CaptureDescription	Az eventhub rögzítési leírásának konfigurálásához szükséges tulajdonságok
CaptureIdentity	Egy érték, amely azt jelzi, hogy engedélyezve van-e a rögzítési leírás.
CaptureIdentityType	Az Azure Active Directory felügyelt identitásának típusa.
CleanupPolicyRetentionDescription	A törlési szabályzat lehetséges értékeinek számbavétele
createdByType	Az erőforrást létrehozó identitás típusa.
Destination	Tárolási adatok rögzítése a rögzítés leírásához
EncodingCaptureDescription	Számba adja a rögzítési leírás kódolási formátumának lehetséges értékeit. Megjegyzés: Az "AvroDeflate" elavult lesz az Új API-verzióban
EntityStatus	Az Eseményközpont állapotának lehetséges értékeinek számbavétele.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy az Event Hub szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
Eventhub	Egyetlen elem a Lista vagy az Eseményközpont lekérése műveletben
RetentionDescription	Tulajdonságok az eventhub adatmegőrzési beállításainak konfigurálásához
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

CaptureDescription

Az eventhub rögzítési leírásának konfigurálásához szükséges tulajdonságok

Name	Típus	Description
destination	Destination	A célhely tulajdonságai, ahol a rögzítés lesz tárolva. (Tárfiók, blobnevek)
enabled	boolean	Egy érték, amely azt jelzi, hogy engedélyezve van-e a rögzítési leírás.
encoding	EncodingCaptureDescription	Számba adja a rögzítési leírás kódolási formátumának lehetséges értékeit. Megjegyzés: Az "AvroDeflate" elavult lesz az Új API-verzióban
intervalInSeconds	integer	Az időablakban beállíthatja, hogy milyen gyakorisággal történjen a rögzítés az Azure Blobokra, az értéknek 60 és 900 másodperc között kell lennie
sizeLimitInBytes	integer	A méretablak határozza meg az eseményközpontban a rögzítési művelet előtt létrehozott adatok mennyiségét, az értéknek 10485760 és 524288000 bájt között kell lennie
skipEmptyArchives	boolean	Az üres archívumok kihagyását jelző érték

CaptureIdentity

Egy érték, amely azt jelzi, hogy engedélyezve van-e a rögzítési leírás.

Name	Típus	Description
type	CaptureIdentityType	Az Azure Active Directory felügyelt identitásának típusa.
userAssignedIdentity	string	Felügyelt felhasználói identitás ARM-azonosítója. Ehhez a tulajdonsághoz a UserAssignedIdentity típus szükséges. Ha a típus SystemAssigned, akkor a rendszer a névtérhez társított rendszer hozzárendelt identitását fogja használni.

CaptureIdentityType

Az Azure Active Directory felügyelt identitásának típusa.

Name	Típus	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

A törlési szabályzat lehetséges értékeinek számbavétele

Name	Típus	Description
Compact	string
Delete	string

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Tárolási adatok rögzítése a rögzítés leírásához

Name	Típus	Description
identity	CaptureIdentity	Egy érték, amely azt jelzi, hogy engedélyezve van-e a rögzítési leírás.
name	string	A rögzítési cél neve
properties.archiveNameFormat	string	Blobok elnevezési konvenciója az archívumhoz, például: {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Itt az összes paraméter (Névtér, EventHub stb.) kötelező, függetlenül a sorrendtől
properties.blobContainer	string	Blobtároló neve
properties.dataLakeAccountName	string	A rögzített események Azure Data Lake Store-neve
properties.dataLakeFolderPath	string	A rögzített események célmappájának elérési útja
properties.dataLakeSubscriptionId	string	Az Azure Data Lake Store előfizetés-azonosítója
properties.storageAccountResourceId	string	A blobok létrehozásához használni kívánt tárfiók erőforrás-azonosítója

EncodingCaptureDescription

Számba adja a rögzítési leírás kódolási formátumának lehetséges értékeit. Megjegyzés: Az "AvroDeflate" elavult lesz az Új API-verzióban

Name	Típus	Description
Avro	string
AvroDeflate	string

EntityStatus

Az Eseményközpont állapotának lehetséges értékeinek számbavétele.

Name	Típus	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

A hibaválasz azt jelzi, hogy az Event Hub szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

Eventhub

Egyetlen elem a Lista vagy az Eseményközpont lekérése műveletben

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.captureDescription	CaptureDescription	A rögzítési leírás tulajdonságai
properties.createdAt	string	Az Eseményközpont létrehozásának pontos időpontja.
properties.messageRetentionInDays	integer	Az eseményközpont eseményeinek megőrzéséhez szükséges napok száma, az értéknek 1–7 napnak kell lennie
properties.partitionCount	integer	Az Eseményközponthoz létrehozott partíciók száma, az engedélyezett értékek 1 és 32 partíció között vannak.
properties.partitionIds	string[]	A szegmensek aktuális száma az Event Hubon.
properties.retentionDescription	RetentionDescription	Az Event Hub adatmegőrzési beállításai
properties.status	EntityStatus	Az Eseményközpont állapotának lehetséges értékeinek számbavétele.
properties.updatedAt	string	Az üzenet frissítésének pontos időpontja.
properties.userMetadata	string	Lekéri és beállítja a felhasználó metaadatait.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Például "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

RetentionDescription

Tulajdonságok az eventhub adatmegőrzési beállításainak konfigurálásához

Name	Típus	Description
cleanupPolicy	CleanupPolicyRetentionDescription	A törlési szabályzat lehetséges értékeinek számbavétele
retentionTimeInHours	integer	Az eseményközpont eseményeinek megőrzéséhez szükséges órák száma. Ez az érték csak akkor használatos, ha a cleanupPolicy a Delete. Ha a cleanupPolicy kompakt, a tulajdonság visszaadott értéke Long.MaxValue
tombstoneRetentionTimeInHours	integer	A tömörített eseményközpont sírkőjelölőinek megőrzéséhez tartozó órák száma. Ez az érték csak akkor használatos, ha a cleanupPolicy kompakt. A fogyasztónak be kell olvasnia a sírkőjelölőt ezen a megadott időn belül, ha a fogyasztó az eltolás kezdetétől kezdődik, hogy érvényes pillanatképet kapjon a tömörített eseményközpontban található sírkőjelölő által leírt konkrét kulcsról

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.