Namespaces - Create Or Update

Reference

Service:: Event Hubs

API Version:: 2017-04-01

Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	The Namespace name Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Name of the resource group within the azure subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API Version.

Request Body

Name	Type	Description
parameters	EHNamespace	Parameters for creating a namespace resource.

Responses

Name	Type	Description
200 OK	EHNamespace	Namespace successfully created.
201 Created	EHNamespace	Namespace create request accepted.
202 Accepted		Namespace create or update request accepted.
Other Status Codes	ErrorResponse	Eventhub error response describing why the operation failed.

Security

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	impersonate your user account

Examples

NamespaceCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849?api-version=2017-04-01

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Sample Response

Status code:: 200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849",
  "name": "sdk-Namespace-5849",
  "type": "Microsoft.EventHub/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "isAutoInflateEnabled": false,
    "maximumThroughputUnits": 0,
    "provisioningState": "Created",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849",
    "createdAt": "2017-05-24T23:23:27.877Z",
    "updatedAt": "2017-05-24T23:23:27.877Z",
    "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/"
  }
}

Status code:: 201

{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849",
  "name": "sdk-Namespace-5849",
  "type": "Microsoft.EventHub/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "isAutoInflateEnabled": false,
    "maximumThroughputUnits": 0,
    "provisioningState": "Created",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849",
    "createdAt": "2017-05-24T23:23:27.877Z",
    "updatedAt": "2017-05-24T23:23:27.877Z",
    "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/"
  }
}

Status code:: 202

Definitions

Name	Description
EHNamespace	Single Namespace item in List or Get Operation
ErrorResponse	Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.
Sku	Properties of sku resource
SkuName	Name of this SKU.
SkuTier	The billing tier of this particular SKU.

EHNamespace

Single Namespace item in List or Get Operation

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Resource location.
name	string	The name of the resource
properties.createdAt	string	The time the Namespace was created.
properties.isAutoInflateEnabled	boolean	Value that indicates whether AutoInflate is enabled for eventhub namespace.
properties.kafkaEnabled	boolean	Value that indicates whether Kafka is enabled for eventhub namespace.
properties.maximumThroughputUnits	integer	Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)
properties.metricId	string	Identifier for Azure Insights metrics.
properties.provisioningState	string	Provisioning state of the Namespace.
properties.serviceBusEndpoint	string	Endpoint you can use to perform Service Bus operations.
properties.updatedAt	string	The time the Namespace was updated.
sku	Sku	Properties of sku resource
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorResponse

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

Sku

Properties of sku resource

Name	Type	Description
capacity	integer	The Event Hubs throughput units, value should be 0 to 20 throughput units.
name	SkuName	Name of this SKU.
tier	SkuTier	The billing tier of this particular SKU.

SkuName

Name of this SKU.

Name	Type	Description
Basic	string
Standard	string

SkuTier

The billing tier of this particular SKU.

Name	Type	Description
Basic	string
Standard	string

Share via