private_link_resources

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

Overview

Name	private_link_resources
Type	Resource
Id	azure.event_grid.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 private link resource will be either topic, domain, partnerNamespace or namespace.
displayName	string	:vartype display_name: str
groupId	string	:vartype group_id: str
requiredMembers	array	:vartype required_members: list[str]
requiredZoneNames	array	:vartype required_zone_names: list[str]
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource

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 private link resource will be either topic, domain, partnerNamespace or namespace.
displayName	string	:vartype display_name: str
groupId	string	:vartype group_id: str
requiredMembers	array	:vartype required_members: list[str]
requiredZoneNames	array	:vartype required_zone_names: list[str]
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, parent_type, parent_name, private_link_resource_name, subscription_id		Get a private link resource. Get properties of a private link resource.
list_by_resource	select	resource_group_name, parent_type, parent_name, subscription_id	$filter, $top	List private link resources under specific topic, domain, or partner namespace or namespace. List all the private link resources under a topic, domain, or partner namespace or namespace.

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
parent_name	string	The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). Required.
parent_type	string	The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. Required.
private_link_resource_name	string	The name of private link resource will be either topic, domain, partnerNamespace or namespace. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
$top	integer	The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

SELECT examples

get

Get a private link resource. Get properties of a private link resource.

SELECT
id,
name,
displayName,
groupId,
requiredMembers,
requiredZoneNames,
type
FROM azure.event_grid.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parent_type = '{{ parent_type }}' -- required
AND parent_name = '{{ parent_name }}' -- required
AND private_link_resource_name = '{{ private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource

List private link resources under specific topic, domain, or partner namespace or namespace. List all the private link resources under a topic, domain, or partner namespace or namespace.

SELECT
id,
name,
displayName,
groupId,
requiredMembers,
requiredZoneNames,
type
FROM azure.event_grid.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parent_type = '{{ parent_type }}' -- required
AND parent_name = '{{ parent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;