az connectedmachine private-link-scope

Note

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

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

Commands

Name	Description	Type	Status
az connectedmachine private-link-scope create	Create (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.	Extension	GA
az connectedmachine private-link-scope delete	Delete an Azure Arc PrivateLinkScope.	Extension	GA
az connectedmachine private-link-scope list	Get a list of Azure Arc PrivateLinkScopes within a resource group. And Gets a list of all Azure Arc PrivateLinkScopes within a subscription.	Extension	GA
az connectedmachine private-link-scope show	Return an Azure Arc PrivateLinkScope.	Extension	GA
az connectedmachine private-link-scope update	Update an Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.	Extension	GA
az connectedmachine private-link-scope update-tag	Update an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.	Extension	GA
az connectedmachine private-link-scope wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az connectedmachine private-link-scope create

Create (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

az connectedmachine private-link-scope create --name
                                              --resource-group
                                              [--location]
                                              [--public-network-access {Disabled, Enabled}]
                                              [--tags]

Examples

Sample command for private-link-scope create

az connectedmachine private-link-scope create --location westus --resource-group my-resource-group --scope-name my-privatelinkscope

Required Parameters

--name --scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

--resource-group -g

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

Optional Parameters

--location -l

Resource location When not specified, the location of the resource group will be used.

--public-network-access

Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.

accepted values: Disabled, Enabled

default value: Disabled

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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-link-scope delete

Delete an Azure Arc PrivateLinkScope.

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

Examples

Sample command for private-link-scope delete

az connectedmachine private-link-scope delete --resource-group my-resource-group --scope-name my-privatelinkscope

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 --scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

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

--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-link-scope list

Get a list of Azure Arc PrivateLinkScopes within a resource group. And Gets a list of all Azure Arc PrivateLinkScopes within a subscription.

az connectedmachine private-link-scope list [--resource-group]

Examples

Sample command for private-link-scope list

az connectedmachine private-link-scope list --resource-group my-resource-group
az connectedmachine private-link-scope list

Optional Parameters

--resource-group -g

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

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-link-scope show

Return an Azure Arc PrivateLinkScope.

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

Examples

Sample command for private-link-scope show

az connectedmachine private-link-scope show --resource-group my-resource-group --scope-name my-privatelinkscope

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 --scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

--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 connectedmachine private-link-scope update

Update an Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

az connectedmachine private-link-scope update [--add]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--ids]
                                              [--name]
                                              [--public-network-access {Disabled, Enabled}]
                                              [--remove]
                                              [--resource-group]
                                              [--set]
                                              [--subscription]
                                              [--tags]

Examples

Sample command for private-link-scope update

az connectedmachine private-link-scope update --location westus --tags Tag1=Value1 --resource-group my-resource-group --scope-name my-privatelinkscope

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

--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 --scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

--public-network-access

Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.

accepted values: Disabled, Enabled

--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

--subscription

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

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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-link-scope update-tag

Update an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

az connectedmachine private-link-scope update-tag [--ids]
                                                  [--resource-group]
                                                  [--scope-name]
                                                  [--subscription]
                                                  [--tags]

Examples

PrivateLinkScopeUpdateTagsOnly

az connectedmachine private-link-scope update-tag --tags Tag1="Value1" Tag2="Value2" --resource-group "my-resource-group" --scope-name "my-privatelinkscope"

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.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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-link-scope wait

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

az connectedmachine private-link-scope wait [--created]
                                            [--custom]
                                            [--deleted]
                                            [--exists]
                                            [--ids]
                                            [--interval]
                                            [--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 --scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

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