private_endpoint_connection

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

Overview

Name	private_endpoint_connection
Type	Resource
Id	azure.batch.private_endpoint_connection

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.
etag	string	The ETag of the resource, used for concurrency statements.
groupIds	array	The group id of the private endpoint connection.
privateEndpoint	object	The ARM resource identifier of the private endpoint.
privateLinkServiceConnectionState	object	The private link service connection state of the private endpoint connection.
provisioningState	string	The provisioning state of the private endpoint connection. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Cancelled". (Creating, Updating, Deleting, Succeeded, Failed, Cancelled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_batch_account

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.
etag	string	The ETag of the resource, used for concurrency statements.
groupIds	array	The group id of the private endpoint connection.
privateEndpoint	object	The ARM resource identifier of the private endpoint.
privateLinkServiceConnectionState	object	The private link service connection state of the private endpoint connection.
provisioningState	string	The provisioning state of the private endpoint connection. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Cancelled". (Creating, Updating, Deleting, Succeeded, Failed, Cancelled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags of the resource.
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	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		Gets information about the specified private endpoint connection.
list_by_batch_account	select	resource_group_name, account_name, subscription_id	maxresults	Lists all of the private endpoint connections in the specified account.
update	update	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		Updates the properties of an existing private endpoint connection.
delete	delete	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		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
account_name	string	A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/ _. Required.
private_endpoint_connection_name	string	The private endpoint connection name. This must be unique within the account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
maxresults	integer	The maximum number of items to return in the response. Default value is None.

SELECT examples

get

Gets information about the specified private endpoint connection.

SELECT
id,
name,
etag,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
tags,
type
FROM azure.batch.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_batch_account

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

SELECT
id,
name,
etag,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
tags,
type
FROM azure.batch.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND maxresults = '{{ maxresults }}'
;

UPDATE examples

update

Updates the properties of an existing private endpoint connection.

UPDATE azure.batch.private_endpoint_connection
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified private endpoint connection.

DELETE FROM azure.batch.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;