az network private-link-service

Manage private link services.

Commands

az network private-link-service connection

Manage private link service endpoint connections.

az network private-link-service connection delete

Delete a private link service endpoint connection.

az network private-link-service connection update

Update a private link service endpoint connection.

az network private-link-service create

Create a private link service.

az network private-link-service delete

Delete a private link service.

az network private-link-service list

List private link services.

az network private-link-service show

Get the details of a private link service.

az network private-link-service update

Update a private link service.

Create a private link service.

az network private-link-service create --lb-frontend-ip-configs
                                       --name
                                       --resource-group
                                       --subnet
                                       [--auto-approval]
                                       [--enable-proxy-protocol {false, true}]
                                       [--fqdns]
                                       [--lb-name]
                                       [--location]
                                       [--private-ip-address]
                                       [--private-ip-address-version {IPv4, IPv6}]
                                       [--private-ip-allocation-method {Dynamic, Static}]
                                       [--public-ip-address]
                                       [--subscription]
                                       [--tags]
                                       [--visibility]
                                       [--vnet-name]

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

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

--auto-approval

Space-separated list of subscription IDs to auto-approve.

--enable-proxy-protocol

Enable proxy protocol for private link service.

accepted values: false, true
--fqdns

Space-separated list of FQDNs.

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

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

Name or ID of the a public IP address to use.

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

--visibility

Space-separated list of subscription IDs for which the private link service is visible.

--vnet-name

The virtual network (VNet) name.

Delete a private link service.

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

Delete a private link service. (autogenerated)

az network private-link-service delete --name MyPrivateLinkService --resource-group MyResourceGroup
--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.

List private link services.

az network private-link-service list [--query-examples]
                                     [--resource-group]
                                     [--subscription]
--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

Get the details of a private link service.

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

Get the details of a private link service. (autogenerated)

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

Expands referenced resources.

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

Update a private link service.

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

Update a private link service

az network private-link-service update -g MyResourceGroup -n MyPLSName --visibility SubId1 SubId2 --auto-approval SubId1 SubId2
--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.

--enable-proxy-protocol

Enable proxy protocol for private link service.

accepted values: false, true
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--fqdns

Space-separated list of FQDNs.

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

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

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

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

--visibility

Space-separated list of subscription IDs for which the private link service is visible.