managed_private_endpoints

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

Overview

Name	managed_private_endpoints
Type	Resource
Id	azure.data_factory.managed_private_endpoints

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.
connectionState	object	The managed private endpoint connection state.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
fqdns	array	Fully qualified domain names.
groupId	string	The groupId to which the managed private endpoint is created.
isReserved	boolean	Denotes whether the managed private endpoint is reserved.
privateLinkResourceId	string	The ARM resource ID of the resource to which the managed private endpoint is created.
provisioningState	string	The managed private endpoint provisioning state.
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_factory

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.
connectionState	object	The managed private endpoint connection state.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
fqdns	array	Fully qualified domain names.
groupId	string	The groupId to which the managed private endpoint is created.
isReserved	boolean	Denotes whether the managed private endpoint is reserved.
privateLinkResourceId	string	The ARM resource ID of the resource to which the managed private endpoint is created.
provisioningState	string	The managed private endpoint provisioning state.
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	resource_group_name, factory_name, managed_virtual_network_name, managed_private_endpoint_name, subscription_id		Gets a managed private endpoint.
list_by_factory	select	resource_group_name, factory_name, managed_virtual_network_name, subscription_id		Lists managed private endpoints.
create_or_update	insert	resource_group_name, factory_name, managed_virtual_network_name, managed_private_endpoint_name, subscription_id, properties		Creates or updates a managed private endpoint.
create_or_update	replace	resource_group_name, factory_name, managed_virtual_network_name, managed_private_endpoint_name, subscription_id, properties		Creates or updates a managed private endpoint.
delete	delete	resource_group_name, factory_name, managed_virtual_network_name, managed_private_endpoint_name, subscription_id		Deletes a managed private endpoint.

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
factory_name	string	The factory name. Required.
managed_private_endpoint_name	string	Managed private endpoint name. Required.
managed_virtual_network_name	string	Managed virtual network name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a managed private endpoint.

SELECT
id,
name,
connectionState,
etag,
fqdns,
groupId,
isReserved,
privateLinkResourceId,
provisioningState,
systemData,
type
FROM azure.data_factory.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND managed_virtual_network_name = '{{ managed_virtual_network_name }}' -- required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists managed private endpoints.

SELECT
id,
name,
connectionState,
etag,
fqdns,
groupId,
isReserved,
privateLinkResourceId,
provisioningState,
systemData,
type
FROM azure.data_factory.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND managed_virtual_network_name = '{{ managed_virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed private endpoint.

INSERT INTO azure.data_factory.managed_private_endpoints (
properties,
resource_group_name,
factory_name,
managed_virtual_network_name,
managed_private_endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ managed_virtual_network_name }}',
'{{ managed_private_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_private_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: managed_virtual_network_name
    value: "{{ managed_virtual_network_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: managed_private_endpoint_name
    value: "{{ managed_private_endpoint_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: properties
    description: |
      Managed private endpoint properties. Required.
    value:
      connectionState:
        actionsRequired: "{{ actionsRequired }}"
        description: "{{ description }}"
        status: "{{ status }}"
      fqdns:
        - "{{ fqdns }}"
      groupId: "{{ groupId }}"
      isReserved: {{ isReserved }}
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a managed private endpoint.

REPLACE azure.data_factory.managed_private_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND managed_virtual_network_name = '{{ managed_virtual_network_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a managed private endpoint.

DELETE FROM azure.data_factory.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND managed_virtual_network_name = '{{ managed_virtual_network_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;