private_endpoint_connection

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

Overview

Name	private_endpoint_connection
Type	Resource
Id	azure.api_management.private_endpoint_connection

Fields

The following fields are returned by SELECT queries:

get_by_name

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.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". (Succeeded, Creating, Deleting, Failed)
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".

get_private_link_resource

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.
groupId	string	The private link resource group id.
requiredMembers	array	The private link resource required member names.
requiredZoneNames	array	The private link resource private link DNS zone name.
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_service

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.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". (Succeeded, Creating, Deleting, Failed)
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_by_name	select	resource_group_name, service_name, private_endpoint_connection_name, subscription_id		Gets the details of the Private Endpoint Connection specified by its identifier.
get_private_link_resource	select	resource_group_name, service_name, private_link_sub_resource_name, subscription_id		Gets the private link resources.
list_by_service	select	resource_group_name, service_name, subscription_id		Lists all private endpoint connections of the API Management service instance.
create_or_update	insert	resource_group_name, service_name, private_endpoint_connection_name, subscription_id		Creates a new Private Endpoint Connection or updates an existing one.
create_or_update	replace	resource_group_name, service_name, private_endpoint_connection_name, subscription_id		Creates a new Private Endpoint Connection or updates an existing one.
delete	delete	resource_group_name, service_name, private_endpoint_connection_name, subscription_id		Deletes the specified Private Endpoint Connection.
list_private_link_resources	exec	resource_group_name, service_name, subscription_id		Gets the private link resources.

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_endpoint_connection_name	string	The name of the private endpoint connection associated with the Azure resource. Required.
private_link_sub_resource_name	string	The name of the private link associated with the Azure 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 API Management service. Required.
subscription_id	string

SELECT examples

get_by_name

Gets the details of the Private Endpoint Connection specified by its identifier.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.api_management.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_private_link_resource

Gets the private link resources.

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.api_management.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND private_link_sub_resource_name = '{{ private_link_sub_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists all private endpoint connections of the API Management service instance.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.api_management.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new Private Endpoint Connection or updates an existing one.

INSERT INTO azure.api_management.private_endpoint_connection (
id,
properties,
resource_group_name,
service_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connection
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connection resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the private_endpoint_connection resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connection resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connection resource.
  - name: id
    value: "{{ id }}"
    description: |
      Private Endpoint Connection Resource Id.
  - name: properties
    description: |
      The connection state of the private endpoint connection.
    value:
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"

REPLACE examples

create_or_update

Creates a new Private Endpoint Connection or updates an existing one.

REPLACE azure.api_management.private_endpoint_connection
SET 
id = '{{ id }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified Private Endpoint Connection.

DELETE FROM azure.api_management.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_private_link_resources

Gets the private link resources.

EXEC azure.api_management.private_endpoint_connection.list_private_link_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;