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

OK -- Get the private endpoint connection properties successfully

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	Private Endpoint Connection Properties.
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

OK -- Successfully retrieved private endpoint connections

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	Private Endpoint Connection Properties.
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	subscriptionId, resourceGroupName, elasticSanName, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the Elastic San
list	select	subscriptionId, resourceGroupName, elasticSanName		List all Private Endpoint Connections associated with the Elastic San.
create	insert	subscriptionId, resourceGroupName, elasticSanName, privateEndpointConnectionName, data__properties		Update the state of specified private endpoint connection associated with the Elastic San
delete	delete	subscriptionId, resourceGroupName, elasticSanName, privateEndpointConnectionName		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
elasticSanName	string	The name of the ElasticSan.
privateEndpointConnectionName	string	The name of the Private Endpoint connection.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the specified private endpoint connection associated with the Elastic San

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

list

List all Private Endpoint Connections associated with the Elastic San.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.elastic_san.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND elasticSanName = '{{ elasticSanName }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
elasticSanName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ elasticSanName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: elasticSanName
      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: properties
      value: object
      description: |
        Private Endpoint Connection Properties.

DELETE examples

delete

Deletes the specified private endpoint connection associated with the Elastic San

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