az eventhubs namespace private-endpoint-connection

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventhubs namespace private-endpoint-connection create

Edit

Create PrivateEndpointConnections of service namespace.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

Description of the connection state.

Property	Value
Parameter group:	PrivateLinkServiceConnectionState Arguments

--provisioning-state

Provisioning state of the Private Endpoint Connection.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Canceled, Creating, Deleting, Failed, Succeeded, Updating

--status

Status of the connection.

Property	Value
Parameter group:	PrivateLinkServiceConnectionState Arguments
Accepted values:	Approved, Disconnected, Pending, Rejected

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --private-endpoint-connection-name]
                                                        [--namespace-name]
                                                        [--resource-group]
                                                        [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

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

The PrivateEndpointConnection name.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --private-endpoint-connection-name]
                                                          [--namespace-name]
                                                          [--provisioning-state {Canceled, Creating, Deleting, Failed, Succeeded, Updating}]
                                                          [--remove]
                                                          [--resource-group]
                                                          [--set]
                                                          [--status {Approved, Disconnected, Pending, Rejected}]
                                                          [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--description

Description of the connection state.

Property	Value
Parameter group:	PrivateLinkServiceConnectionState Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

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

The PrivateEndpointConnection name.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--provisioning-state

Provisioning state of the Private Endpoint Connection.

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--status

Status of the connection.

Property	Value
Parameter group:	PrivateLinkServiceConnectionState Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --private-endpoint-connection-name]
                                                        [--namespace-name]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--timeout]
                                                        [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

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

The PrivateEndpointConnection name.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az eventhubs namespace private-endpoint-connection

Commands

az eventhubs namespace private-endpoint-connection approve

Examples

Optional Parameters

az eventhubs namespace private-endpoint-connection create

Required Parameters

Optional Parameters

az eventhubs namespace private-endpoint-connection delete

Examples

Optional Parameters

az eventhubs namespace private-endpoint-connection list

Required Parameters

Optional Parameters

az eventhubs namespace private-endpoint-connection reject

Examples

Optional Parameters

az eventhubs namespace private-endpoint-connection show

Optional Parameters

az eventhubs namespace private-endpoint-connection update

Optional Parameters

az eventhubs namespace private-endpoint-connection wait

Optional Parameters

Feedback