Event Hubs - Create Or Update

Odwołanie

Service:: Event Hubs

API Version:: 2024-01-01

Tworzy lub aktualizuje nowe centrum zdarzeń jako zagnieżdżony zagnieżdżony zasób w przestrzeni nazw.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
eventHubName	path	True	string	Nazwa centrum zdarzeń
namespaceName	path	True	string	Nazwa przestrzeni nazw Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
properties.captureDescription	CaptureDescription	Właściwości opisu przechwytywania
properties.messageRetentionInDays	integer	Liczba dni przechowywania zdarzeń dla tego centrum zdarzeń, wartość powinna wynosić od 1 do 7 dni
properties.partitionCount	integer	Liczba partycji utworzonych dla centrum zdarzeń dozwolonych wartości to od 1 do 32 partycji.
properties.retentionDescription	RetentionDescription	Ustawienia przechowywania centrum zdarzeń
properties.status	EntityStatus	Wylicza możliwe wartości stanu centrum zdarzeń.
properties.userMetadata	string	Pobiera i ustawia metadane użytkownika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Eventhub	Centrum zdarzeń zostało pomyślnie utworzone.
Other Status Codes	ErrorResponse	Odpowiedź o błędzie usługi EventHub opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
CaptureDescription	Właściwości służące do konfigurowania opisu przechwytywania dla usługi EventHub
CaptureIdentity	Wartość wskazująca, czy opis przechwytywania jest włączony.
CaptureIdentityType	Typ tożsamości zarządzanej usługi Azure Active Directory.
CleanupPolicyRetentionDescription	Wylicza możliwe wartości zasad oczyszczania
createdByType	Typ tożsamości, która utworzyła zasób.
Destination	Przechwytywanie szczegółów magazynu w celu uzyskania opisu przechwytywania
EncodingCaptureDescription	Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: "AvroDeflate" zostanie wycofana w nowej wersji interfejsu API
EntityStatus	Wylicza możliwe wartości stanu centrum zdarzeń.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
Eventhub	Pojedynczy element w operacji List lub Get Event Hub
RetentionDescription	Właściwości służące do konfigurowania ustawień przechowywania dla usługi EventHub
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CaptureDescription

Właściwości służące do konfigurowania opisu przechwytywania dla usługi EventHub

Nazwa	Typ	Opis
destination	Destination	Właściwości miejsca docelowego, w którym będzie przechowywane przechwytywanie. (Konto magazynu, nazwy obiektów blob)
enabled	boolean	Wartość wskazująca, czy opis przechwytywania jest włączony.
encoding	EncodingCaptureDescription	Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: "AvroDeflate" zostanie wycofana w nowej wersji interfejsu API
intervalInSeconds	integer	Przedział czasu umożliwia ustawienie częstotliwości, z jaką nastąpi przechwytywanie do obiektów blob platformy Azure, wartość powinna wynosić od 60 do 900 sekund
sizeLimitInBytes	integer	Okno rozmiaru definiuje ilość danych utworzonych w centrum zdarzeń przed operacją przechwytywania, wartość powinna należeć między 10485760 a 524288000 bajtami
skipEmptyArchives	boolean	Wartość wskazująca, czy pominąć puste archiwa

CaptureIdentity

Wartość wskazująca, czy opis przechwytywania jest włączony.

Nazwa	Typ	Opis
type	CaptureIdentityType	Typ tożsamości zarządzanej usługi Azure Active Directory.
userAssignedIdentity	string	Identyfikator usługi ARM tożsamości użytkownika zarządzanego. Ta właściwość jest wymagana, jest typem UserAssignedIdentity. Jeśli typ to SystemAssigned, zostanie użyta tożsamość przypisana przez system skojarzona z przestrzenią nazw.

CaptureIdentityType

Typ tożsamości zarządzanej usługi Azure Active Directory.

Nazwa	Typ	Opis
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Wylicza możliwe wartości zasad oczyszczania

Nazwa	Typ	Opis
Compact	string
Delete	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Przechwytywanie szczegółów magazynu w celu uzyskania opisu przechwytywania

Nazwa	Typ	Opis
identity	CaptureIdentity	Wartość wskazująca, czy opis przechwytywania jest włączony.
name	string	Nazwa miejsca docelowego przechwytywania
properties.archiveNameFormat	string	Konwencja nazewnictwa obiektów blob dla archiwum, np. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Tutaj wszystkie parametry (przestrzeń nazw, eventhub itp.) są obowiązkowe niezależnie od kolejności
properties.blobContainer	string	Nazwa kontenera obiektów blob
properties.dataLakeAccountName	string	Nazwa usługi Azure Data Lake Store dla przechwyconych zdarzeń
properties.dataLakeFolderPath	string	Ścieżka folderu docelowego dla przechwyconych zdarzeń
properties.dataLakeSubscriptionId	string	Identyfikator subskrypcji usługi Azure Data Lake Store
properties.storageAccountResourceId	string	Identyfikator zasobu konta magazynu do utworzenia obiektów blob

EncodingCaptureDescription

Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: "AvroDeflate" zostanie wycofana w nowej wersji interfejsu API

Nazwa	Typ	Opis
Avro	string
AvroDeflate	string

EntityStatus

Wylicza możliwe wartości stanu centrum zdarzeń.

Nazwa	Typ	Opis
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Eventhub

Pojedynczy element w operacji List lub Get Event Hub

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.captureDescription	CaptureDescription	Właściwości opisu przechwytywania
properties.createdAt	string	Dokładny czas utworzenia centrum zdarzeń.
properties.messageRetentionInDays	integer	Liczba dni przechowywania zdarzeń dla tego centrum zdarzeń, wartość powinna wynosić od 1 do 7 dni
properties.partitionCount	integer	Liczba partycji utworzonych dla centrum zdarzeń dozwolonych wartości to od 1 do 32 partycji.
properties.partitionIds	string[]	Bieżąca liczba fragmentów w centrum zdarzeń.
properties.retentionDescription	RetentionDescription	Ustawienia przechowywania centrum zdarzeń
properties.status	EntityStatus	Wylicza możliwe wartości stanu centrum zdarzeń.
properties.updatedAt	string	Dokładny czas aktualizacji komunikatu.
properties.userMetadata	string	Pobiera i ustawia metadane użytkownika.
systemData	systemData	Dane metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

RetentionDescription

Właściwości służące do konfigurowania ustawień przechowywania dla usługi EventHub

Nazwa	Typ	Opis
cleanupPolicy	CleanupPolicyRetentionDescription	Wylicza możliwe wartości zasad oczyszczania
retentionTimeInHours	integer	Liczba godzin przechowywania zdarzeń dla tego centrum zdarzeń. Ta wartość jest używana tylko wtedy, gdy funkcja cleanupPolicy to Delete. Jeśli funkcja cleanupPolicy to Compact, zwracana wartość tej właściwości to Long.MaxValue
tombstoneRetentionTimeInHours	integer	Liczba godzin przechowywania markerów nagrobnych zagęszczonego centrum zdarzeń. Ta wartość jest używana tylko wtedy, gdy funkcja cleanupPolicy to Compact. Użytkownik musi ukończyć odczytywanie znacznika nagrobka w tym określonym czasie, jeśli użytkownik zaczyna rozpoczynać przesunięcie, aby upewnić się, że otrzyma prawidłową migawkę dla określonego klucza opisanego przez znacznik nagrobka w zagęszczonym centrum zdarzeń

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.