Share via

az eventgrid topic private-endpoint-connection

  • Preview
  • Reference

Note

This reference is part of the eventgrid extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az eventgrid topic private-endpoint-connection command. Learn more about extensions.

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

Manage private endpoint connections of a topic.

Commands

Name Description Type Status
az eventgrid topic private-endpoint-connection approve

Approve a private endpoint connection request for a topic.

 Extension Preview
az eventgrid topic private-endpoint-connection delete

Delete a private endpoint connection for a topic.

 Extension Preview
az eventgrid topic private-endpoint-connection list

List the properties of all the private endpoint connections for a topic.

 Extension Preview
az eventgrid topic private-endpoint-connection reject

Reject a private endpoint connection request for a topic.

 Extension Preview
az eventgrid topic private-endpoint-connection show

Display the properties of a private endpoint connection for a topic.

 Extension Preview

az eventgrid topic private-endpoint-connection approve

Preview

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

Approve a private endpoint connection request for a topic.

az eventgrid topic private-endpoint-connection approve --name
                                                       --resource-group
                                                       --topic-name
                                                       [--description]

Examples

Approve a private endpoint connection for a topic.

az eventgrid topic private-endpoint-connection approve -g rg1 --topic-name topic1 -n topic1-PrivateEndpoint.6d90cf76-a022-452c-9994-6dac62a50c99 --description "Sample approval description"

Required Parameters

--name -n

Name of the private endpoint connection.

--resource-group -g

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

--topic-name

Name of the topic.

Optional Parameters

--description

Comments for the approval.

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 topic private-endpoint-connection delete

Preview

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

Delete a private endpoint connection for a topic.

az eventgrid topic private-endpoint-connection delete [--ids]
                                                      [--name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--topic-name]

Examples

Delete private endpoint connection for a specific topic.

az eventgrid topic private-endpoint-connection delete -g rg1 --topic-name topic1 -n connectionName1

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 private endpoint connection.

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

--topic-name

Name of the topic.

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 topic private-endpoint-connection list

Preview

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

List the properties of all the private endpoint connections for a topic.

az eventgrid topic private-endpoint-connection list --resource-group
                                                    --topic-name

Examples

List private endpoint connections for a topic.

az eventgrid topic private-endpoint-connection list -g rg1 --topic-name topic1

Required Parameters

--resource-group -g

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

--topic-name

Name of the topic.

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 topic private-endpoint-connection reject

Preview

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

Reject a private endpoint connection request for a topic.

az eventgrid topic private-endpoint-connection reject --name
                                                      --resource-group
                                                      --topic-name
                                                      [--description]

Examples

Reject a private endpoint connection for a topic.

az eventgrid topic private-endpoint-connection reject -g rg1 --topic-name topic1 -n topic1-PrivateEndpoint.6d90cf76-a022-452c-9994-6dac62a50c99 --description "Sample rejection description"

Required Parameters

--name -n

Name of the private endpoint connection.

--resource-group -g

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

--topic-name

Name of the topic.

Optional Parameters

--description

Comments for the rejection.

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 topic private-endpoint-connection show

Preview

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

Display the properties of a private endpoint connection for a topic.

az eventgrid topic private-endpoint-connection show [--ids]
                                                    [--name]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--topic-name]

Examples

Show a private endpoint connection for a topic.

az eventgrid topic private-endpoint-connection show -g rg1 --topic-name topic1 -n connectionName1

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 private endpoint connection.

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

--topic-name

Name of the topic.

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.