az eventgrid partner namespace channel

Reference

Manage partner channels.

Commands

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

Edit

Create a new channel for a partner namespace.

az eventgrid partner namespace channel create --channel-type {PartnerDestination, PartnerTopic}
                                              --destination-rg
                                              --destination-sub-id
                                              --name
                                              --partner-namespace-name
                                              --resource-group
                                              [--aad-app-id]
                                              [--aad-tenant-id]
                                              [--act-exp-date]
                                              [--ed-serv-cont]
                                              [--endpoint-url]
                                              [--event-type-kind {inline}]
                                              [--inline-event-type]
                                              [--message-for-activation]
                                              [--partner-destination-name]
                                              [--partner-topic-name]
                                              [--partner-topic-source]

Examples

Create a new channel of type PartnerDestination with inline event types.

az eventgrid partner namespace channel create -g rg1 --name channel1 \
  --channel-type PartnerDestination --partner-namespace-name namespace1 \
  --partner-destination-name destination1 --destination-sub-id e14e31c8-0ce7-4ff5-be5b-dd2b2a3f3535 --destination-rg rg2

Create a new channel of type PartnerTopic with inline event types.

az eventgrid partner namespace channel create -g rg1 --name channel1 \
  --channel-type PartnerTopic --partner-namespace-name namespace1 \
  --partner-topic-name topic1 \
   --destination-sub-id e14e31c8-0ce7-4ff5-be5b-dd2b2a3f3535 --destination-rg rg2 \
  --partner-topic-source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname \
  --inline-event-type eventkey1 description="My event type." \
  --inline-event-type eventkey2 description="My second event type."

Required Parameters

--channel-type

The type of the event channel which represents the direction flow of events.

Accepted values: PartnerDestination, PartnerTopic

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

--name -n

Name of the 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>.

Optional Parameters

--aad-app-id --azure-active-directory-application-id-or-uri

The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

--aad-tenant-id --azure-active-directory-tenant-id

The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

--act-exp-date --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 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.

--ed-serv-cont --endpoint-service-context

Endpoint context associated with this partner destination.

--endpoint-url

The URL that represents the endpoint of the partner destination.

--event-type-kind

The kind of event type used.

Accepted values: inline

--inline-event-type

Create a channel for an existing partner namespace, either of type partner topic or partner destination. You can also add inline event type info if channel type is partner topic. Multiple attributes can be specified by using more than one --inline-event-type argument.

Usage: --inline-event-type KEY [description=] [documentation-url=]
[data-schema-url=] Example: --inline-event-type event1
description="My inline event type."
documentation-url=https://www.microsoft.com
data-schema-url=https://www.microsoft.com.

--message-for-activation

Context or helpful message that can be used during the approval process.

--partner-destination-name --pr-dest-n

Name of the partner destination.

--partner-topic-name

Name of the partner topic.

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

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

Edit

Delete a partner namespace.

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

Examples

Delete a specific partner namespace.

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

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

Edit

List available partner channels.

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

Examples

List all channels in a specific partner namespace.

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

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

az eventgrid partner namespace 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 channel show

Edit

Get the details of a channel under a partner namespace.

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

Examples

Show the details of a channel.

az eventgrid partner namespace channel show -g rg1 --partner-namespace-name partnernamespace1 --name channelname1

Show the details of a channel based on resource ID.

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

Optional Parameters

--ids

--name -n

Name of the 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 channel update

Edit

Update the details of a channel under a partner namespace.

az eventgrid partner namespace channel update [--aad-app-id]
                                              [--aad-tenant-id]
                                              [--act-exp-date]
                                              [--endpoint-base-url]
                                              [--endpoint-url]
                                              [--event-type-kind {inline}]
                                              [--ids]
                                              [--inline-event-type]
                                              [--name]
                                              [--partner-namespace-name]
                                              [--resource-group]
                                              [--subscription]

Examples

Update the expiration time of a channel.

az eventgrid partner namespace channel update -g rg1 \
  --partner-namespace-name partnernamespace1 \
  --name channelname1 \
  --activation-expiration-date 2022-06-14T05:37:51.272Z \

Update the inline events of a channel.

az eventgrid partner namespace channel update -g rg1 \
  --partner-namespace-name partnernamespace1 \
  --name channelname1 \
  --event-type-kind inline --inline-event-type eventtype1 documentation-url=https://www.microsoft.com

Optional Parameters

--aad-app-id --azure-active-directory-application-id-or-uri

The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

--aad-tenant-id --azure-active-directory-tenant-id

The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

--act-exp-date --activation-expiration-date

--endpoint-base-url

Endpoint Base URL of the partner destination.

--endpoint-url

The URL that represents the endpoint of the partner destination.

--event-type-kind

The kind of event type used.

Accepted values: inline

--ids

--inline-event-type

Add inline event type info. Multiple attributes can be specified by using more than one --inline-event-type argument.

--name -n

Name of the 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.

Share via

az eventgrid partner namespace channel

Commands

az eventgrid partner namespace channel create

Examples

Required Parameters

Optional Parameters

az eventgrid partner namespace channel delete

Examples

Optional Parameters

az eventgrid partner namespace channel list

Examples

Required Parameters

Optional Parameters

az eventgrid partner namespace channel show

Examples

Optional Parameters

az eventgrid partner namespace channel update

Examples

Optional Parameters

Additional resources