private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.storage_sync.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 (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Resource 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_by_storage_sync_service

Array of Sync Group resources in Storage Sync Service

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Resource 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	resourceGroupName, storageSyncServiceName, subscriptionId, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the storage sync service.
list_by_storage_sync_service	select	subscriptionId, resourceGroupName, storageSyncServiceName		Get a PrivateEndpointConnection List.
create	insert	resourceGroupName, storageSyncServiceName, subscriptionId, privateEndpointConnectionName		Update the state of specified private endpoint connection associated with the storage sync service.
delete	delete	resourceGroupName, storageSyncServiceName, subscriptionId, privateEndpointConnectionName		Deletes the specified private endpoint connection associated with the storage sync service.

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	The name of the private endpoint connection associated with the Azure resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageSyncServiceName	string	The name of the storage sync service name within the specified resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified private endpoint connection associated with the storage sync service.

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

list_by_storage_sync_service

Get a PrivateEndpointConnection List.

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

INSERT examples

create

Update the state of specified private endpoint connection associated with the storage sync service.

INSERT INTO azure.storage_sync.private_endpoint_connections (
data__properties,
resourceGroupName,
storageSyncServiceName,
subscriptionId,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ storageSyncServiceName }}',
'{{ subscriptionId }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
systemData,
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: storageSyncServiceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: subscriptionId
      value: string (uuid)
      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: |
        Resource properties.

DELETE examples

delete

Deletes the specified private endpoint connection associated with the storage sync service.

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