{ "swagger": "2.0", "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs": { "get": { "tags": [ "EventHubs" ], "operationId": "EventHubs_ListByNamespace", "x-ms-examples": { "EventHubsListAll": { "$ref": "./examples/EventHubs/EHEventHubListByNameSpace.json" } }, "description": "Gets all the Event Hubs in a Namespace.", "parameters": [ { "$ref": "./common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/SkipParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/TopParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of Event Hubs.", "schema": { "$ref": "#/definitions/EventHubListResult" } }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { "$ref": "./common/v2/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}": { "put": { "tags": [ "EventHubs" ], "operationId": "EventHubs_CreateOrUpdate", "x-ms-examples": { "EventHubCreate": { "$ref": "./examples/EventHubs/EHEventHubCreate.json" } }, "description": "Creates or updates a new Event Hub as a nested resource within a Namespace.", "parameters": [ { "$ref": "./common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/EventHubNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Eventhub" }, "description": "Parameters supplied to create an Event Hub resource." }, { "$ref": "./common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Event Hub successfully created.", "schema": { "$ref": "#/definitions/Eventhub" } }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { "$ref": "./common/v2/definitions.json#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "EventHubs" ], "operationId": "EventHubs_Delete", "x-ms-examples": { "EventHubDelete": { "$ref": "./examples/EventHubs/EHEventHubDelete.json" } }, "description": "Deletes an Event Hub from the specified Namespace and resource group.", "parameters": [ { "$ref": "./common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/EventHubNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Event Hub successfully deleted." }, "204": { "description": "No content." }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { "$ref": "./common/v2/definitions.json#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "EventHubs" ], "operationId": "EventHubs_Get", "x-ms-examples": { "EventHubGet": { "$ref": "./examples/EventHubs/EHEventHubGet.json" } }, "description": "Gets an Event Hubs description for the specified Event Hub.", "parameters": [ { "$ref": "./common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/EventHubNameParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "./common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved the Event Hub description.", "schema": { "$ref": "#/definitions/Eventhub" } }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { "$ref": "./common/v2/definitions.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "CaptureDescription": { "properties": { "enabled": { "type": "boolean", "description": "A value that indicates whether capture description is enabled. " }, "encoding": { "type": "string", "description": "Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version", "enum": [ "Avro", "AvroDeflate" ], "x-ms-enum": { "name": "EncodingCaptureDescription", "modelAsString": false } }, "intervalInSeconds": { "format": "int32", "type": "integer", "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" }, "sizeLimitInBytes": { "format": "int32", "type": "integer", "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes" }, "destination": { "$ref": "#/definitions/Destination", "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" }, "skipEmptyArchives": { "type": "boolean", "description": "A value that indicates whether to Skip Empty Archives" } }, "description": "Properties to configure capture description for eventhub" }, "RetentionDescription": { "type": "object", "properties": { "cleanupPolicy": { "type": "string", "description": "Enumerates the possible values for cleanup policy", "enum": [ "Delete", "Compact" ], "x-ms-enum": { "name": "CleanupPolicyRetentionDescription", "modelAsString": true } }, "retentionTimeInHours": { "format": "int64", "type": "integer", "description": "Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue " }, "tombstoneRetentionTimeInHours": { "format": "int32", "type": "integer", "description": "Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub" } }, "description": "Properties to configure retention settings for the eventhub" }, "Eventhub": { "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "partitionIds": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Current number of shards on the Event Hub." }, "createdAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "Exact time the Event Hub was created." }, "updatedAt": { "readOnly": true, "format": "date-time", "type": "string", "description": "The exact time the message was updated." }, "messageRetentionInDays": { "format": "int64", "type": "integer", "minimum": 1, "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" }, "partitionCount": { "format": "int64", "type": "integer", "minimum": 1, "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." }, "status": { "type": "string", "description": "Enumerates the possible values for the status of the Event Hub.", "enum": [ "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", "Unknown" ], "x-ms-enum": { "name": "EntityStatus", "modelAsString": false } }, "userMetadata": { "type": "string", "description": "Gets and Sets Metadata of User." }, "captureDescription": { "$ref": "#/definitions/CaptureDescription", "description": "Properties of capture description" }, "retentionDescription": { "$ref": "#/definitions/RetentionDescription", "description": "Event Hub retention settings" } }, "description": "Properties supplied to the Create Or Update Event Hub operation." }, "systemData": { "readOnly": true, "description": "The system meta data relating to this resource.", "$ref": "./common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { "$ref": "./common/v2/definitions.json#/definitions/ProxyResource" } ], "description": "Single item in List or Get Event Hub operation" }, "EventHubListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Eventhub" }, "description": "Result of the List EventHubs operation." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if Value contains incomplete list of EventHubs." } }, "description": "The result of the List EventHubs operation." }, "CaptureIdentity": { "type": "object", "description": "A value that indicates whether capture description is enabled.", "properties": { "type": { "type": "string", "description": "Type of Azure Active Directory Managed Identity.", "enum": [ "SystemAssigned", "UserAssigned" ], "x-ms-enum": { "name": "CaptureIdentityType", "modelAsString": false } }, "userAssignedIdentity": { "type": "string", "description": "ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used." } } }, "Destination": { "properties": { "name": { "type": "string", "description": "Name for capture destination" }, "identity": { "$ref": "#/definitions/CaptureIdentity" }, "properties": { "x-ms-client-flatten": true, "properties": { "storageAccountResourceId": { "type": "string", "description": "Resource id of the storage account to be used to create the blobs" }, "blobContainer": { "type": "string", "description": "Blob container Name" }, "archiveNameFormat": { "type": "string", "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" }, "dataLakeSubscriptionId": { "type": "string", "format": "uuid", "description": "Subscription Id of Azure Data Lake Store" }, "dataLakeAccountName": { "type": "string", "description": "The Azure Data Lake Store name for the captured events" }, "dataLakeFolderPath": { "type": "string", "description": "The destination folder path for the captured events" } }, "description": "Properties describing the storage account, blob container and archive name format for capture destination" } }, "description": "Capture storage details for capture description" } }, "parameters": {} }