private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure_isv.redis_enterprise.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	Resource properties.
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	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	select	resourceGroupName, clusterName, privateEndpointConnectionName, subscriptionId		Gets the specified private endpoint connection associated with the Redis Enterprise cluster.
list	select	resourceGroupName, clusterName, subscriptionId		Lists all the private endpoint connections associated with the Redis Enterprise cluster.
put	replace	resourceGroupName, clusterName, subscriptionId, privateEndpointConnectionName		Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster.
delete	delete	resourceGroupName, clusterName, subscriptionId, privateEndpointConnectionName		Deletes the specified private endpoint connection associated with the Redis Enterprise cluster.

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
clusterName	string	The name of the Redis Enterprise cluster.
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.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the specified private endpoint connection associated with the Redis Enterprise cluster.

SELECT
id,
name,
properties,
type
FROM azure_isv.redis_enterprise.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all the private endpoint connections associated with the Redis Enterprise cluster.

SELECT
id,
name,
properties,
type
FROM azure_isv.redis_enterprise.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

REPLACE examples

put

Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster.

REPLACE azure_isv.redis_enterprise.private_endpoint_connections
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the specified private endpoint connection associated with the Redis Enterprise cluster.

DELETE FROM azure_isv.redis_enterprise.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;