Share via

az eventgrid partner destination

  • Reference

Manage partner destinations.

Commands

Name Description Type Status
az eventgrid partner destination activate

Activate a partner destination.

 Core GA
az eventgrid partner destination create

Create a partner destination.

 Core GA
az eventgrid partner destination delete

Delete a partner destination.

 Core GA
az eventgrid partner destination list

List available partner destinations.

 Core GA
az eventgrid partner destination show

Get the details of a partner destination.

 Core GA
az eventgrid partner destination update

Update the details of a partner destination.

 Core GA

az eventgrid partner destination activate

Edit

Activate a partner destination.

az eventgrid partner destination activate [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Examples

Activate a partner destination.

az eventgrid partner destination activate -g rg1 -n destination1

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

--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 destination create

Edit

Create a partner destination.

az eventgrid partner destination create --location
                                        --name
                                        --resource-group
                                        [--act-exp-date]
                                        [--ed-serv-cont]
                                        [--endpoint-base-url]
                                        [--message-for-activation]
                                        [--partner-registration-immutable-id]
                                        [--tags]

Examples

Create a partner destination.

az eventgrid partner destination create --location westus2 -g rg1 -n destination1

Create a partner destination with an activation message and expiration time.

az eventgrid partner destination create --location westus2 -g rg1 -n destination1 \
    --activation-expiration-date 2022-06-14T05:37:51.272Z \
    --message-for-activation "This is an activation message"

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

--resource-group -g

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

Optional Parameters

--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') which is the expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.

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

Endpoint context associated with this partner destination.

--endpoint-base-url

Endpoint Base URL of the partner destination.

--message-for-activation

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

--partner-registration-immutable-id --pr-id

The immutable ID of the corresponding partner registration.

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

Edit

Delete a partner destination.

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

Examples

Delete a partner destination.

az eventgrid partner destination delete -g rg1 -n destination1

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

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

Edit

List available partner destinations.

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

Examples

List all partner destinations in the current Azure subscription.

az eventgrid partner destination list

List all partner destinations in the current Azure subscription whose name contains the pattern "XYZ"

az eventgrid partner destination list --odata-query "Contains(name, 'XYZ')"

List all partner destinations in the current Azure subscription except the partner destination with name "name1"

az eventgrid partner destination list --odata-query "NOT (name eq 'name1')"

List all partner destinations in a resource group.

az eventgrid partner destination list -g rg1

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 destination show

Edit

Get the details of a partner destination.

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

Examples

Show the details of a partner destination.

az eventgrid partner destination show -g rg1 -n destinationname1

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

--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 destination update

Edit

Update the details of a partner destination.

az eventgrid partner destination update [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]
                                        [--tags]

Examples

Update the tags of a partner destination.

az eventgrid partner destination update -g rg1 -n destinationname1 --tags Dept=IT

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

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

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