Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

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 --name
 --resource-group
 [--acquire-policy-token]
 [--auto-approval]
 [--change-reference]
 [--destination-ip-address]
 [--edge-zone]
 [--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
 [--fqdns]
 [--ip-configurations]
 [--lb-frontend-ip-configs]
 [--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}]
 [--subnet]
 [--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

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--auto-approval

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

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--destination-ip-address

The destination IP address of the private link service.

--edge-zone

The name of edge zone.

--enable-proxy-protocol

Enable proxy protocol for private link service.

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

--ip-configurations

An array of private link service IP configurations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: IP Configuration 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.

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-ip-address

Static private IP address to use.

Property Value
Parameter group: IP Configuration Arguments
--private-ip-address-version

IP version of the private IP address.

Property Value
Parameter group: IP Configuration Arguments
Default value: IPv4
Accepted values: IPv4, IPv6
--private-ip-allocation-method

Private IP address allocation method.

Property Value
Parameter group: IP Configuration Arguments
Accepted values: Dynamic, Static
--subnet

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

Property Value
Parameter group: IP Configuration Arguments
--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.

Property Value
Parameter group: IP Configuration Arguments

az network private-link-service delete

Delete a private link service.

az network private-link-service delete [--acquire-policy-token]
 [--change-reference]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--name -n

Name of the private link service.

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

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

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

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 [--acquire-policy-token]
 [--change-reference]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

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

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

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

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

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the private link service.

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

az network private-link-service update

Update a private link service.

az network private-link-service update [--acquire-policy-token]
 [--add]
 [--auto-approval]
 [--change-reference]
 [--destination-ip-address]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
--auto-approval

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

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--destination-ip-address

The destination IP address of the private link service.

--enable-proxy-protocol

Enable proxy protocol for private link service.

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

Property Value
Parameter group: Generic Update Arguments
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.

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

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

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update 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
--set

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

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

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.

az network private-link-service wait

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

az network private-link-service wait [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--expand]
 [--ids]
 [--interval]
 [--name]
 [--resource-group]
 [--subscription]
 [--timeout]
 [--updated]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

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

Name of the private link service.

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

Feedback

Was this page helpful?