private_endpoint_connections_comps

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

Overview

Name	private_endpoint_connections_comps
Type	Resource
Id	azure.security_and_compliance.private_endpoint_connections_comps

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

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.
systemData	object	Required property for system data
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_service

OK. The request was successful; the request was well-formed and received properly.

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.
systemData	object	Required property for system data
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, resourceName, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the service.
list_by_service	select	subscriptionId, resourceGroupName, resourceName		Lists all private endpoint connections for a service.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName		Update the state of the specified private endpoint connection associated with the service.
delete	delete	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName		Deletes a 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	The name of the private endpoint connection associated with the Azure resource
resourceGroupName	string	The name of the resource group that contains the service instance.
resourceName	string	The name of the service instance.
subscriptionId	string	The subscription identifier.

SELECT examples

get

Gets the specified private endpoint connection associated with the service.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security_and_compliance.private_endpoint_connections_comps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_service

Lists all private endpoint connections for a service.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security_and_compliance.private_endpoint_connections_comps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.security_and_compliance.private_endpoint_connections_comps (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections_comps
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections_comps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections_comps resource.
    - name: resourceName
      value: string
      description: Required parameter for the private_endpoint_connections_comps resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections_comps resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a private endpoint connection.

DELETE FROM azure.security_and_compliance.private_endpoint_connections_comps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;