az network private-link-service

Manage private link services.

Commands

Name	Description	Type	Status
az network private-link-service connection	Manage private link service endpoint connections.	Core	GA
az network private-link-service connection delete	Delete a private link service endpoint connection.	Core	GA
az network private-link-service connection update	Update a private link service endpoint connection.	Core	GA
az network private-link-service connection wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network private-link-service create	Create a private link service.	Core	GA
az network private-link-service delete	Delete a private link service.	Core	GA
az network private-link-service list	List private link services.	Core	GA
az network private-link-service list-auto-approved	List all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.	Core	GA
az network private-link-service show	Get the details of a private link service.	Core	GA
az network private-link-service update	Update a private link service.	Core	GA
az network private-link-service wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network private-link-service create

Create a private link service.

az network private-link-service create --lb-frontend-ip-configs
                                       --name
                                       --resource-group
                                       --subnet
                                       [--auto-approval]
                                       [--edge-zone]
                                       [--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--fqdns]
                                       [--lb-name]
                                       [--location]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--private-ip-address]
                                       [--private-ip-address-version {IPv4, IPv6}]
                                       [--private-ip-allocation-method {Dynamic, Static}]
                                       [--tags]
                                       [--visibility]
                                       [--vnet-name]

Examples

Create a private link service

az network private-link-service create -g MyResourceGroup -n MyPLSName --vnet-name MyVnetName --subnet MySubnet --lb-name MyLBName --lb-frontend-ip-configs LoadBalancerFrontEnd -l centralus

Required Parameters

--lb-frontend-ip-configs

Space-separated list of names or IDs of load balancer frontend IP configurations to link to. If names are used, also supply --lb-name. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n

Name of the private link service.

--resource-group -g

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

--subnet

Name or ID of subnet to use. If name provided, also supply --vnet-name.

Optional Parameters

--auto-approval

Space-separated list of subscription IDs to auto-approve. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--edge-zone

The name of edge zone.

--enable-proxy-protocol

Enable proxy protocol for private link service.

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

--fqdns

Space-separated list of FQDNs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--lb-name

Name of the load balancer to retrieve frontend IP configs from. Ignored if a frontend IP configuration ID is supplied.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

Static private IP address to use.

--private-ip-address-version

IP version of the private IP address.

Accepted values: IPv4, IPv6

Default value: IPv4

--private-ip-allocation-method

Private IP address allocation method.

Accepted values: Dynamic, Static

--tags

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

--visibility

Space-separated list of subscription IDs for which the private link service is visible. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vnet-name

The virtual network (VNet) 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 network private-link-service delete

Delete a private link service.

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

Examples

Delete a private link service.

az network private-link-service delete --name MyPrivateLinkService --resource-group MyResourceGroup

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

Name of the private link service.

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

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 network private-link-service list

List private link services.

az network private-link-service list [--max-items]
                                     [--next-token]
                                     [--resource-group]

Examples

List private link services.

az network private-link-service list --resource-group MyResourceGroup

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.

--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 network private-link-service list-auto-approved

List all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.

az network private-link-service list-auto-approved [--location]
                                                   [--max-items]
                                                   [--next-token]
                                                   [--resource-group]

Examples

List all of the private link service that can be linked to a Private Endpoint with auto approved

az network private-link-service list-auto-approved -l westus

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.

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

--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 network private-link-service show

Get the details of a private link service.

az network private-link-service show [--expand]
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Examples

Get the details of a private link service.

az network private-link-service show --name MyPrivateLinkService --resource-group MyResourceGroup

Optional Parameters

--expand

Expands referenced resources. Default value is None.

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

Name of the private link service.

--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 network private-link-service update

Update a private link service.

az network private-link-service update [--add]
                                       [--auto-approval]
                                       [--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--fqdns]
                                       [--ids]
                                       [--lb-frontend-ip-configs]
                                       [--lb-name]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subscription]
                                       [--tags]
                                       [--visibility]

Examples

Update a private link service

az network private-link-service update -g MyResourceGroup -n MyPLSName --visibility SubId1 SubId2 --auto-approval SubId1 SubId2

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

--auto-approval

Space-separated list of subscription IDs to auto-approve. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--enable-proxy-protocol

Enable proxy protocol for private link service.

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

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

--fqdns

Space-separated list of FQDNs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--lb-frontend-ip-configs

Space-separated list of names or IDs of load balancer frontend IP configurations to link to. If names are used, also supply --lb-name. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--lb-name

Name of the load balancer to retrieve frontend IP configs from. Ignored if a frontend IP configuration ID is supplied.

--name -n

Name of the private link service.

--no-wait

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

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

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

--set

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

--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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--visibility

Space-separated list of subscription IDs for which the private link service is visible. 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 network private-link-service wait

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

az network private-link-service wait [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--expand]
                                     [--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

--expand

Expands referenced resources. Default value is None.

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

Name of the private link service.

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