az eventhubs namespace
Eventhub namespace.
Commands
Name | Description | Type | Status |
---|---|---|---|
az eventhubs namespace application-group |
Manages Application Groups for premium eventhubs namespace. |
Core | GA |
az eventhubs namespace application-group create |
Creates an application group for an EventHub namespace. |
Core | GA |
az eventhubs namespace application-group delete |
Delete an ApplicationGroup for a Namespace. |
Core | GA |
az eventhubs namespace application-group list |
List a list of application groups for a Namespace. |
Core | GA |
az eventhubs namespace application-group policy |
Append or Remove application group policies. |
Core | GA |
az eventhubs namespace application-group policy add |
Appends an application group policy to the existing policy. This cmdlet can be used to append one or more throttling policies. |
Core | GA |
az eventhubs namespace application-group policy remove |
Removes an application group policy from the existing policies. This cmdlet can be used to remove one or more throttling policies. |
Core | GA |
az eventhubs namespace application-group show |
Get an ApplicationGroup for a Namespace. |
Core | GA |
az eventhubs namespace application-group update |
Update an ApplicationGroup for a Namespace. |
Core | GA |
az eventhubs namespace authorization-rule |
Eventhub namespace authorization-rule. |
Core | GA |
az eventhubs namespace authorization-rule create |
Create an AuthorizationRule for a Namespace. |
Core | GA |
az eventhubs namespace authorization-rule delete |
Delete an AuthorizationRule for a Namespace. |
Core | GA |
az eventhubs namespace authorization-rule keys |
Authorization-rule keys. |
Core | GA |
az eventhubs namespace authorization-rule keys list |
Gets the primary and secondary connection strings for the Namespace. |
Core | GA |
az eventhubs namespace authorization-rule keys renew |
Regenerates the primary or secondary connection strings for the specified Namespace. |
Core | GA |
az eventhubs namespace authorization-rule list |
List a list of authorization rules for a Namespace. |
Core | GA |
az eventhubs namespace authorization-rule show |
Get an AuthorizationRule for a Namespace by rule name. |
Core | GA |
az eventhubs namespace authorization-rule update |
Update an AuthorizationRule for a Namespace. |
Core | GA |
az eventhubs namespace create |
Creates the EventHubs Namespace. |
Core | GA |
az eventhubs namespace delete |
Delete an existing namespace. This operation also removes all associated resources under the namespace. |
Core | GA |
az eventhubs namespace encryption |
Manage eventhubs namespace encryption properties. |
Core | GA |
az eventhubs namespace encryption add |
Add Encryption properties to a namespace. |
Core | GA |
az eventhubs namespace encryption remove |
Remove one or more Encryption properties from a namespace. |
Core | GA |
az eventhubs namespace exists |
Check the give Namespace name availability. |
Core | GA |
az eventhubs namespace identity |
Manage eventhubs namespace identity. |
Core | GA |
az eventhubs namespace identity assign |
Assign System or User or System,User assigned identities to a namespace. |
Core | GA |
az eventhubs namespace identity remove |
Remove System or User or System,User assigned identities from a namespace. |
Core | GA |
az eventhubs namespace list |
List all the available Namespaces within a subscription, irrespective of the resource groups. |
Core | GA |
az eventhubs namespace network-rule-set |
Manage Azure EventHubs networkruleset for namespace. |
Core | GA |
az eventhubs namespace network-rule-set create |
Create NetworkRuleSet for a Namespace. |
Core | GA |
az eventhubs namespace network-rule-set ip-rule |
Manage Azure eventhubs ip-rules in networkruleSet for namespace. |
Core | GA |
az eventhubs namespace network-rule-set ip-rule add |
Add a IP-Rule for network rule of namespace. |
Core | GA |
az eventhubs namespace network-rule-set ip-rule remove |
Remove Ip-Rule from network rule of namespace. |
Core | GA |
az eventhubs namespace network-rule-set list |
List NetworkRuleSet for a Namespace. |
Core | GA |
az eventhubs namespace network-rule-set show |
Get NetworkRuleSet for a Namespace. |
Core | GA |
az eventhubs namespace network-rule-set update |
Update NetworkRuleSet for a Namespace. |
Core | GA |
az eventhubs namespace network-rule-set virtual-network-rule |
Manage Azure eventhubs subnet-rule in networkruleSet for namespace. |
Core | GA |
az eventhubs namespace network-rule-set virtual-network-rule add |
Add a Virtual-Network-Rule for network rule of namespace. |
Core | GA |
az eventhubs namespace network-rule-set virtual-network-rule remove |
Remove network rule for a namespace. |
Core | GA |
az eventhubs namespace private-endpoint-connection |
Manage eventhubs namespace private endpoint connection. |
Core | GA |
az eventhubs namespace private-endpoint-connection approve |
Approve a private endpoint connection request for eventhubs namesapce. |
Core | GA |
az eventhubs namespace private-endpoint-connection create |
Create PrivateEndpointConnections of service namespace. |
Core | GA |
az eventhubs namespace private-endpoint-connection delete |
Delete a private endpoint connection request for eventhubs namespace. |
Core | GA |
az eventhubs namespace private-endpoint-connection list |
List the available PrivateEndpointConnections within a namespace. |
Core | GA |
az eventhubs namespace private-endpoint-connection reject |
Reject a private endpoint connection request for eventhubs namespace. |
Core | GA |
az eventhubs namespace private-endpoint-connection show |
Get a description for the specified Private Endpoint Connection name. |
Core | GA |
az eventhubs namespace private-endpoint-connection update |
Update PrivateEndpointConnections of service namespace. |
Core | GA |
az eventhubs namespace private-endpoint-connection wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az eventhubs namespace private-link-resource |
Manage eventhubs namespace private link resources . |
Core | GA |
az eventhubs namespace private-link-resource show |
List lists of resources that supports Privatelinks. |
Core | GA |
az eventhubs namespace schema-registry |
Manages eventhubs namespace schema registry. |
Core | GA |
az eventhubs namespace schema-registry create |
Create an EventHub schema group. |
Core | GA |
az eventhubs namespace schema-registry delete |
Delete an EventHub schema group. |
Core | GA |
az eventhubs namespace schema-registry list |
List all the Schema Groups in a Namespace. |
Core | GA |
az eventhubs namespace schema-registry show |
Get the details of an EventHub schema group. |
Core | GA |
az eventhubs namespace schema-registry update |
Update an EventHub schema group. |
Core | GA |
az eventhubs namespace show |
Get the description of the specified namespace. |
Core | GA |
az eventhubs namespace update |
Update a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
Core | GA |
az eventhubs namespace wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az eventhubs namespace create
Creates the EventHubs Namespace.
az eventhubs namespace create --name
--resource-group
[--alternate-name]
[--capacity]
[--cluster-arm-id]
[--disable-local-auth {false, true}]
[--enable-auto-inflate {false, true}]
[--enable-kafka {false, true}]
[--encryption-config]
[--infra-encryption {false, true}]
[--location]
[--maximum-throughput-units]
[--mi-system-assigned {false, true}]
[--mi-user-assigned]
[--min-tls {1.0, 1.1, 1.2}]
[--public-network {Disabled, Enabled}]
[--sku {Basic, Premium, Standard}]
[--tags]
[--zone-redundant {false, true}]
Examples
Creates a new namespace.
az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard --enable-auto-inflate --maximum-throughput-units 20
Create a new namespace with Identity and Encryption enabled.
az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
Required Parameters
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Alternate name specified when alias and namespace names are same.
Capacity for Sku.
Cluster ARM ID of the Namespace.
A boolean value that indicates whether SAS authentication is enabled/disabled for the Event Hubs.
A boolean value that indicates whether AutoInflate is enabled for eventhub namespace.
A boolean value that indicates whether Kafka is enabled for eventhub namespace.
List of KeyVaultProperties objects.
A boolean value that indicates whether Infrastructure Encryption (Double Encryption) is enabled/disabled.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( 0 if AutoInflateEnabled = true).
Enable System Assigned Identity.
List of User Assigned Identity ids.
The minimum TLS version for the cluster to support, e.g. 1.2.
This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile' access rules.
Namespace SKU.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Enabling this property creates a Standard EventHubs Namespace in regions supported availability zones.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs namespace delete
Delete an existing namespace. This operation also removes all associated resources under the namespace.
az eventhubs namespace delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Delete the Namespace
az eventhubs namespace delete --resource-group myresourcegroup --name mynamespace
Optional Parameters
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.
The Namespace name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs namespace exists
Check the give Namespace name availability.
az eventhubs namespace exists --name
Required Parameters
Name to check the namespace name availability.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs namespace list
List all the available Namespaces within a subscription, irrespective of the resource groups.
az eventhubs namespace list [--max-items]
[--next-token]
[--resource-group]
Examples
List the Event Hubs Namespaces by resource group.
az eventhubs namespace list --resource-group myresourcegroup
Get the Namespaces by Subscription.
az eventhubs namespace list
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs namespace show
Get the description of the specified namespace.
az eventhubs namespace show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
shows the Namespace details.
az eventhubs namespace show --resource-group myresourcegroup --name mynamespace
Optional Parameters
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.
The Namespace name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs namespace update
Update a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
az eventhubs namespace update [--add]
[--alternate-name]
[--capacity]
[--cluster-arm-id]
[--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-auto-inflate {0, 1, f, false, n, no, t, true, y, yes}]
[--encryption]
[--endpoint-connections]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--kafka-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--maximum-throughput-units]
[--minimum-tls-version {1.0, 1.1, 1.2}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
[--remove]
[--resource-group]
[--set]
[--sku {Basic, Premium, Standard}]
[--subscription]
[--tags]
[--tier {Basic, Premium, Standard}]
[--zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]
Examples
Update a new namespace.
az eventhubs namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value --enable-auto-inflate True
Optional Parameters
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>.
Alternate name specified when alias and namespace names are same.
The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.
Cluster ARM ID of the Namespace.
This property disables SAS authentication for the Event Hubs namespace.
Value that indicates whether AutoInflate is enabled for eventhub namespace.
Properties of BYOK Encryption description Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of private endpoint connections. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Properties of BYOK Identity description Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Value that indicates whether Kafka is enabled for eventhub namespace.
Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true).
The minimum TLS version for the cluster to support, e.g. '1.2'.
The Namespace name.
Do not wait for the long-running operation to finish.
This determines if traffic is allowed over public network. By default it is enabled.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name of this SKU.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The billing tier of this particular SKU.
Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs namespace wait
Place the CLI in a waiting state until a condition is met.
az eventhubs namespace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The Namespace name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI