az connectedmachine private-endpoint-connection

Reference

Note

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

Manage private endpoint connection with an Azure Arc-Enabled Server.

Commands

Name	Description	Type	Status
az connectedmachine private-endpoint-connection delete	Delete a private endpoint connection with a given name.	Extension	GA
az connectedmachine private-endpoint-connection list	List all private endpoint connections on a private link scope.	Extension	GA
az connectedmachine private-endpoint-connection show	Get a private endpoint connection.	Extension	GA
az connectedmachine private-endpoint-connection update	Update a private endpoint connection with a given name.	Extension	GA
az connectedmachine private-endpoint-connection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az connectedmachine private-endpoint-connection delete

Delete a private endpoint connection with a given name.

az connectedmachine private-endpoint-connection delete [--ids]
                                                       [--name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--scope-name]
                                                       [--subscription]
                                                       [--yes]

Examples

Sample command for private-endpoint-connection delete

az connectedmachine private-endpoint-connection delete --name private-endpoint-connection-name --resource-group myResourceGroup --scope-name myPrivateLinkScope

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

The name of the private endpoint connection.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--scope-name

The name of the Azure Arc PrivateLinkScope resource.

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

List all private endpoint connections on a private link scope.

az connectedmachine private-endpoint-connection list --resource-group
                                                     --scope-name
                                                     [--max-items]
                                                     [--next-token]

Examples

Sample command for private-endpoint-connection list

az connectedmachine private-endpoint-connection list --resource-group myResourceGroup --scope-name myPrivateLinkScope

Required Parameters

--resource-group -g

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

--scope-name

The name of the Azure Arc PrivateLinkScope resource.

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

Get a private endpoint connection.

az connectedmachine private-endpoint-connection show [--ids]
                                                     [--name]
                                                     [--resource-group]
                                                     [--scope-name]
                                                     [--subscription]

Examples

Sample command for private-endpoint-connection show

az connectedmachine private-endpoint-connection show --name private-endpoint-connection-name --resource-group myResourceGroup --scope-name myPrivateLinkScope

Optional Parameters

--ids

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

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

--scope-name

The name of the Azure Arc PrivateLinkScope resource.

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

Update a private endpoint connection with a given name.

az connectedmachine private-endpoint-connection update [--add]
                                                       [--description]
                                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--ids]
                                                       [--name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--private-endpoint]
                                                       [--remove]
                                                       [--resource-group]
                                                       [--scope-name]
                                                       [--set]
                                                       [--status]
                                                       [--subscription]

Examples

Sample command for private-endpoint-connection update

az connectedmachine private-endpoint-connection update --description "Rejected by AZ CLI" --status "Rejected" --name private-endpoint-connection-name --resource-group myResourceGroup --scope-name myPrivateLinkScope

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

The private link service connection description.

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

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

The name of the private endpoint connection.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--private-endpoint

Private endpoint which the connection belongs to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--scope-name

The name of the Azure Arc PrivateLinkScope resource.

--set

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

--status

The private link service connection status.

--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 connectedmachine private-endpoint-connection wait

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

az connectedmachine private-endpoint-connection wait [--created]
                                                     [--custom]
                                                     [--deleted]
                                                     [--exists]
                                                     [--ids]
                                                     [--interval]
                                                     [--name]
                                                     [--resource-group]
                                                     [--scope-name]
                                                     [--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

--interval

Polling interval in seconds.

Default value: 30

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

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

--scope-name

The name of the Azure Arc PrivateLinkScope resource.

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

Share via

az connectedmachine private-endpoint-connection

Commands

az connectedmachine private-endpoint-connection delete

Examples

Optional Parameters

az connectedmachine private-endpoint-connection list

Examples

Required Parameters

Optional Parameters

az connectedmachine private-endpoint-connection show

Examples

Optional Parameters

az connectedmachine private-endpoint-connection update

Examples

Optional Parameters

az connectedmachine private-endpoint-connection wait

Optional Parameters

Additional resources