Share via

az eventgrid partner configuration

  • Reference

Manage partner configurations.

Commands

Name Description Type Status
az eventgrid partner configuration authorize

Authorize a partner configuration.

 Core GA
az eventgrid partner configuration create

Create a partner configuration.

 Core GA
az eventgrid partner configuration delete

Delete a partner configuration.

 Core GA
az eventgrid partner configuration list

List available partner configurations.

 Core GA
az eventgrid partner configuration show

Get the details of a partner configuration.

 Core GA
az eventgrid partner configuration unauthorize

Unauthorize a partner configuration.

 Core GA
az eventgrid partner configuration update

Update a partner configuration.

 Core GA

az eventgrid partner configuration authorize

Edit

Authorize a partner configuration.

az eventgrid partner configuration authorize --resource-group
                                             [--auth-exp-date]
                                             [--partner-name]
                                             [--partner-registration-immutable-id]

Examples

Authorize a partner based on partner registration immutable ID.

az eventgrid partner configuration authorize -g rg1 --partner-registration-immutable-id 795c9f2f-6d2d-42ff-a570-42fd3043192c --authorization-expiration-date 2022-06-14T05:37:51.272Z

Authorize a partner based on partner name.

az eventgrid partner configuration authorize -g rg1 --partner-name partner1 --authorization-expiration-date 2022-06-14T05:37:51.272Z

Required Parameters

--resource-group -g

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

Optional Parameters

--auth-exp-date --authorization-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 authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.

--partner-name

Official name of the partner.

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

The immutable ID of the corresponding partner registration.

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

Edit

Create a partner configuration.

az eventgrid partner configuration create --resource-group
                                          [--authorized-partner]
                                          [--default-maximum-expiration-time-in-days]
                                          [--tags]

Examples

Create a partner configuration with multiple authorized partners.

az eventgrid partner configuration create -g rg1 \
    --authorized-partner partner-name=somepartner1 \
    --authorized-partner partner-name=somepartner2 \
    --default-maximum-expiration-time-in-days 5

Required Parameters

--resource-group -g

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

Optional Parameters

--authorized-partner

Add authorized partner information. Multiple authorized partners can be specified by using more than one --authorized-partner argument.

Add authorized partner information. Multiple authorized partners can be specified by using more than one --authorized-partner argument. partner-name represents the verified partner resource name corresponding to the partner if it is a verified publisher. partner-registration-immutable-id represents the immutable id of the publisher registration ARM resource. partner-name and partner-registration-immutable-id are optional parameters but at least one parameter should be specified when authorizing a partner. When both are present, they both should correspond to the same verified parner information.

Usage: --authorized-partner [partner-name=]
[partner-registration-immutable-id=]
[expiration-time=] Partner Name: --authorized-partner partner-name=somename
expiration-time=2022-06-14T05:37:51.272Z Partner Registration ID: --authorized-partner
partner-registration-immutable-id=795c9f2f-6d2d-42ff-a570-42fd3043192c
expiration-time=2022-06-14T05:37:51.272Z Both Name and ID: --authorized-partner partner-name=somename
partner-registration-immutable-id=795c9f2f-6d2d-42ff-a570-42fd3043192c
expiration-time=2022-06-14T05:37:51.272Z.

--default-maximum-expiration-time-in-days --max-exp-days

Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.

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

Edit

Delete a partner configuration.

az eventgrid partner configuration delete --resource-group
                                          [--yes]

Examples

Delete a partner configuration.

az eventgrid partner configuration delete -g rg1

Required Parameters

--resource-group -g

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

Optional Parameters

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

Edit

List available partner configurations.

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

Examples

List all partner configurations in the current Azure subscription.

az eventgrid partner configuration list

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

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

List all partner configurations in the current Azure subscription except the partner configuration with name "name1"

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

List all partner configurations in a resource group.

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

Edit

Get the details of a partner configuration.

az eventgrid partner configuration show --resource-group

Examples

Show the details of a partner configuration.

az eventgrid partner configuration show -g rg1

Required Parameters

--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 configuration unauthorize

Edit

Unauthorize a partner configuration.

az eventgrid partner configuration unauthorize --resource-group
                                               [--auth-exp-date]
                                               [--partner-name]
                                               [--partner-registration-immutable-id]

Examples

Unauthorize a partner based on partner registration immutable ID.

az eventgrid partner configuration unauthorize -g rg1 --partner-registration-immutable-id 795c9f2f-6d2d-42ff-a570-42fd3043192c --authorization-expiration-date 2022-06-14T05:37:51.272Z

Unauthorize a partner based on partner name.

az eventgrid partner configuration unauthorize -g rg1 --partner-name partner1 --authorization-expiration-date 2022-06-14T05:37:51.272Z

Required Parameters

--resource-group -g

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

Optional Parameters

--auth-exp-date --authorization-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 authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.

--partner-name

Official name of the partner.

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

The immutable ID of the corresponding partner registration.

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

Edit

Update a partner configuration.

az eventgrid partner configuration update --resource-group
                                          [--default-maximum-expiration-time-in-days]
                                          [--tags]

Examples

Update a partner configuration's default maximum expiration time.

az eventgrid partner configuration update -g rg1 --default-maximum-expiration-time-in-days 5

Required Parameters

--resource-group -g

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

Optional Parameters

--default-maximum-expiration-time-in-days --max-exp-days

Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.

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