private_link_resources

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

Overview

Name	private_link_resources
Type	Resource
Id	azure.batch.private_link_resources

Fields

The following fields are returned by SELECT queries:

get

The operation was successful. The response contains the private link resource.

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 link resource.
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 link resource.
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, privateLinkResourceName		Gets information about the specified private link resource.
list_by_batch_account	select	subscriptionId, resourceGroupName, accountName	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
accountName	string	The name of the Batch account.
privateLinkResourceName	string	The private link resource 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)
maxresults	integer (int32)	The maximum number of items to return in the response.

SELECT examples

get

Gets information about the specified private link resource.

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

list_by_batch_account

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

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