private_link_services

Creates, updates, deletes, gets or lists a private_link_services resource.

Overview

Name	private_link_services
Type	Resource
Id	azure.network.private_link_services

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting PrivateLinkService resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
properties	object	Properties of the private link service.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation returns a list of privateLinkService resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
properties	object	Properties of the private link service.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

Request successful. The operation returns a list of PrivateLinkService resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
properties	object	Properties of the private link service.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, subscriptionId	$expand	Gets the specified private link service by resource group.
list	select	resourceGroupName, subscriptionId		Gets all private link services in a resource group.
list_by_subscription	select	subscriptionId		Gets all private link service in a subscription.
create_or_update	insert	resourceGroupName, serviceName, subscriptionId		Creates or updates an private link service in the specified resource group.
delete	delete	resourceGroupName, serviceName, subscriptionId		Deletes the specified private link service.
check_private_link_service_visibility	exec	location, subscriptionId		Checks whether the subscription is visible to private link service.
check_private_link_service_visibility_by_resource_group	exec	location, resourceGroupName, subscriptionId		Checks whether the subscription is visible to private link service in the specified resource group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location	string	The location of the domain name.
resourceGroupName	string	The name of the resource group.
serviceName	string	The name of the private link service.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified private link service by resource group.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.private_link_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all private link services in a resource group.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.private_link_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Gets all private link service in a subscription.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.private_link_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an private link service in the specified resource group.

INSERT INTO azure.network.private_link_services (
data__extendedLocation,
data__properties,
resourceGroupName,
serviceName,
subscriptionId
)
SELECT 
'{{ extendedLocation }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_services
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_link_services resource.
    - name: serviceName
      value: string
      description: Required parameter for the private_link_services resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the private_link_services resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the load balancer.
    - name: properties
      value: object
      description: |
        Properties of the private link service.

DELETE examples

delete

Deletes the specified private link service.

DELETE FROM azure.network.private_link_services
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_private_link_service_visibility

Checks whether the subscription is visible to private link service.

EXEC azure.network.private_link_services.check_private_link_service_visibility 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"privateLinkServiceAlias": "{{ privateLinkServiceAlias }}"
}'
;

check_private_link_service_visibility_by_resource_group

Checks whether the subscription is visible to private link service in the specified resource group.

EXEC azure.network.private_link_services.check_private_link_service_visibility_by_resource_group 
@location='{{ location }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"privateLinkServiceAlias": "{{ privateLinkServiceAlias }}"
}'
;