Share via

az eventhubs namespace private-endpoint-connection

  • Reference

Manage eventhubs namespace private endpoint connection.

Commands

Name Description Type Status
az eventhubs namespace private-endpoint-connection approve

Approve a private endpoint connection request for eventhubs namesapce.

 Core GA
az eventhubs namespace private-endpoint-connection create

Create PrivateEndpointConnections of service namespace.

 Core GA
az eventhubs namespace private-endpoint-connection delete

Delete a private endpoint connection request for eventhubs namespace.

 Core GA
az eventhubs namespace private-endpoint-connection list

List the available PrivateEndpointConnections within a namespace.

 Core GA
az eventhubs namespace private-endpoint-connection reject

Reject a private endpoint connection request for eventhubs namespace.

 Core GA
az eventhubs namespace private-endpoint-connection show

Get a description for the specified Private Endpoint Connection name.

 Core GA
az eventhubs namespace private-endpoint-connection update

Update PrivateEndpointConnections of service namespace.

 Core GA
az eventhubs namespace private-endpoint-connection wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az eventhubs namespace private-endpoint-connection approve

Edit

Approve a private endpoint connection request for eventhubs namesapce.

az eventhubs namespace private-endpoint-connection approve [--description]
                                                           [--id]
                                                           [--name]
                                                           [--namespace-name]
                                                           [--resource-group]

Examples

Approve a private endpoint connection request for eventhubs namespace by ID.

az eventhubs namespace private-endpoint-connection approve --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Eventhub/namesapces/mynamepsace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"

Approve a private endpoint connection request for eventhubs namespace by ID.

id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection approve --id $id

Approve a private endpoint connection request for eventhubs namespace using namespace name and connection name.

az eventhubs namespace private-endpoint-connection approve -g myRg --namespace-name mynamespace --name myconnection

Approve a private endpoint connection request for eventhubs namespace using namespace name and connection name.

name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection approve -g myRg --namespace-name mynamespace --name $name

Optional Parameters

--description

Comments for approve operation.

--id

The ID of the private endpoint connection associated with the EventHubs Namespace. You can get it using az eventhubs namespace show.

--name -n

The name of the private endpoint connection associated with the EventHubs Namespace.

--namespace-name

The eventhubs namesapce name.

--resource-group -g

The resource group name of specified eventhubs namespace.

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 eventhubs namespace private-endpoint-connection create

Edit

Create PrivateEndpointConnections of service namespace.

az eventhubs namespace private-endpoint-connection create --name
                                                          --namespace-name
                                                          --resource-group
                                                          [--description]
                                                          [--provisioning-state {Canceled, Creating, Deleting, Failed, Succeeded, Updating}]
                                                          [--status {Approved, Disconnected, Pending, Rejected}]

Required Parameters

--name --private-endpoint-connection-name -n

The PrivateEndpointConnection name.

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

--description

Description of the connection state.

--provisioning-state

Provisioning state of the Private Endpoint Connection.

Accepted values: Canceled, Creating, Deleting, Failed, Succeeded, Updating
--status

Status of the connection.

Accepted values: Approved, Disconnected, Pending, Rejected
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 eventhubs namespace private-endpoint-connection delete

Edit

Delete a private endpoint connection request for eventhubs namespace.

az eventhubs namespace private-endpoint-connection delete [--description]
                                                          [--id]
                                                          [--name]
                                                          [--namespace-name]
                                                          [--resource-group]
                                                          [--yes]

Examples

Delete a private endpoint connection request for eventhubs namespace by ID.

az eventhubs namespace private-endpoint-connection delete --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.EventHub/namespaces/mynamespace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"

Delete a private endpoint connection request for eventhubs namespace by ID.

id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection delete --id $id

Delete a private endpoint connection request for eventhubs namespace using account name and connection name.

az eventhubs namespace private-endpoint-connection delete -g myRg --namespace-name mynamespace --name myconnection

Delete a private endpoint connection request for eventhubs namespace using namespace name and connection name.

name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection delete -g myRg --namespace-name mynamespace --name $name

Optional Parameters

--description

Comments for delete operation.

--id

The ID of the private endpoint connection associated with the EventHubs Namespace. You can get it using az eventhubs namespace show.

--name -n

The name of the private endpoint connection associated with the EventHubs Namespace.

--namespace-name

The eventhubs namesapce name.

--resource-group -g

The resource group name of specified eventhubs namespace.

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

Edit

List the available PrivateEndpointConnections within a namespace.

az eventhubs namespace private-endpoint-connection list --namespace-name
                                                        --resource-group
                                                        [--max-items]
                                                        [--next-token]

Required Parameters

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

Edit

Reject a private endpoint connection request for eventhubs namespace.

az eventhubs namespace private-endpoint-connection reject [--description]
                                                          [--id]
                                                          [--name]
                                                          [--namespace-name]
                                                          [--resource-group]

Examples

Reject a private endpoint connection request for eventhubs namespace by ID.

az eventhubs namespace private-endpoint-connection reject --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.EventHub/namespaces/mynamespace/privateEndpointConnections/mynamespace.b56b5a95-0588-4f8b-b348-15db61590a6c"

Reject a private endpoint connection request for eventhubs namespace by ID.

id = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].id")
az eventhubs namespace private-endpoint-connection reject --id $id

Reject a private endpoint connection request for eventhubs namespace using namespace name and connection name.

az eventhubs namespace private-endpoint-connection reject -g myRg --namespace-name mynamespace --name myconnection

Reject a private endpoint connection request for eventhubs namespace using namespace name and connection name.

name = (az eventhubs namespace show -n mynamespace --query "privateEndpointConnections[0].name")
az eventhubs namespace private-endpoint-connection reject -g myRg --namespace-name mynamespace --name $name

Optional Parameters

--description

Comments for reject operation.

--id

The ID of the private endpoint connection associated with the EventHubs Namespace. You can get it using az eventhubs namespace show.

--name -n

The name of the private endpoint connection associated with the EventHubs Namespace.

--namespace-name

The eventhubs namesapce name.

--resource-group -g

The resource group name of specified eventhubs namespace.

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

Edit

Get a description for the specified Private Endpoint Connection name.

az eventhubs namespace private-endpoint-connection show [--id]
                                                        [--ids]
                                                        [--name]
                                                        [--namespace-name]
                                                        [--resource-group]
                                                        [--subscription]

Optional Parameters

--id

The ID of the private endpoint connection associated with the EventHubs Namespace. You can get it using az eventhubs namespace show.

--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 --private-endpoint-connection-name -n

The PrivateEndpointConnection name.

--namespace-name

The Namespace name.

--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 eventhubs namespace private-endpoint-connection update

Edit

Update PrivateEndpointConnections of service namespace.

az eventhubs namespace private-endpoint-connection update [--add]
                                                          [--description]
                                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--ids]
                                                          [--name]
                                                          [--namespace-name]
                                                          [--provisioning-state {Canceled, Creating, Deleting, Failed, Succeeded, Updating}]
                                                          [--remove]
                                                          [--resource-group]
                                                          [--set]
                                                          [--status {Approved, Disconnected, Pending, Rejected}]
                                                          [--subscription]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--description

Description of the connection state.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 --private-endpoint-connection-name -n

The PrivateEndpointConnection name.

--namespace-name

The Namespace name.

--provisioning-state

Provisioning state of the Private Endpoint Connection.

Accepted values: Canceled, Creating, Deleting, Failed, Succeeded, Updating
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--status

Status of the connection.

Accepted values: Approved, Disconnected, Pending, Rejected
--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 eventhubs namespace private-endpoint-connection wait

Edit

Place the CLI in a waiting state until a condition is met.

az eventhubs namespace private-endpoint-connection wait [--created]
                                                        [--custom]
                                                        [--deleted]
                                                        [--exists]
                                                        [--ids]
                                                        [--interval]
                                                        [--name]
                                                        [--namespace-name]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--timeout]
                                                        [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--name --private-endpoint-connection-name -n

The PrivateEndpointConnection name.

--namespace-name

The Namespace name.

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.