private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.cognitive_services.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the private endpoint connection properties successfully.

Name	Datatype	Description
etag	string	Resource Etag.
location	string	The location of the private endpoint connection
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list

Successfully retrieved private endpoint connections.

Name	Datatype	Description
etag	string	Resource Etag.
location	string	The location of the private endpoint connection
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the Cognitive Services account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the private endpoint connections associated with the Cognitive Services account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, privateEndpointConnectionName		Update the state of specified private endpoint connection associated with the Cognitive Services account.
delete	delete	resourceGroupName, accountName, subscriptionId, privateEndpointConnectionName		Deletes the specified private endpoint connection associated with the Cognitive Services account.

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 name of Cognitive Services account.
privateEndpointConnectionName	string	The name of the private endpoint connection associated with the Cognitive Services Account
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 Cognitive Services account.

SELECT
etag,
location,
properties,
systemData
FROM azure.cognitive_services.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list

Gets the private endpoint connections associated with the Cognitive Services account.

SELECT
etag,
location,
properties,
systemData
FROM azure.cognitive_services.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Update the state of specified private endpoint connection associated with the Cognitive Services account.

INSERT INTO azure.cognitive_services.private_endpoint_connections (
data__properties,
data__location,
resourceGroupName,
accountName,
subscriptionId,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ privateEndpointConnectionName }}'
RETURNING
etag,
location,
properties,
systemData
;

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: accountName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: subscriptionId
      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: |
        Resource properties.
    - name: location
      value: string
      description: |
        The location of the private endpoint connection

DELETE examples

delete

Deletes the specified private endpoint connection associated with the Cognitive Services account.

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