private_links

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

Overview

Name	private_links
Type	Resource
Id	azure.security.private_links

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources	array	List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState	string	The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Failed", "Canceled", and "InProgress". (Succeeded, Creating, Updating, Deleting, Failed, Canceled, InProgress)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources	array	List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState	string	The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Failed", "Canceled", and "InProgress". (Succeeded, Creating, Updating, Deleting, Failed, Canceled, InProgress)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources	array	List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState	string	The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Failed", "Canceled", and "InProgress". (Succeeded, Creating, Updating, Deleting, Failed, Canceled, InProgress)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, private_link_name, subscription_id		Get a private link resource. Returns the configuration and status of private endpoint connectivity for Microsoft Defender for Cloud services in the specified region.
list	select	resource_group_name, subscription_id		Lists all the private links in the specified resource group. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified resource group.
list_by_subscription	select	subscription_id		Lists all the private links in the specified subscription. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified subscription.
create	insert	resource_group_name, private_link_name, subscription_id, location, properties		Create a private link resource. This operation creates the necessary infrastructure to enable private endpoint connections to Microsoft Defender for Cloud services. For updates to existing resources, use the PATCH operation. The operation is asynchronous and may take several minutes to complete.
update	update	resource_group_name, private_link_name, subscription_id		Update specific properties of a private link resource. Use this operation to update mutable properties like tags without affecting the entire resource configuration.
delete	delete	resource_group_name, private_link_name, subscription_id		Delete a private link resource. This operation will remove the private link infrastructure and disconnect all associated private endpoints. This operation is asynchronous and may take several minutes to complete.
head	exec	resource_group_name, private_link_name, subscription_id		Checks whether private link exists.

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
private_link_name	string	The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a private link resource. Returns the configuration and status of private endpoint connectivity for Microsoft Defender for Cloud services in the specified region.

SELECT
id,
name,
location,
privateEndpointConnections,
privateLinkResources,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.security.private_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_link_name = '{{ private_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the private links in the specified resource group. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified resource group.

SELECT
id,
name,
location,
privateEndpointConnections,
privateLinkResources,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.security.private_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all the private links in the specified subscription. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified subscription.

SELECT
id,
name,
location,
privateEndpointConnections,
privateLinkResources,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.security.private_links
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a private link resource. This operation creates the necessary infrastructure to enable private endpoint connections to Microsoft Defender for Cloud services. For updates to existing resources, use the PATCH operation. The operation is asynchronous and may take several minutes to complete.

INSERT INTO azure.security.private_links (
tags,
location,
properties,
resource_group_name,
private_link_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ private_link_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_links
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_links resource.
  - name: private_link_name
    value: "{{ private_link_name }}"
    description: Required parameter for the private_links resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_links resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties specific to the private link resource. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      privateLinkResources:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupId: "{{ groupId }}"
            requiredMembers:
              - "{{ requiredMembers }}"
            requiredZoneNames:
              - "{{ requiredZoneNames }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"

UPDATE examples

update

Update specific properties of a private link resource. Use this operation to update mutable properties like tags without affecting the entire resource configuration.

UPDATE azure.security.private_links
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_link_name = '{{ private_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a private link resource. This operation will remove the private link infrastructure and disconnect all associated private endpoints. This operation is asynchronous and may take several minutes to complete.

DELETE FROM azure.security.private_links
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_link_name = '{{ private_link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

head

Checks whether private link exists.

EXEC azure.security.private_links.head 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_link_name='{{ private_link_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;