private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.batch.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

The operation was successful. The response contains the private endpoint connection.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
properties	object	The properties associated with the private endpoint connection.
tags	object	The tags of the resource.
type	string	The type of the resource.

list_by_batch_account

The operation was successful. The response contains a list of private link resources associated with the account.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
properties	object	The properties associated with the private endpoint connection.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName		Gets information about the specified private endpoint connection.
list_by_batch_account	select	subscriptionId, resourceGroupName, accountName	maxresults	Lists all of the private endpoint connections in the specified account.
update	update	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName	If-Match	Updates the properties of an existing private endpoint connection.
delete	delete	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName		Deletes the specified 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 name of the Batch account.
privateEndpointConnectionName	string	The private endpoint connection name. This must be unique within the account.
resourceGroupName	string	The name of the resource group that contains the Batch account.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
If-Match	string	The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally.
maxresults	integer (int32)	The maximum number of items to return in the response.

SELECT examples

get

Gets information about the specified private endpoint connection.

SELECT
id,
name,
etag,
properties,
tags,
type
FROM azure.batch.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_batch_account

Lists all of the private endpoint connections in the specified account.

SELECT
id,
name,
etag,
properties,
tags,
type
FROM azure.batch.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND maxresults = '{{ maxresults }}'
;

UPDATE examples

update

Updates the properties of an existing private endpoint connection.

UPDATE azure.batch.private_endpoint_connections
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified private endpoint connection.

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