az eventhubs eventhub

Reference

Manage Azure EventHubs eventhub and authorization-rule.

Commands

az eventhubs eventhub authorization-rule	Manage Azure Service Bus Authorizationrule for Eventhub.
az eventhubs eventhub authorization-rule create	Creates Authorizationrule for the given Eventhub.
az eventhubs eventhub authorization-rule delete	Deletes the Authorizationrule of Eventhub.
az eventhubs eventhub authorization-rule keys	Manage Azure Authorizationrule connection strings for Eventhub.
az eventhubs eventhub authorization-rule keys list	Shows the connection strings of Authorizationrule for the Eventhub.
az eventhubs eventhub authorization-rule keys renew	Regenerate the connection strings of Authorizationrule for the namespace.
az eventhubs eventhub authorization-rule list	Shows the list of Authorization-rules by Eventhub.
az eventhubs eventhub authorization-rule show	Shows the details of Authorizationrule.
az eventhubs eventhub authorization-rule update	Updates Authorizationrule for the given Eventhub.
az eventhubs eventhub consumer-group	Manage Azure Event Hubs consumergroup.
az eventhubs eventhub consumer-group create	Creates the EventHub ConsumerGroup.
az eventhubs eventhub consumer-group delete	Deletes the ConsumerGroup.
az eventhubs eventhub consumer-group list	List the ConsumerGroup by Eventhub.
az eventhubs eventhub consumer-group show	Shows the ConsumerGroup Details.
az eventhubs eventhub consumer-group update	Updates the EventHub ConsumerGroup.
az eventhubs eventhub create	Creates the EventHubs Eventhub.
az eventhubs eventhub delete	Deletes the Eventhub.
az eventhubs eventhub list	List the EventHub by Namespace.
az eventhubs eventhub show	Shows the Eventhub Details.
az eventhubs eventhub update	Updates the EventHubs Eventhub.

az eventhubs eventhub create

Edit

Creates the EventHubs Eventhub.

az eventhubs eventhub create --name
                             --namespace-name
                             --resource-group
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--partition-count]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]

Examples

Create a new Eventhub.

az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --message-retention 4 --partition-count 15

Required Parameters

--name -n

Name of Eventhub.

--namespace-name

Name of Namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--archive-name-format

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.

--blob-container

Blob container Name.

--capture-interval

Allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds.

--capture-size-limit

Defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.

--destination-name

Name for capture destination, should be EventHubArchive.AzureBlockBlob.

--enable-capture

A boolean value that indicates whether capture is enabled.

accepted values: false, true

--partition-count

Number of partitions created for the Event Hub. By default, allowed values are 2-32. Lower value of 1 is supported with Kafka enabled namespaces. In presence of a custom quota, the upper limit will match the upper limit of the quota.

--skip-empty-archives

A boolean value that indicates whether to Skip Empty.

accepted values: false, true

--status

Status of Eventhub.

accepted values: Active, Disabled, SendDisabled

--storage-account

Name (if within same resource group and not of type Classic Storage) or ARM id of the storage account to be used to create the blobs.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs eventhub delete

Edit

Deletes the Eventhub.

az eventhubs eventhub delete [--ids]
                             [--name]
                             [--namespace-name]
                             [--resource-group]
                             [--subscription]

Examples

Deletes the Eventhub

az eventhubs eventhub delete --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of Eventhub.

--namespace-name

Name of Namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs eventhub list

Edit

List the EventHub by Namespace.

az eventhubs eventhub list --namespace-name
                           --resource-group
                           [--skip]
                           [--top]

Examples

Get the Eventhubs by Namespace.

az eventhubs eventhub list --resource-group myresourcegroup --namespace-name mynamespace

Required Parameters

--namespace-name

Name of Namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--skip

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. Default value is None.

--top

May be used to limit the number of results to the most recent N usageDetails. Default value is None.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs eventhub show

Edit

Shows the Eventhub Details.

az eventhubs eventhub show [--ids]
                           [--name]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]

Examples

Shows the Eventhub details.

az eventhubs eventhub show --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub

Optional Parameters

--ids

--name -n

Name of Eventhub.

--namespace-name

Name of Namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs eventhub update

Edit

Updates the EventHubs Eventhub.

az eventhubs eventhub update [--add]
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--force-string]
                             [--ids]
                             [--name]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--set]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--subscription]

Examples

Updates a new Eventhub.

az eventhubs eventhub update --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --message-retention 3 --partition-count 12

Updates the EventHubs Eventhub (autogenerated)

az eventhubs eventhub update --name myeventhub --namespace-name mynamespace --partition-count 12 --resource-group myresourcegroup

Updates the EventHubs Eventhub (autogenerated)

az eventhubs eventhub update --message-retention 3 --name myeventhub --namespace-name mynamespace --resource-group myresourcegroup --subscription MySubscription

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []

--archive-name-format

--blob-container

Blob container Name.

--capture-interval

Allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds.

--capture-size-limit

Defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.

--destination-name

Name for capture destination, should be EventHubArchive.AzureBlockBlob.

--enable-capture

A boolean value that indicates whether capture is enabled.

accepted values: false, true

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False

--ids

--name -n

Name of Eventhub.

--namespace-name

Name of Namespace.

--partition-count

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

default value: []

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

default value: []

--skip-empty-archives

A boolean value that indicates whether to Skip Empty.

accepted values: false, true

--status

Status of Eventhub.

accepted values: Active, Disabled, SendDisabled

--storage-account

Name (if within same resource group and not of type Classic Storage) or ARM id of the storage account to be used to create the blobs.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs eventhub

Commands

az eventhubs eventhub create

Examples

Required Parameters

Optional Parameters

az eventhubs eventhub delete

Examples

Optional Parameters

az eventhubs eventhub list

Examples

Required Parameters

Optional Parameters

az eventhubs eventhub show

Examples

Optional Parameters

az eventhubs eventhub update

Examples

Optional Parameters

Feedback

Additional resources