az eventgrid namespace

Note

This reference is part of the eventgrid extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az eventgrid namespace command. Learn more about extensions.

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage eventgrid namespace.

Commands

Name	Description	Type	Status
az eventgrid namespace ca-certificate	Manage eventgrid namespace ca-certificate.	Extension	Preview
az eventgrid namespace ca-certificate create	Create a CA certificate.	Extension	Preview
az eventgrid namespace ca-certificate delete	Delete an existing CA certificate.	Extension	Preview
az eventgrid namespace ca-certificate list	List all the CA certificates under a namespace.	Extension	Preview
az eventgrid namespace ca-certificate show	Show a CA certificate.	Extension	Preview
az eventgrid namespace ca-certificate update	Update a CA certificate with the specified parameters.	Extension	Preview
az eventgrid namespace ca-certificate wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace client	Manage eventgrid namespace client.	Extension	Preview
az eventgrid namespace client-group	Manage eventgrid namespace client-group.	Extension	Preview
az eventgrid namespace client-group create	Create a client group.	Extension	Preview
az eventgrid namespace client-group delete	Delete an existing client group.	Extension	Preview
az eventgrid namespace client-group list	List all the client groups under a namespace.	Extension	Preview
az eventgrid namespace client-group show	Show a client group.	Extension	Preview
az eventgrid namespace client-group update	Update a client group.	Extension	Preview
az eventgrid namespace client-group wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace client create	Create a client.	Extension	Preview
az eventgrid namespace client delete	Delete an existing client.	Extension	Preview
az eventgrid namespace client list	List all the client under a namespace.	Extension	Preview
az eventgrid namespace client show	Show a client.	Extension	Preview
az eventgrid namespace client update	Update a client.	Extension	Preview
az eventgrid namespace client wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace create	Create a new namespace.	Extension	Preview
az eventgrid namespace delete	Delete existing namespace.	Extension	Preview
az eventgrid namespace list	List all the namespaces under an Azure subscription.	Extension	Preview
az eventgrid namespace list-key	List the two keys used to publish to a namespace.	Extension	Preview
az eventgrid namespace permission-binding	Manage eventgrid namespace permission binding.	Extension	Preview
az eventgrid namespace permission-binding create	Create a permission binding.	Extension	Preview
az eventgrid namespace permission-binding delete	Delete an existing permission binding.	Extension	Preview
az eventgrid namespace permission-binding list	List all the permission bindings under a namespace.	Extension	Preview
az eventgrid namespace permission-binding show	Show a permission binding.	Extension	Preview
az eventgrid namespace permission-binding update	Update a permission binding.	Extension	Preview
az eventgrid namespace permission-binding wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace regenerate-key	Regenerate a shared access key for a namespace.	Extension	Preview
az eventgrid namespace show	Show a namespace.	Extension	Preview
az eventgrid namespace topic	Manage eventgrid namespace topic.	Extension	Preview
az eventgrid namespace topic-space	Manage eventgrid namespace topic space.	Extension	Preview
az eventgrid namespace topic-space create	Create a topic space.	Extension	Preview
az eventgrid namespace topic-space delete	Delete an existing topic space.	Extension	Preview
az eventgrid namespace topic-space list	List all the topic spaces under a namespace.	Extension	Preview
az eventgrid namespace topic-space show	Show a topic space.	Extension	Preview
az eventgrid namespace topic-space update	Update a topic space.	Extension	Preview
az eventgrid namespace topic-space wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace topic create	Create a new namespace topic.	Extension	Preview
az eventgrid namespace topic delete	Delete existing namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription	Manage eventgrid namespace topic event subscription.	Extension	Preview
az eventgrid namespace topic event-subscription create	Create an event subscription of a namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription delete	Delete an existing event subscription of a namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription list	List event subscriptions that belong to a specific namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription show	Show an event subscription of a namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription update	Update an event subscription of a namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace topic list	List all the namespace topics under a namespace.	Extension	Preview
az eventgrid namespace topic list-key	List the two keys used to publish to a namespace topic.	Extension	Preview
az eventgrid namespace topic regenerate-key	Regenerate a shared access key for a namespace topic.	Extension	Preview
az eventgrid namespace topic show	Show a namespace topic.	Extension	Preview
az eventgrid namespace topic update	Update a namespace topic.	Extension	Preview
az eventgrid namespace topic wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az eventgrid namespace update	Update a namespace.	Extension	Preview
az eventgrid namespace wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az eventgrid namespace create

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new namespace.

az eventgrid namespace create --name --namespace-name
                              --resource-group
                              [--identity]
                              [--inbound-ip-rules]
                              [--is-zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]
                              [--location]
                              [--minimum-tls-version-allowed {1.0, 1.1, 1.2}]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--private-endpoint-connections]
                              [--public-network-access {Disabled, Enabled}]
                              [--sku]
                              [--tags]
                              [--topic-spaces-configuration]

Examples

Create namespace

az eventgrid namespace create -g rg -n namespace

Required Parameters

--name --namespace-name -n

Name of the namespace.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--identity

Identity information for the Namespace resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	NamespaceInfo Arguments

--inbound-ip-rules

This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--is-zone-redundant

Allows the user to specify if the service is zone-redundant.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--location -l

Location of the resource. When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	NamespaceInfo Arguments

--minimum-tls-version-allowed

Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	1.0, 1.1, 1.2

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--private-endpoint-connections

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--public-network-access

This determines if traffic is allowed over public network.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--sku

Represents available Sku pricing tiers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	NamespaceInfo Arguments

--tags

Tags of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	NamespaceInfo Arguments

--topic-spaces-configuration

Topic spaces configuration information for the namespace resource Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventgrid namespace delete

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete existing namespace.

az eventgrid namespace delete [--ids]
                              [--name --namespace-name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]
                              [--yes]

Examples

Delete namespace

az eventgrid namespace delete -g rg -n namespace

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --namespace-name -n

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace list

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the namespaces under an Azure subscription.

az eventgrid namespace list [--filter]
                            [--max-items]
                            [--next-token]
                            [--resource-group]
                            [--top]

Examples

List namespace

az eventgrid namespace list -g rg

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

--max-items

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.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--resource-group -g

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

--top

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventgrid namespace list-key

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the two keys used to publish to a namespace.

az eventgrid namespace list-key [--ids]
                                [--namespace-name]
                                [--resource-group]
                                [--subscription]

Examples

List key

az eventgrid namespace list-key -g rg --namespace-name name

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace regenerate-key

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate a shared access key for a namespace.

az eventgrid namespace regenerate-key --key-name
                                      [--ids]
                                      [--namespace-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]

Examples

Regenerate key

az eventgrid namespace regenerate-key -g rg --namespace-name name --key-name key1

Required Parameters

--key-name

Key name to regenerate key1 or key2.

Property	Value
Parameter group:	RegenerateKeyRequest Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the Namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace show

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a namespace.

az eventgrid namespace show [--ids]
                            [--name --namespace-name]
                            [--resource-group]
                            [--subscription]

Examples

Show namespace

az eventgrid namespace show -g rg -n namespace

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --namespace-name -n

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace update

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a namespace.

az eventgrid namespace update [--identity]
                              [--ids]
                              [--inbound-ip-rules]
                              [--name --namespace-name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--public-network-access {Disabled, Enabled}]
                              [--resource-group]
                              [--sku]
                              [--subscription]
                              [--tags]
                              [--topic-spaces-configuration]

Examples

Update namespace

az eventgrid namespace update -g rg -n namespoace --tags "{tag:test}" --sku "{name:standard,capacity:2}" --topic-spaces-configuration "{maximumSessionExpiryInHours:1}"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--identity

Namespace resource identity information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	NamespaceUpdateParameters Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--inbound-ip-rules

This can be used to restrict traffic from specific IPs instead of all IPs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--name --namespace-name -n

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--public-network-access

This determines if traffic is allowed over public network.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sku

Represents available Sku pricing tiers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	NamespaceUpdateParameters Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

Tags of the namespace resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	NamespaceUpdateParameters Arguments

--topic-spaces-configuration

Topic spaces configuration properties that can be updated. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace wait

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az eventgrid namespace wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--name --namespace-name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --namespace-name -n

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False