private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.api_management.private_endpoint_connections

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
properties	object	Resource properties.
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
properties	object	Resource properties.
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	resourceGroupName, serviceName, privateEndpointConnectionName, subscriptionId		Gets the details of the Private Endpoint Connection specified by its identifier.
list_by_service	select	subscriptionId, resourceGroupName, serviceName		Lists all private endpoint connections of the API Management service instance.
create_or_update	insert	resourceGroupName, serviceName, privateEndpointConnectionName, subscriptionId		Creates a new Private Endpoint Connection or updates an existing one.
delete	delete	resourceGroupName, serviceName, privateEndpointConnectionName, subscriptionId		Deletes the specified Private Endpoint Connection.

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
privateEndpointConnectionName	string	Name of the private endpoint connection.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get_by_name

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

SELECT
id,
name,
properties,
type
FROM azure.api_management.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

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

SELECT
id,
name,
properties,
type
FROM azure.api_management.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.api_management.private_endpoint_connections (
data__id,
data__properties,
resourceGroupName,
serviceName,
privateEndpointConnectionName,
subscriptionId
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ privateEndpointConnectionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: serviceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: id
      value: string
      description: |
        Private Endpoint Connection Resource Id.
    - name: properties
      value: object
      description: |
        The connection state of the private endpoint connection.

DELETE examples

delete

Deletes the specified Private Endpoint Connection.

DELETE FROM azure.api_management.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;