private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.bot_service.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, resourceName, subscriptionId, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the Bot.
list	select	resourceGroupName, resourceName, subscriptionId		List all the private endpoint connections associated with the Bot.
create	insert	resourceGroupName, resourceName, subscriptionId, privateEndpointConnectionName		Update the state of specified private endpoint connection associated with the Bot.
delete	delete	resourceGroupName, resourceName, subscriptionId, privateEndpointConnectionName		Deletes the specified private endpoint connection associated with the Bot.

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 Bot resource group in the user subscription.
resourceName	string	The name of the Bot resource.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets the specified private endpoint connection associated with the Bot.

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

list

List all the private endpoint connections associated with the Bot.

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

INSERT examples

create

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

INSERT INTO azure.bot_service.private_endpoint_connections (
data__properties,
resourceGroupName,
resourceName,
subscriptionId,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
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: resourceName
      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.

DELETE examples

delete

Deletes the specified private endpoint connection associated with the Bot.

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