Delen via

Event Hubs - Create Or Update

  • Referentie
Service:
Event Hubs
API-versie:
2024-01-01

Hiermee wordt een nieuwe Event Hub gemaakt of bijgewerkt als een geneste resource binnen een naamruimte.

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

URI-parameters

Name In Vereist Type Description
eventHubName
 path True

string

De naam van de Event Hub
namespaceName
 path True

string

De naam van de naamruimte

Regex-patroon: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId
 path True

string

Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version
 query True

string

Client-API-versie.

Aanvraagbody

Name Type Description
properties.captureDescription

CaptureDescription

Eigenschappen van de beschrijving van de opname
properties.messageRetentionInDays

integer

Aantal dagen voor het bewaren van de gebeurtenissen voor deze Event Hub. De waarde moet 1 tot 7 dagen zijn
properties.partitionCount

integer

Het aantal partities dat is gemaakt voor de Event Hub. Toegestane waarden liggen tussen 1 en 32 partities.
properties.retentionDescription

RetentionDescription

Retentie-instellingen voor Event Hub
properties.status

EntityStatus

Inventariseert de mogelijke waarden voor de status van de Event Hub.
properties.userMetadata

string

Hiermee worden metagegevens van de gebruiker opgehaald en ingesteld.

Antwoorden

Name Type Description
200 OK

Eventhub

Event Hub is gemaakt.
Other Status Codes

ErrorResponse

Eventhub-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

EventHubCreate

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CaptureDescription

Eigenschappen voor het configureren van de capture-beschrijving voor eventhub
CaptureIdentity

Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.
CaptureIdentityType

Type beheerde identiteit van Azure Active Directory.
CleanupPolicyRetentionDescription

Inventariseert de mogelijke waarden voor opschoningsbeleid
createdByType

Het type identiteit waarmee de resource is gemaakt.
Destination

Opslagdetails vastleggen voor een beschrijving van de opname
EncodingCaptureDescription

Inventariseert de mogelijke waarden voor de coderingsindeling van de beschrijving van de opname. Opmerking: AvroDeflate wordt afgeschaft in nieuwe API-versie
EntityStatus

Inventariseert de mogelijke waarden voor de status van de Event Hub.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.
Eventhub

Eén item in De bewerking Lijst of Event Hub ophalen
RetentionDescription

Eigenschappen voor het configureren van retentie-instellingen voor eventhub
systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

CaptureDescription

Eigenschappen voor het configureren van de capture-beschrijving voor eventhub

Name Type Description
destination

Destination

Eigenschappen van bestemming waar de opname wordt opgeslagen. (Opslagaccount, blobnamen)
enabled

boolean

Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.
encoding

EncodingCaptureDescription

Inventariseert de mogelijke waarden voor de coderingsindeling van de beschrijving van de opname. Opmerking: AvroDeflate wordt afgeschaft in nieuwe API-versie
intervalInSeconds

integer

Met het tijdvenster kunt u de frequentie instellen waarmee het vastleggen naar Azure-blobs wordt uitgevoerd, een waarde tussen 60 en 900 seconden
sizeLimitInBytes

integer

Het groottevenster definieert de hoeveelheid gegevens die is opgebouwd in uw Event Hub vóór een opnamebewerking. De waarde moet tussen 10485760 en 524288000 bytes zijn
skipEmptyArchives

boolean

Een waarde die aangeeft of lege archieven moeten worden overgeslagen

CaptureIdentity

Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.

Name Type Description
type

CaptureIdentityType

Type beheerde identiteit van Azure Active Directory.
userAssignedIdentity

string

ARM-id van beheerde gebruikersidentiteit. Deze eigenschap is vereist is het type UserAssignedIdentity. Als het type SystemAssigned is, wordt de door het systeem toegewezen identiteit die is gekoppeld aan de naamruimte gebruikt.

CaptureIdentityType

Type beheerde identiteit van Azure Active Directory.

Name Type Description
SystemAssigned

string

UserAssigned

string

CleanupPolicyRetentionDescription

Inventariseert de mogelijke waarden voor opschoningsbeleid

Name Type Description
Compact

string

Delete

string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

Destination

Opslagdetails vastleggen voor een beschrijving van de opname

Name Type Description
identity

CaptureIdentity

Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.
name

string

Naam voor opnamebestemming
properties.archiveNameFormat

string

Blob-naamconventie voor archief, bijvoorbeeld {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Hier zijn alle parameters (naamruimte, EventHub enz.) verplicht, ongeacht de volgorde
properties.blobContainer

string

Naam van blobcontainer
properties.dataLakeAccountName

string

De Azure Data Lake Store-naam voor de vastgelegde gebeurtenissen
properties.dataLakeFolderPath

string

Het pad naar de doelmap voor de vastgelegde gebeurtenissen
properties.dataLakeSubscriptionId

string

Abonnements-id van Azure Data Lake Store
properties.storageAccountResourceId

string

Resource-id van het opslagaccount dat moet worden gebruikt om de blobs te maken

EncodingCaptureDescription

Inventariseert de mogelijke waarden voor de coderingsindeling van de beschrijving van de opname. Opmerking: AvroDeflate wordt afgeschaft in nieuwe API-versie

Name Type Description
Avro

string

AvroDeflate

string

EntityStatus

Inventariseert de mogelijke waarden voor de status van de Event Hub.

Name Type Description
Active

string

Creating

string

Deleting

string

Disabled

string

ReceiveDisabled

string

Renaming

string

Restoring

string

SendDisabled

string

Unknown

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.

Name Type Description
error

ErrorDetail

Het foutobject.

Eventhub

Eén item in De bewerking Lijst of Event Hub ophalen

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

De geografische locatie waar de resource zich bevindt
name

string

De naam van de resource
properties.captureDescription

CaptureDescription

Eigenschappen van de beschrijving van de opname
properties.createdAt

string

Exact tijdstip waarop de Event Hub is gemaakt.
properties.messageRetentionInDays

integer

Aantal dagen voor het bewaren van de gebeurtenissen voor deze Event Hub. De waarde moet 1 tot 7 dagen zijn
properties.partitionCount

integer

Het aantal partities dat is gemaakt voor de Event Hub. Toegestane waarden liggen tussen 1 en 32 partities.
properties.partitionIds

string[]

Huidig aantal shards op de Event Hub.
properties.retentionDescription

RetentionDescription

Retentie-instellingen voor Event Hub
properties.status

EntityStatus

Inventariseert de mogelijke waarden voor de status van de Event Hub.
properties.updatedAt

string

Het exacte tijdstip waarop het bericht is bijgewerkt.
properties.userMetadata

string

Hiermee worden metagegevens van de gebruiker opgehaald en ingesteld.
systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

RetentionDescription

Eigenschappen voor het configureren van retentie-instellingen voor eventhub

Name Type Description
cleanupPolicy

CleanupPolicyRetentionDescription

Inventariseert de mogelijke waarden voor opschoningsbeleid
retentionTimeInHours

integer

Aantal uren voor het bewaren van de gebeurtenissen voor deze Event Hub. Deze waarde wordt alleen gebruikt wanneer cleanupPolicy Delete is. Als cleanupPolicy Compact is, is de geretourneerde waarde van deze eigenschap Long.MaxValue
tombstoneRetentionTimeInHours

integer

Aantal uren voor het bewaren van de tombstone-markeringen van een gecomprimeerde Event Hub. Deze waarde wordt alleen gebruikt wanneer cleanupPolicy Compact is. De consument moet de tombstone-markering binnen deze opgegeven tijd voltooien als de consument begint met het starten van offset om ervoor te zorgen dat deze een geldige momentopname krijgt voor de specifieke sleutel die wordt beschreven door de tombstone-markering in de gecomprimeerde Event Hub

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string

Het type identiteit dat de resource het laatst heeft gewijzigd.
lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.