Share via

az eventgrid partner namespace event-channel

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

This command group has been deprecated and will be removed in a future release.

Manage partner event channels.

Commands

Name Description Type Status
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 event-channel create

Edit
Deprecated

This command is implicitly deprecated because command group 'eventgrid partner namespace event-channel' is deprecated and will be removed in a future release.

Create an event channel under a partner namespace.

az eventgrid partner namespace event-channel create --destination-rg
                                                    --destination-sub-id
                                                    --destination-topic-name
                                                    --name
                                                    --partner-namespace-name
                                                    --resource-group
                                                    --source
                                                    [--activation-expiration-date]
                                                    [--partner-topic-description]
                                                    [--publisher-filter]

Examples

Create a specific event channel.

az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-sub-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-rg rg2 --destination-topic-name topicName1

Create a specific event channel with an activation expiration time and partner topic friendly description.

az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-sub-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-rg rg2 --destination-topic-name topicName1 --activation-expiration-date '2020-05-20T10:00' --partner-topic-description 'This topic is created by Costoco corp on user behavior.'

Create a specific event channel with publisher filters.

az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-sub-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-rg rg2 --destination-topic-name topicName1 --publisher-filter data.key1 NumberIn 2 3 4 100 200 --publisher-filter data.key2 StringIn 2 3 4 100 200

Required Parameters

--destination-rg

Azure Resource Group of the subscriber requesting the creation of the channel resource by the publisher. The corresponding partner resource (either partner topic or partner destination) associated with the channel resource will be created under this resource group.

--destination-sub-id

Azure subscription Id of the subscriber requesting the creation of the channel resource by the publisher. The corresponding partner resource (either partner topic or partner destination) associated with the channel resource will be created under this Azure subscription.

--destination-topic-name

Name of the partner topic associated with the event channel.

--name -n

Name of the event channel.

--partner-namespace-name

Name of the partner namespace.

--resource-group -g

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

--source

The identifier of the resource that forms the partner source of the events. This represents a unique resource in the partner's resource model.

Optional Parameters

--activation-expiration-date

Date or datetime in UTC ISO 8601 format (e.g., '2022-02-17T01:59:59+00:00' or '2022-02-17') after which the event channel and corresponding partner topic would expire and get auto deleted. If this time is not specified, the expiration date is set to seven days by default.

--partner-topic-description

Friendly description of the corresponding partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

--publisher-filter
Deprecated

Argument 'publisher_filter' has been deprecated and will be removed in a future release.

A publisher filter that is used to enable filtering of events based on a specific event property. This set of filters that are specified by the publisher in order to determine which events to be received by the subscriber.

Usage: --publisher-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --publisher-filter data.Color StringIn Blue Red Orange Yellow StringNotIn: --publisher-filter data.Color StringNotIn Blue Red Orange Yellow StringContains: --publisher-filter subject StringContains Blue Red StringBeginsWith: --publisher-filter subject StringBeginsWith Blue Red StringEndsWith: --publisher-filter subject StringEndsWith img png jpg NumberIn: --publisher-filter data.property1 NumberIn 5 10 20 NumberNotIn: --publisher-filter data.property2 NumberNotIn 100 200 300 NumberLessThan: --publisher-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --publisher-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --publisher-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --publisher-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --publisher-filter data.property3 BoolEquals true Multiple publisher filters can be specified by using more than one --publisher-filter argument.

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 event-channel create (eventgrid extension)

Preview

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

Create an event channel under a partner namespace.

az eventgrid partner namespace event-channel create --desination-topic-name
                                                    --destination-resource-group
                                                    --destination-subscription-id
                                                    --name
                                                    --partner-namespace-name
                                                    --resource-group
                                                    --source
                                                    [--activation-expiration-date]
                                                    [--partner-topic-description]
                                                    [--publisher-filter]

Examples

Create a specific event channel.

az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-subscription-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-resource-group rg2 --desination-topic-name topicName1

Create a specific event channel with an activation expiration time and partner topic friendly description.

az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-subscription-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-resource-group rg2 --desination-topic-name topicName1 --activation-expiration-date '2020-05-20T10:00' --partner-topic-description 'This topic is created by Costoco corp on user behavior.'

Create a specific event channel with publisher filters.

az eventgrid partner namespace event-channel create -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1 --source SourceExample1 --destination-subscription-id 61f7c265-374d-499e-866d-5f4cc302b888 --destination-resource-group rg2 --desination-topic-name topicName1 --publisher-filter data.key1 NumberIn 2 3 4 100 200 --publisher-filter data.key2 StringIn 2 3 4 100 200

Required Parameters

--desination-topic-name

Name of the partner topic associated with the event channel.

--destination-resource-group

Azure Resource Group of the customer creating the event channel. The partner topic associated with the event channel will be created under this resource group.

--destination-subscription-id

Azure subscription Id of the customer creating the event channel. The partner topic associated with the event channel will be created under this Azure subscription.

--name -n

Name of the event channel.

--partner-namespace-name

Name of the partner namespace.

--resource-group -g

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

--source

The identifier of the resource that forms the partner source of the events. This represents a unique resource in the partner's resource model.

Optional Parameters

--activation-expiration-date

Date or datetime in UTC ISO 8601 format (e.g., '2022-02-17T01:59:59+00:00' or '2022-02-17') after which the event channel and corresponding partner topic would expire and get auto deleted. If this time is not specified, the expiration date is set to seven days by default.

--partner-topic-description

Friendly description of the corresponding partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

--publisher-filter

A publisher filter that is used to enable filtering of events based on a specific event property. This set of filters that are specified by the publisher in order to determine which events to be received by the subscriber.

Usage: --publisher-filter KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --publisher-filter data.Color StringIn Blue Red Orange Yellow StringNotIn: --publisher-filter data.Color StringNotIn Blue Red Orange Yellow StringContains: --publisher-filter subject StringContains Blue Red StringBeginsWith: --publisher-filter subject StringBeginsWith Blue Red StringEndsWith: --publisher-filter subject StringEndsWith img png jpg NumberIn: --publisher-filter data.property1 NumberIn 5 10 20 NumberNotIn: --publisher-filter data.property2 NumberNotIn 100 200 300 NumberLessThan: --publisher-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --publisher-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --publisher-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --publisher-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --publisher-filter data.property3 BoolEquals true Multiple publisher filters can be specified by using more than one --publisher-filter argument.

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 event-channel delete

Edit
Deprecated

This command is implicitly deprecated because command group 'eventgrid partner namespace event-channel' is deprecated and will be removed in a future release.

Delete a partner namespace.

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

Examples

Delete a specific partner namespace.

az eventgrid partner namespace event-channel delete -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1

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

--partner-namespace-name

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 event-channel 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 event-channel delete [--ids]
                                                    [--name]
                                                    [--partner-namespace-name]
                                                    [--resource-group]
                                                    [--subscription]

Examples

Delete a specific partner namespace.

az eventgrid partner namespace event-channel delete -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1

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

--partner-namespace-name

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 event-channel list

Edit
Deprecated

This command is implicitly deprecated because command group 'eventgrid partner namespace event-channel' is deprecated and will be removed in a future release.

List available partner event-channels.

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

Examples

List all event-channels in a specific partner namespace.

az eventgrid partner namespace event-channel list -g rg1 --partner-namespace-name partnernamespace1

List all event channel under a partner namespace whose name contains the pattern "XYZ"

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

Required Parameters

--partner-namespace-name

Name of the partner namespace.

--resource-group -g

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

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.

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 event-channel 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 event-channels.

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

Examples

List all event-channels in a specific partner namespace.

az eventgrid partner namespace event-channel list -g rg1 --partner-namespace-name partnernamespace1

List all event channel under a partner namespace whose name contains the pattern "XYZ"

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

Required Parameters

--partner-namespace-name

Name of the partner namespace.

--resource-group -g

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

Optional Parameters

--odata-query

The query used to filter the results using OData syntax.

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 event-channel show

Edit
Deprecated

This command is implicitly deprecated because command group 'eventgrid partner namespace event-channel' is deprecated and will be removed in a future release.

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

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

Examples

Show the details of an event channel.

az eventgrid partner namespace event-channel show -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1

Show the details of an event-channel based on resource ID.

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

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

--partner-namespace-name

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 event-channel 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 an event channel under a partner namespace.

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

Examples

Show the details of an event channel.

az eventgrid partner namespace event-channel show -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1

Show the details of an event-channel based on resource ID.

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

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

--partner-namespace-name

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.