managed_private_endpoints

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

Overview

Name	managed_private_endpoints
Type	Resource
Id	azure.synapse_managed_private_endpoints.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 connection state of a managed private endpoint. Variables are only populated by the server, and will be ignored when sending a request.
fqdns	array
groupId	string
isCompliant	boolean
isReserved	boolean	Denotes whether the managed private endpoint is reserved.
privateLinkResourceId	string
provisioningState	string	The managed private endpoint provisioning state.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

list

Name	Datatype	Description
nextLink	string	The link to the next page of results, if any remaining results exist.
value	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	managed_private_endpoint_name, managed_virtual_network_name, endpoint		Get Managed Private Endpoints.
list	select	managed_virtual_network_name, endpoint		List Managed Private Endpoints.
create	insert	managed_private_endpoint_name, managed_virtual_network_name, endpoint		Create Managed Private Endpoints.
delete	delete	managed_private_endpoint_name, managed_virtual_network_name, endpoint		Delete Managed Private Endpoints.

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
endpoint	string	The service endpoint host (no scheme). (default: )
managed_private_endpoint_name	string	Managed private endpoint name.
managed_virtual_network_name	string	Managed virtual network name.

SELECT examples

get

Get Managed Private Endpoints.

SELECT
id,
name,
connectionState,
fqdns,
groupId,
isCompliant,
isReserved,
privateLinkResourceId,
provisioningState,
type
FROM azure.synapse_managed_private_endpoints.managed_private_endpoints
WHERE managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' -- required
AND managed_virtual_network_name = '{{ managed_virtual_network_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List Managed Private Endpoints.

SELECT
nextLink,
value
FROM azure.synapse_managed_private_endpoints.managed_private_endpoints
WHERE managed_virtual_network_name = '{{ managed_virtual_network_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create

Create Managed Private Endpoints.

INSERT INTO azure.synapse_managed_private_endpoints.managed_private_endpoints (
properties,
managed_private_endpoint_name,
managed_virtual_network_name,
endpoint
)
SELECT 
'{{ properties }}',
'{{ managed_private_endpoint_name }}',
'{{ managed_virtual_network_name }}',
'{{ endpoint }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_private_endpoints
props:
  - name: managed_private_endpoint_name
    value: "{{ managed_private_endpoint_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: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: properties
    description: |
      Properties of a managed private endpoint. Variables are only populated by the server, and will be ignored when sending a request.
    value:
      name: "{{ name }}"
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      groupId: "{{ groupId }}"
      provisioningState: "{{ provisioningState }}"
      connectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"
      isReserved: {{ isReserved }}
      fqdns:
        - "{{ fqdns }}"
      isCompliant: {{ isCompliant }}

DELETE examples

delete

Delete Managed Private Endpoints.

DELETE FROM azure.synapse_managed_private_endpoints.managed_private_endpoints
WHERE managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND managed_virtual_network_name = '{{ managed_virtual_network_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;