private_link_resource

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

Overview

Name	private_link_resource
Type	Resource
Id	azure.batch.private_link_resource

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.
groupId	string	The group id of the private link resource.
requiredMembers	array	The list of required members that are used to establish the private link connection.
requiredZoneNames	array	The list of required zone names for the private DNS resource name.
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.
groupId	string	The group id of the private link resource.
requiredMembers	array	The list of required members that are used to establish the private link connection.
requiredZoneNames	array	The list of required zone names for the private DNS resource name.
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_link_resource_name, subscription_id		Gets information about the specified private link resource.
list_by_batch_account	select	resource_group_name, account_name, subscription_id	maxresults	Lists all of the private link resources in the specified 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
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_link_resource_name	string	The private link resource 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 link resource.

SELECT
id,
name,
etag,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
tags,
type
FROM azure.batch.private_link_resource
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND private_link_resource_name = '{{ private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_batch_account

Lists all of the private link resources in the specified account.

SELECT
id,
name,
etag,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
tags,
type
FROM azure.batch.private_link_resource
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND maxresults = '{{ maxresults }}'
;