bookshelf_private_link_resources

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

Overview

Name	bookshelf_private_link_resources
Type	Resource
Id	azure.discovery.bookshelf_private_link_resources

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.
groupId	string	The private link resource group id.
requiredMembers	array	The private link resource required member names.
requiredZoneNames	array	The private link resource private link DNS zone name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_bookshelf

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.
groupId	string	The private link resource group id.
requiredMembers	array	The private link resource required member names.
requiredZoneNames	array	The private link resource private link DNS zone name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, bookshelf_name, private_link_resource_name, subscription_id		Gets the specified private link resource for the bookshelf.
list_by_bookshelf	select	resource_group_name, bookshelf_name, subscription_id		Lists all private link resources for the bookshelf.

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
bookshelf_name	string	The name of the Bookshelf. Required.
private_link_resource_name	string	The name of the private link associated with the Azure resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified private link resource for the bookshelf.

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.discovery.bookshelf_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND bookshelf_name = '{{ bookshelf_name }}' -- required
AND private_link_resource_name = '{{ private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_bookshelf

Lists all private link resources for the bookshelf.

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.discovery.bookshelf_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND bookshelf_name = '{{ bookshelf_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;