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_private_endpoint_connection

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
linkIdentifier	string	The consumer link id.
privateEndpoint	object	The resource of private end point.
privateEndpointLocation	string	The location of the private endpoint.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
accessMode	string	The access mode of the private link service. Known values are: "Default" and "Restricted". (Default, Restricted)
alias	string	The alias of the private link service.
autoApproval	object	The auto-approval list of the private link service.
destinationIPAddress	string	The destination IP address of the private link service.
enableProxyProtocol	boolean	Whether the private link service is enabled for proxy protocol or not.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
fqdns	array	The list of Fqdn.
ipConfigurations	array	An array of private link service IP configurations.
loadBalancerFrontendIpConfigurations	array	An array of references to the load balancer IP configurations.
location	string	Resource location.
networkInterfaces	array	An array of references to the network interfaces created for this private link service.
privateEndpointConnections	array	An array of list about connections to the private endpoint.
provisioningState	string	The provisioning state of the private link service resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
visibility	object	The visibility list of the private link service.

list_auto_approved_private_link_services_by_resource_group

Name	Datatype	Description
privateLinkService	string	The id of the private link service resource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
accessMode	string	The access mode of the private link service. Known values are: "Default" and "Restricted". (Default, Restricted)
alias	string	The alias of the private link service.
autoApproval	object	The auto-approval list of the private link service.
destinationIPAddress	string	The destination IP address of the private link service.
enableProxyProtocol	boolean	Whether the private link service is enabled for proxy protocol or not.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
fqdns	array	The list of Fqdn.
ipConfigurations	array	An array of private link service IP configurations.
loadBalancerFrontendIpConfigurations	array	An array of references to the load balancer IP configurations.
location	string	Resource location.
networkInterfaces	array	An array of references to the network interfaces created for this private link service.
privateEndpointConnections	array	An array of list about connections to the private endpoint.
provisioningState	string	The provisioning state of the private link service resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
visibility	object	The visibility list of the private link service.

list_auto_approved_private_link_services

Name	Datatype	Description
privateLinkService	string	The id of the private link service resource.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
accessMode	string	The access mode of the private link service. Known values are: "Default" and "Restricted". (Default, Restricted)
alias	string	The alias of the private link service.
autoApproval	object	The auto-approval list of the private link service.
destinationIPAddress	string	The destination IP address of the private link service.
enableProxyProtocol	boolean	Whether the private link service is enabled for proxy protocol or not.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
fqdns	array	The list of Fqdn.
ipConfigurations	array	An array of private link service IP configurations.
loadBalancerFrontendIpConfigurations	array	An array of references to the load balancer IP configurations.
location	string	Resource location.
networkInterfaces	array	An array of references to the network interfaces created for this private link service.
privateEndpointConnections	array	An array of list about connections to the private endpoint.
provisioningState	string	The provisioning state of the private link service resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
visibility	object	The visibility list of the private link service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_private_endpoint_connection	select	resource_group_name, service_name, pe_connection_name, subscription_id	$expand	Get the specific private end point connection by specific private link service in the resource group.
get	select	resource_group_name, service_name, subscription_id	$expand	Gets the specified private link service by resource group.
list_auto_approved_private_link_services_by_resource_group	select	location, resource_group_name, subscription_id		Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.
list	select	resource_group_name, subscription_id		Gets all private link services in a resource group.
list_auto_approved_private_link_services	select	location, subscription_id		Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.
list_by_subscription	select	subscription_id		Gets all private link service in a subscription.
create_or_update	insert	resource_group_name, service_name, subscription_id		Creates or updates an private link service in the specified resource group.
create_or_update	replace	resource_group_name, service_name, subscription_id		Creates or updates an private link service in the specified resource group.
delete	delete	resource_group_name, service_name, subscription_id		Deletes the specified private link service.
list_private_endpoint_connections	exec	resource_group_name, service_name, subscription_id		Gets all private end point connections for a specific private link service.
update_private_endpoint_connection	exec	resource_group_name, service_name, pe_connection_name, subscription_id		Approve or reject private end point connection for a private link service in a subscription.
delete_private_endpoint_connection	exec	resource_group_name, service_name, pe_connection_name, subscription_id		Delete private end point connection for a private link service in a subscription.
check_private_link_service_visibility	exec	location, subscription_id		Checks whether the subscription is visible to private link service.
check_private_link_service_visibility_by_resource_group	exec	location, resource_group_name, subscription_id		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 name. Required.
pe_connection_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the private link service. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get_private_endpoint_connection

Get the specific private end point connection by specific private link service in the resource group.

SELECT
id,
name,
etag,
linkIdentifier,
privateEndpoint,
privateEndpointLocation,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.network.private_link_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND pe_connection_name = '{{ pe_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

get

Gets the specified private link service by resource group.

SELECT
id,
name,
accessMode,
alias,
autoApproval,
destinationIPAddress,
enableProxyProtocol,
etag,
extendedLocation,
fqdns,
ipConfigurations,
loadBalancerFrontendIpConfigurations,
location,
networkInterfaces,
privateEndpointConnections,
provisioningState,
tags,
type,
visibility
FROM azure.network.private_link_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_auto_approved_private_link_services_by_resource_group

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

SELECT
privateLinkService
FROM azure.network.private_link_services
WHERE location = '{{ location }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all private link services in a resource group.

SELECT
id,
name,
accessMode,
alias,
autoApproval,
destinationIPAddress,
enableProxyProtocol,
etag,
extendedLocation,
fqdns,
ipConfigurations,
loadBalancerFrontendIpConfigurations,
location,
networkInterfaces,
privateEndpointConnections,
provisioningState,
tags,
type,
visibility
FROM azure.network.private_link_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_auto_approved_private_link_services

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

SELECT
privateLinkService
FROM azure.network.private_link_services
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all private link service in a subscription.

SELECT
id,
name,
accessMode,
alias,
autoApproval,
destinationIPAddress,
enableProxyProtocol,
etag,
extendedLocation,
fqdns,
ipConfigurations,
loadBalancerFrontendIpConfigurations,
location,
networkInterfaces,
privateEndpointConnections,
provisioningState,
tags,
type,
visibility
FROM azure.network.private_link_services
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
id,
location,
tags,
properties,
extendedLocation,
resource_group_name,
service_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_link_services resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the private_link_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_link_services resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the private link service.
    value:
      loadBalancerFrontendIpConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            inboundNatRules:
              - id: "{{ id }}"
            inboundNatPools:
              - id: "{{ id }}"
            outboundRules:
              - id: "{{ id }}"
            loadBalancingRules:
              - id: "{{ id }}"
            privateIPAddress: "{{ privateIPAddress }}"
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
            privateIPAddressVersion: "{{ privateIPAddressVersion }}"
            subnet:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                addressPrefix: "{{ addressPrefix }}"
                addressPrefixes: "{{ addressPrefixes }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                routeTable: "{{ routeTable }}"
                natGateway: "{{ natGateway }}"
                serviceEndpoints: "{{ serviceEndpoints }}"
                serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
                privateEndpoints: "{{ privateEndpoints }}"
                ipConfigurations: "{{ ipConfigurations }}"
                ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
                ipAllocations: "{{ ipAllocations }}"
                resourceNavigationLinks: "{{ resourceNavigationLinks }}"
                serviceAssociationLinks: "{{ serviceAssociationLinks }}"
                delegations: "{{ delegations }}"
                purpose: "{{ purpose }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
                privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
                applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
                sharingScope: "{{ sharingScope }}"
                defaultOutboundAccess: {{ defaultOutboundAccess }}
                ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
                serviceGateway: "{{ serviceGateway }}"
              etag: "{{ etag }}"
            publicIPAddress:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
                publicIPAddressVersion: "{{ publicIPAddressVersion }}"
                ipConfiguration: "{{ ipConfiguration }}"
                dnsSettings: "{{ dnsSettings }}"
                ddosSettings: "{{ ddosSettings }}"
                ipTags: "{{ ipTags }}"
                ipAddress: "{{ ipAddress }}"
                publicIPPrefix: "{{ publicIPPrefix }}"
                idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                servicePublicIPAddress: "{{ servicePublicIPAddress }}"
                natGateway: "{{ natGateway }}"
                migrationPhase: "{{ migrationPhase }}"
                linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
                deleteOption: "{{ deleteOption }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              sku:
                name: "{{ name }}"
                tier: "{{ tier }}"
              etag: "{{ etag }}"
              zones:
                - "{{ zones }}"
            publicIPPrefix:
              id: "{{ id }}"
            gatewayLoadBalancer:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
            ddosSettings:
              ddosCustomPolicy:
                id: "{{ id }}"
          etag: "{{ etag }}"
          zones: "{{ zones }}"
      ipConfigurations:
        - id: "{{ id }}"
          properties:
            privateIPAddress: "{{ privateIPAddress }}"
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
            subnet:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                addressPrefix: "{{ addressPrefix }}"
                addressPrefixes: "{{ addressPrefixes }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                routeTable: "{{ routeTable }}"
                natGateway: "{{ natGateway }}"
                serviceEndpoints: "{{ serviceEndpoints }}"
                serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
                privateEndpoints: "{{ privateEndpoints }}"
                ipConfigurations: "{{ ipConfigurations }}"
                ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
                ipAllocations: "{{ ipAllocations }}"
                resourceNavigationLinks: "{{ resourceNavigationLinks }}"
                serviceAssociationLinks: "{{ serviceAssociationLinks }}"
                delegations: "{{ delegations }}"
                purpose: "{{ purpose }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
                privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
                applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
                sharingScope: "{{ sharingScope }}"
                defaultOutboundAccess: {{ defaultOutboundAccess }}
                ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
                serviceGateway: "{{ serviceGateway }}"
              etag: "{{ etag }}"
            primary: {{ primary }}
            provisioningState: "{{ provisioningState }}"
            privateIPAddressVersion: "{{ privateIPAddressVersion }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      destinationIPAddress: "{{ destinationIPAddress }}"
      accessMode: "{{ accessMode }}"
      networkInterfaces:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          properties:
            virtualMachine:
              id: "{{ id }}"
            networkSecurityGroup:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                flushConnection: {{ flushConnection }}
                securityRules: "{{ securityRules }}"
                defaultSecurityRules: "{{ defaultSecurityRules }}"
                networkInterfaces: "{{ networkInterfaces }}"
                subnets: "{{ subnets }}"
                flowLogs: "{{ flowLogs }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
            privateEndpoint:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                subnet: "{{ subnet }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                ipVersionType: "{{ ipVersionType }}"
                privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                customDnsConfigs: "{{ customDnsConfigs }}"
                applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                ipConfigurations: "{{ ipConfigurations }}"
                customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                billingSku: "{{ billingSku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            ipConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
                  virtualNetworkTaps: "{{ virtualNetworkTaps }}"
                  applicationGatewayBackendAddressPools: "{{ applicationGatewayBackendAddressPools }}"
                  loadBalancerBackendAddressPools: "{{ loadBalancerBackendAddressPools }}"
                  loadBalancerInboundNatRules: "{{ loadBalancerInboundNatRules }}"
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  privateIPAddressVersion: "{{ privateIPAddressVersion }}"
                  subnet: "{{ subnet }}"
                  primary: {{ primary }}
                  publicIPAddress: "{{ publicIPAddress }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  provisioningState: "{{ provisioningState }}"
                  privateLinkConnectionProperties: "{{ privateLinkConnectionProperties }}"
                etag: "{{ etag }}"
            tapConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  virtualNetworkTap: "{{ virtualNetworkTap }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            dnsSettings:
              dnsServers:
                - "{{ dnsServers }}"
              appliedDnsServers:
                - "{{ appliedDnsServers }}"
              internalDnsNameLabel: "{{ internalDnsNameLabel }}"
              internalFqdn: "{{ internalFqdn }}"
              internalDomainNameSuffix: "{{ internalDomainNameSuffix }}"
            macAddress: "{{ macAddress }}"
            primary: {{ primary }}
            vnetEncryptionSupported: {{ vnetEncryptionSupported }}
            defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
            enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
            disableTcpStateTracking: {{ disableTcpStateTracking }}
            enableIPForwarding: {{ enableIPForwarding }}
            hostedWorkloads:
              - "{{ hostedWorkloads }}"
            dscpConfiguration:
              id: "{{ id }}"
            resourceGuid: "{{ resourceGuid }}"
            provisioningState: "{{ provisioningState }}"
            workloadType: "{{ workloadType }}"
            nicType: "{{ nicType }}"
            privateLinkService:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                loadBalancerFrontendIpConfigurations: "{{ loadBalancerFrontendIpConfigurations }}"
                ipConfigurations: "{{ ipConfigurations }}"
                destinationIPAddress: "{{ destinationIPAddress }}"
                accessMode: "{{ accessMode }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointConnections: "{{ privateEndpointConnections }}"
                visibility: "{{ visibility }}"
                autoApproval: "{{ autoApproval }}"
                fqdns: "{{ fqdns }}"
                alias: "{{ alias }}"
                enableProxyProtocol: {{ enableProxyProtocol }}
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            migrationPhase: "{{ migrationPhase }}"
            auxiliaryMode: "{{ auxiliaryMode }}"
            auxiliarySku: "{{ auxiliarySku }}"
          extendedLocation:
            name: "{{ name }}"
            type: "{{ type }}"
          etag: "{{ etag }}"
      provisioningState: "{{ provisioningState }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                subnet: "{{ subnet }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                ipVersionType: "{{ ipVersionType }}"
                privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                customDnsConfigs: "{{ customDnsConfigs }}"
                applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                ipConfigurations: "{{ ipConfigurations }}"
                customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                billingSku: "{{ billingSku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
            linkIdentifier: "{{ linkIdentifier }}"
            privateEndpointLocation: "{{ privateEndpointLocation }}"
          etag: "{{ etag }}"
      visibility:
        subscriptions:
          - "{{ subscriptions }}"
      autoApproval:
        subscriptions:
          - "{{ subscriptions }}"
      fqdns:
        - "{{ fqdns }}"
      alias: "{{ alias }}"
      enableProxyProtocol: {{ enableProxyProtocol }}
  - name: extendedLocation
    description: |
      The extended location of the load balancer.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

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

REPLACE azure.network.private_link_services
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified private link service.

DELETE FROM azure.network.private_link_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_private_endpoint_connections

Gets all private end point connections for a specific private link service.

EXEC azure.network.private_link_services.list_private_endpoint_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_private_endpoint_connection

Approve or reject private end point connection for a private link service in a subscription.

EXEC azure.network.private_link_services.update_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@pe_connection_name='{{ pe_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}", 
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;

delete_private_endpoint_connection

Delete private end point connection for a private link service in a subscription.

EXEC azure.network.private_link_services.delete_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@pe_connection_name='{{ pe_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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, 
@subscription_id='{{ subscription_id }}' --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, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"privateLinkServiceAlias": "{{ privateLinkServiceAlias }}"
}'
;