private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.elastic_san.private_endpoint_connections

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.
groupIds	array	List of resources private endpoint is mapped.
privateEndpoint	object	Private Endpoint resource.
privateLinkServiceConnectionState	object	Private Link Service Connection State. Required.
provisioningState	string	Provisioning State of Private Endpoint connection resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
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

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.
groupIds	array	List of resources private endpoint is mapped.
privateEndpoint	object	Private Endpoint resource.
privateLinkServiceConnectionState	object	Private Link Service Connection State. Required.
provisioningState	string	Provisioning State of Private Endpoint connection resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
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, elastic_san_name, private_endpoint_connection_name, subscription_id		Gets the specified private endpoint connection associated with the Elastic San.
list	select	resource_group_name, elastic_san_name, subscription_id		List all Private Endpoint Connections associated with the Elastic San.
create	insert	resource_group_name, elastic_san_name, private_endpoint_connection_name, subscription_id, properties		Update the state of specified private endpoint connection associated with the Elastic San.
delete	delete	resource_group_name, elastic_san_name, private_endpoint_connection_name, subscription_id		Deletes the specified private endpoint connection associated with the Elastic San.

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
elastic_san_name	string	The name of the ElasticSan. Required.
private_endpoint_connection_name	string	The name of the Private Endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified private endpoint connection associated with the Elastic San.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.elastic_san.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all Private Endpoint Connections associated with the Elastic San.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.elastic_san.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Update the state of specified private endpoint connection associated with the Elastic San.

INSERT INTO azure.elastic_san.private_endpoint_connections (
properties,
resource_group_name,
elastic_san_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ elastic_san_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: elastic_san_name
    value: "{{ elastic_san_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: properties
    description: |
      Private Endpoint Connection Properties. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      privateEndpoint:
        id: "{{ id }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"
      groupIds:
        - "{{ groupIds }}"

DELETE examples

delete

Deletes the specified private endpoint connection associated with the Elastic San.

DELETE FROM azure.elastic_san.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND elastic_san_name = '{{ elastic_san_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;