Share via

az connectedmachine private-link-resource

Note

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

Manage private link resource of an Azure Arc-Enabled Server.

Commands

Name Description Type Status
az connectedmachine private-link-resource list

List the private link resources that need to be created for an Azure Monitor PrivateLinkScope.

 Extension GA
az connectedmachine private-link-resource show

Get the private link resources that need to be created for an Azure Monitor PrivateLinkScope.

 Extension GA

List the private link resources that need to be created for an Azure Monitor PrivateLinkScope.

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

Sample command for private-link-resource list

az connectedmachine private-link-resource list --resource-group myResourceGroup --scope-name myPrivateLinkScope
--resource-group -g

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

--scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

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

Get the private link resources that need to be created for an Azure Monitor PrivateLinkScope.

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

Sample command for private-link-resource show

az connectedmachine private-link-resource show --group-name hybridcompute --resource-group myResourceGroup --scope-name myPrivateLinkScope

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

--group-name --name -n

The name of the private link resource.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--scope-name

The name of the Azure Arc PrivateLinkScope resource.

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