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

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Managed private endpoint properties.
type	string	The resource type.

list_by_factory

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Managed private endpoint properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, managedVirtualNetworkName, managedPrivateEndpointName	api-version, If-None-Match	Gets a managed private endpoint.
list_by_factory	select	subscriptionId, resourceGroupName, factoryName, managedVirtualNetworkName	api-version	Lists managed private endpoints.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, managedVirtualNetworkName, managedPrivateEndpointName, data__properties	api-version, If-Match	Creates or updates a managed private endpoint.
delete	delete	subscriptionId, resourceGroupName, factoryName, managedVirtualNetworkName, managedPrivateEndpointName	api-version	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
factoryName	string	The factory name.
managedPrivateEndpointName	string	Managed private endpoint name
managedVirtualNetworkName	string	Managed virtual network name
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
If-Match	string	ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
If-None-Match	string	ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
api-version	string	The API version.

SELECT examples

get

Gets a managed private endpoint.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.managed_private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND managedVirtualNetworkName = '{{ managedVirtualNetworkName }}' -- required
AND managedPrivateEndpointName = '{{ managedPrivateEndpointName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_factory

Lists managed private endpoints.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.managed_private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND managedVirtualNetworkName = '{{ managedVirtualNetworkName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a managed private endpoint.

INSERT INTO azure.data_factory.managed_private_endpoints (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
managedVirtualNetworkName,
managedPrivateEndpointName,
api-version,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ managedVirtualNetworkName }}',
'{{ managedPrivateEndpointName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_private_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: factoryName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: managedVirtualNetworkName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: managedPrivateEndpointName
      value: string
      description: Required parameter for the managed_private_endpoints resource.
    - name: properties
      value: object
      description: |
        Managed private endpoint properties.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      description: ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

DELETE examples

delete

Deletes a managed private endpoint.

DELETE FROM azure.data_factory.managed_private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND managedVirtualNetworkName = '{{ managedVirtualNetworkName }}' --required
AND managedPrivateEndpointName = '{{ managedPrivateEndpointName }}' --required
AND api-version = '{{ api-version }}'
;