az eventgrid partner namespace channel
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
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 rg2Create 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
The type of the event channel which represents the direction flow of events.
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.
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 of the channel.
Name of the partner namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
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.
Endpoint context associated with this partner destination.
The URL that represents the endpoint of the partner destination.
The kind of event type used.
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.
Context or helpful message that can be used during the approval process.
Name of the partner destination.
Name of the partner topic.
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
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 eventgrid partner namespace channel delete
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 channelname1Optional 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.
Name of the channel.
Name of the partner namespace.
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.
Do not prompt for confirmation.
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 eventgrid partner namespace channel list
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 partnernamespace1List 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
Name of the partner namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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
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 eventgrid partner namespace channel show
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 channelname1Show 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/channelName1Optional 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.
Name of the channel.
Name of the partner namespace.
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 eventgrid partner namespace channel update
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.comOptional Parameters
The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.
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.
Endpoint Base URL of the partner destination.
The URL that represents the endpoint of the partner destination.
The kind of event type used.
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.
Add inline event type info. 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.
Name of the channel.
Name of the partner namespace.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for