Share via

az eventgrid partner registration

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

Manage partner registrations.

Commands

Name Description Type Status
az eventgrid partner registration create

Create a new partner registration.

 Core GA
az eventgrid partner registration create (eventgrid extension)

Create a new partner registration.

 Extension Preview
az eventgrid partner registration delete

Delete a partner registration.

 Core GA
az eventgrid partner registration delete (eventgrid extension)

Delete a partner registration.

 Extension Preview
az eventgrid partner registration list

List all partner registrations in specific resource group or all under the specified azure subscription.

 Core GA
az eventgrid partner registration list (eventgrid extension)

List all partner registrations in specific resource group or all under the specified azure subscription.

 Extension Preview
az eventgrid partner registration show

Get a partner registration.

 Core GA
az eventgrid partner registration show (eventgrid extension)

Get a partner registration.

 Extension Preview

az eventgrid partner registration create

Edit

Create a new partner registration.

az eventgrid partner registration create --name
                                         --resource-group
                                         [--authorized-subscription-ids]
                                         [--customer-service-extension]
                                         [--customer-service-number]
                                         [--customer-service-uri]
                                         [--description]
                                         [--display-name]
                                         [--logo-uri]
                                         [--long-description]
                                         [--partner-name]
                                         [--resource-type-name]
                                         [--setup-uri]
                                         [--tags]

Examples

Create a new partner registration with basic information.

az eventgrid partner registration create -g rg1 --name partnerRegistrationName1 --partner-name Contoso --resource-type-name Accounts --authorized-subscription-ids 533ad9de-25db-46e2-b94a-d00c37cf022b 05aa2228-7d34-4635-922d-2b582c422445

Create a new partner registration with partner information.

az eventgrid partner registration create -g rg1 --name partnerRegistrationName1 --partner-name Contoso --resource-type-name Accounts --authorized-subscription-ids 533ad9de-25db-46e2-b94a-d00c37cf022b 05aa2228-7d34-4635-922d-2b582c422445 --description ExampleDescription --display-name ExampleDisplayName1 --logo-uri 'https://www.example.com/logo.png' --setup-uri 'https://www.example.com' --long-description 'This is sample description}' --customer-service-number '+1 800 123 4567' --customer-service-extension '125' --customer-service-uri 'https://www.example.com/customerservice'

Required Parameters

--name -n

Name of the partner registration.

--resource-group -g

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

Optional Parameters

--authorized-subscription-ids

A space-separated list of Azure subscription Ids that are authorized to create a partner namespace associated with this partner registration. This is an optional property. Creating partner namespaces is always permitted under the same Azure subscription as the one used for creating the partner registration.

--customer-service-extension
Deprecated

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

The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.

--customer-service-number
Deprecated

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

The customer service number of the publisher. The expected phone format should start with a '+' sign followed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its length cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and +966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43.

--customer-service-uri
Deprecated

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

The customer service URI of the publisher.

--description
Deprecated

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

Description of the partner topic type.

--display-name
Deprecated

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

Display name for the partner topic type.

--logo-uri
Deprecated

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

URI of the partner logo.

--long-description
Deprecated

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

Description of the custom scenarios and integration. Length of this description should not exceed 2048 characters.

--partner-name
Deprecated

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

Official name of the partner.

--resource-type-name
Deprecated

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

Name of the partner topic resource type. This name should be unique among all partner topic types names.

--setup-uri
Deprecated

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

URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source.

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

Preview

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

Create a new partner registration.

az eventgrid partner registration create --name
                                         --partner-name
                                         --resource-group
                                         --resource-type-name
                                         [--authorized-subscription-ids]
                                         [--customer-service-extension]
                                         [--customer-service-number]
                                         [--customer-service-uri]
                                         [--description]
                                         [--display-name]
                                         [--logo-uri]
                                         [--long-description]
                                         [--setup-uri]
                                         [--tags]

Examples

Create a new partner registration with basic information.

az eventgrid partner registration create -g rg1 --name partnerRegistrationName1 --partner-name Contoso --resource-type-name Accounts --authorized-subscription-ids 533ad9de-25db-46e2-b94a-d00c37cf022b 05aa2228-7d34-4635-922d-2b582c422445

Create a new partner registration with partner information.

az eventgrid partner registration create -g rg1 --name partnerRegistrationName1 --partner-name Contoso --resource-type-name Accounts --authorized-subscription-ids 533ad9de-25db-46e2-b94a-d00c37cf022b 05aa2228-7d34-4635-922d-2b582c422445 --description ExampleDescription --display-name ExampleDisplayName1 --logo-uri 'https://www.example.com/logo.png' --setup-uri 'https://www.example.com' --long-description 'This is sample description}' --customer-service-number '+1 800 123 4567' --customer-service-extension '125' --customer-service-uri 'https://www.example.com/customerservice'

Required Parameters

--name -n

Name of the partner registration.

--partner-name

Official name of the partner.

--resource-group -g

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

--resource-type-name

Name of the partner topic resource type. This name should be unique among all partner topic types names.

Optional Parameters

--authorized-subscription-ids

A space-separated list of Azure subscription Ids that are authorized to create a partner namespace associated with this partner registration. This is an optional property. Creating partner namespaces is always permitted under the same Azure subscription as the one used for creating the partner registration.

--customer-service-extension

The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.

--customer-service-number

The customer service number of the publisher. The expected phone format should start with a '+' sign followed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its length cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and +966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43.

--customer-service-uri

The customer service URI of the publisher.

--description

Description of the partner topic type.

--display-name

Display name for the partner topic type.

--logo-uri

URI of the partner logo.

--long-description

Description of the custom scenarios and integration. Length of this description should not exceed 2048 characters.

--setup-uri

URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source.

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

Edit

Delete a partner registration.

Deletes a partner registration with the specified parameters.

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

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

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

Deletes a partner registration with the specified parameters.

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

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

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

Edit

List all partner registrations in specific resource group or all under the specified azure subscription.

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

Examples

List all partner registrations in the current Azure subscription.

az eventgrid partner registration list

List all partner registrations in a resource group.

az eventgrid partner registration list -g rg1

List all partner registrations in a resource group whose name contains the pattern "XYZ"

az eventgrid partner registration list -g rg1 --odata-query "Contains(name, 'XYZ')"

List all partner registrations in a resource group except the partner registration with name "name1"

az eventgrid partner registration list -g rg1 --odata-query "NOT (name eq 'name1')"

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 registration list (eventgrid extension)

Preview

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

List all partner registrations in specific resource group or all under the specified azure subscription.

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

Examples

List all partner registrations in the current Azure subscription.

az eventgrid partner registration list

List all partner registrations in a resource group.

az eventgrid partner registration list -g rg1

List all partner registrations in a resource group whose name contains the pattern "XYZ"

az eventgrid partner registration list -g rg1 --odata-query "Contains(name, 'XYZ')"

List all partner registrations in a resource group except the partner registration with name "name1"

az eventgrid partner registration list -g rg1 --odata-query "NOT (name eq 'name1')"

Optional Parameters

--odata-query

The query used to filter the results using OData syntax.

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

Edit

Get a partner registration.

Gets a partner registration with the specified parameters.

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

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

--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 registration show (eventgrid extension)

Preview

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

Get a partner registration.

Gets a partner registration with the specified parameters.

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

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

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