private_link_resources

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

Overview

Name	private_link_resources
Type	Resource
Id	azure.cosmos_db.private_link_resources

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified private link resource.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Resource properties.
type	string	The type of Azure resource.

list_by_database_account

Successfully retrieved private link resources.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Resource properties.
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, groupName		Gets the private link resources that need to be created for a Cosmos DB account.
list_by_database_account	select	subscriptionId, resourceGroupName, accountName		Gets the private link resources that need to be created for a Cosmos DB 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	Cosmos DB database account name.
groupName	string	The name of the private link resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the private link resources that need to be created for a Cosmos DB account.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND groupName = '{{ groupName }}' -- required
;

list_by_database_account

Gets the private link resources that need to be created for a Cosmos DB account.

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