Share via

az eventgrid partner namespace

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage partner namespaces.

Commands

Name Description Type Status
az eventgrid partner namespace channel

Manage partner channels.

 Core GA
az eventgrid partner namespace channel create

Create a new channel for a partner namespace.

 Core GA
az eventgrid partner namespace channel delete

Delete a partner namespace.

 Core GA
az eventgrid partner namespace channel list

List available partner channels.

 Core GA
az eventgrid partner namespace channel show

Get the details of a channel under a partner namespace.

 Core GA
az eventgrid partner namespace channel update

Update the details of a channel under a partner namespace.

 Core GA
az eventgrid partner namespace create

Create a partner namespace.

 Core GA
az eventgrid partner namespace create (eventgrid extension)

Create a partner namespace.

 Extension Preview
az eventgrid partner namespace delete

Delete a partner namespace.

 Core GA
az eventgrid partner namespace delete (eventgrid extension)

Delete a partner namespace.

 Extension Preview
az eventgrid partner namespace event-channel

Manage partner event channels.

 Core and Extension Deprecated
az eventgrid partner namespace event-channel create

Create an event channel under a partner namespace.

 Core Deprecated
az eventgrid partner namespace event-channel create (eventgrid extension)

Create an event channel under a partner namespace.

 Extension Preview
az eventgrid partner namespace event-channel delete

Delete a partner namespace.

 Core Deprecated
az eventgrid partner namespace event-channel delete (eventgrid extension)

Delete a partner namespace.

 Extension Preview
az eventgrid partner namespace event-channel list

List available partner event-channels.

 Core Deprecated
az eventgrid partner namespace event-channel list (eventgrid extension)

List available partner event-channels.

 Extension Preview
az eventgrid partner namespace event-channel show

Get the details of an event channel under a partner namespace.

 Core Deprecated
az eventgrid partner namespace event-channel show (eventgrid extension)

Get the details of an event channel under a partner namespace.

 Extension Preview
az eventgrid partner namespace key

Manage shared access keys of a partner namespace.

 Core and Extension GA
az eventgrid partner namespace key list

List shared access keys of a partner namespace.

 Core GA
az eventgrid partner namespace key list (eventgrid extension)

List shared access keys of a partner namespace.

 Extension Preview
az eventgrid partner namespace key regenerate

Regenerate a shared access key of a partner namespace.

 Core GA
az eventgrid partner namespace key regenerate (eventgrid extension)

Regenerate a shared access key of a partner namespace.

 Extension Preview
az eventgrid partner namespace list

List available partner namespaces.

 Core GA
az eventgrid partner namespace list (eventgrid extension)

List available partner namespaces.

 Extension Preview
az eventgrid partner namespace show

Get the details of a partner namespace.

 Core GA
az eventgrid partner namespace show (eventgrid extension)

Get the details of a partner namespace.

 Extension Preview

az eventgrid partner namespace create

Edit

Create a partner namespace.

az eventgrid partner namespace create --name
                                      --partner-registration-id
                                      --resource-group
                                      [--location]
                                      [--partner-topic-routing-mode {ChannelNameHeader, SourceEventAttribute}]
                                      [--tags]

Examples

Create a new partner namespace.

az eventgrid partner namespace create -g rg1 --name namespaceName1 -l westus2 --partner-registration-id 795c9f2f-6d2d-42ff-a570-42fd3043192c

Required Parameters

--name -n

Name of the partner namespace.

--partner-registration-id

The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.

--resource-group -g

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--partner-topic-routing-mode --route-mode

This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.

Accepted values: ChannelNameHeader, SourceEventAttribute
Default value: SourceEventAttribute
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace create (eventgrid extension)

Preview

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

Create a partner namespace.

az eventgrid partner namespace create --location
                                      --name
                                      --partner-registration-id
                                      --resource-group
                                      [--tags]

Examples

Create a new partner namespace.

az eventgrid partner namespace create -g rg1 --name namespaceName1 -l westus2 --partner-registration-id 795c9f2f-6d2d-42ff-a570-42fd3043192c

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the partner namespace.

--partner-registration-id

The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.

--resource-group -g

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

Optional Parameters

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace delete

Edit

Delete a partner namespace.

az eventgrid partner namespace delete [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

Examples

Delete a specific partner namespace.

az eventgrid partner namespace delete -g rg1 --name partnernamespace1

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

--yes -y

Do not prompt for confirmation.

Default value: False
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace delete (eventgrid extension)

Preview

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

Delete a partner namespace.

az eventgrid partner namespace delete [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Delete a specific partner namespace.

az eventgrid partner namespace delete -g rg1 --name partnernamespace1

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace list

Edit

List available partner namespaces.

az eventgrid partner namespace list [--odata-query]
                                    [--resource-group]

Examples

List all partner namespaces in the current Azure subscription.

az eventgrid partner namespace list

List all partner namespaces in a resource group.

az eventgrid partner namespace list -g rg1

List all partner namespaces in a resource group whose name contains the pattern "XYZ"

az eventgrid partner namespace list -g rg1 --odata-query "Contains(name, 'XYZ')"

List all partner namespaces in a resource group except the partner namespace with name "name1"

az eventgrid partner namespace list -g rg1 --odata-query "NOT (name eq 'name1')"

Optional Parameters

--odata-query

The OData query used for filtering the list results. Filtering is currently allowed on the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT.

--resource-group -g

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace list (eventgrid extension)

Preview

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

List available partner namespaces.

az eventgrid partner namespace list [--odata-query]
                                    [--resource-group]

Examples

List all partner namespaces in the current Azure subscription.

az eventgrid partner namespace list

List all partner namespaces in a resource group.

az eventgrid partner namespace list -g rg1

List all partner namespaces in a resource group whose name contains the pattern "XYZ"

az eventgrid partner namespace list -g rg1 --odata-query "Contains(name, 'XYZ')"

List all partner namespaces in a resource group except the partner namespace with name "name1"

az eventgrid partner namespace list -g rg1 --odata-query "NOT (name eq 'name1')"

Optional Parameters

--odata-query

The query used to filter the results using OData syntax.

--resource-group -g

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace show

Edit

Get the details of a partner namespace.

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

Examples

Show the details of a partner namespace.

az eventgrid partner namespace show -g rg1 -n partnernamespace1

Show the details of a partner namespace based on resource ID.

az eventgrid partner namespace show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnenamespaces/partnernamespace1

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 eventgrid partner namespace show (eventgrid extension)

Preview

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

Get the details of a partner namespace.

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

Examples

Show the details of a partner namespace.

az eventgrid partner namespace show -g rg1 -n partnernamespace1

Show the details of a partner namespace based on resource ID.

az eventgrid partner namespace show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnenamespaces/partnernamespace1

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.