Share via


az connectedmachine private-link-scope

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

Delete an Azure Arc PrivateLinkScope.

Extension GA
az connectedmachine private-link-scope list

Get a list of Azure Arc PrivateLinkScopes for a resource group or a subscription.

Extension GA
az connectedmachine private-link-scope network-security-perimeter-configuration

Manage network security perimeter configration on an Azure Arc-Enabled Server.

Extension GA
az connectedmachine private-link-scope network-security-perimeter-configuration list

List the network security perimeter configurations for a private link scope.

Extension GA
az connectedmachine private-link-scope network-security-perimeter-configuration reconcile

Force the network security perimeter configuration to refresh for a private link scope.

Extension GA
az connectedmachine private-link-scope network-security-perimeter-configuration show

Get the network security perimeter configuration for a private link scope.

Extension GA
az connectedmachine private-link-scope show

Get an Azure Arc PrivateLinkScope.

Extension GA
az connectedmachine private-link-scope update

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

Create an 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 --scope-name
                                              --resource-group
                                              [--location]
                                              [--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
                                              [--tags]

Sample command for private-link-scope create

az connectedmachine private-link-scope create --location westus --resource-group my-resource-group --scope-name my-privatelinkscope
--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>.

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

--location -l

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

Property Value
Parameter group: Parameters Arguments
--public-network-access

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

Property Value
Parameter group: Properties Arguments
Default value: Disabled
Accepted values: Disabled, Enabled, SecuredByPerimeter
--tags

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

Property Value
Parameter group: Parameters 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

Delete an Azure Arc PrivateLinkScope.

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

Sample command for private-link-scope delete

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

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

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

The name of the Azure Arc PrivateLinkScope resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

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

--verbose

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

Property Value
Default value: False

Get a list of Azure Arc PrivateLinkScopes for a resource group or a subscription.

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

Sample command for private-link-scope list

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

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

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 an Azure Arc PrivateLinkScope.

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

Sample command for private-link-scope show

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

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

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

The name of the Azure Arc PrivateLinkScope resource.

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

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

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

sample command for private-link-scope update

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

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

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

The name of the Azure Arc PrivateLinkScope resource.

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

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

Property Value
Parameter group: PrivateLinkScopeTags 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

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 --scope-name]
                                            [--resource-group]
                                            [--subscription]
                                            [--timeout]
                                            [--updated]

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

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --scope-name -n

The name of the Azure Arc PrivateLinkScope resource.

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