private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.media_services.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
properties	object	Resource properties.
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
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	subscriptionId, resourceGroupName, accountName, name	api-version	Get the details of a private endpoint connection.
list	select	subscriptionId, resourceGroupName, accountName	api-version	List all private endpoint connections.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, name	api-version	Update an existing private endpoint connection.
delete	delete	subscriptionId, resourceGroupName, accountName, name	api-version	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
accountName	string	The Media Services account name.
name	string
resourceGroupName	string	The name of the resource group within the Azure subscription.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription.
api-version	string	The version of the API to be used with the client request.

SELECT examples

get

Get the details of a private endpoint connection.

SELECT
id,
name,
properties,
type
FROM azure.media_services.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND name = '{{ name }}' -- required
AND api-version = '{{ api-version }}'
;

list

List all private endpoint connections.

SELECT
id,
name,
properties,
type
FROM azure.media_services.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Update an existing private endpoint connection.

INSERT INTO azure.media_services.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
name,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ name }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
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: accountName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: name
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: api-version
      value: string
      description: The version of the API to be used with the client request.

DELETE examples

delete

Deletes a private endpoint connection.

DELETE FROM azure.media_services.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND name = '{{ name }}' --required
AND api-version = '{{ api-version }}'
;