private_link_scoped_resources

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

Overview

Name	private_link_scoped_resources
Type	Resource
Id	azure.monitor.private_link_scoped_resources

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved a scoped resource in a private link scope.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Azure resource type

list_by_private_link_scope

Successfully retrieved scoped resources in a private link scope.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, scopeName, name		Gets a scoped resource in a private link scope.
list_by_private_link_scope	select	subscriptionId, resourceGroupName, scopeName		Gets all private endpoint connections on a private link scope.
create_or_update	insert	subscriptionId, resourceGroupName, scopeName, name		Approve or reject a private endpoint connection with a given name.
delete	delete	subscriptionId, resourceGroupName, scopeName, name		Deletes a private endpoint connection with a given name.

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
name	string	The name of the scoped resource object.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
scopeName	string	The name of the Azure Monitor PrivateLinkScope resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a scoped resource in a private link scope.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.monitor.private_link_scoped_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND scopeName = '{{ scopeName }}' -- required
AND name = '{{ name }}' -- required
;

list_by_private_link_scope

Gets all private endpoint connections on a private link scope.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.monitor.private_link_scoped_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND scopeName = '{{ scopeName }}' -- required
;

INSERT examples

create_or_update

Approve or reject a private endpoint connection with a given name.

INSERT INTO azure.monitor.private_link_scoped_resources (
data__properties,
subscriptionId,
resourceGroupName,
scopeName,
name
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ scopeName }}',
'{{ name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_scoped_resources
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_link_scoped_resources resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_link_scoped_resources resource.
    - name: scopeName
      value: string
      description: Required parameter for the private_link_scoped_resources resource.
    - name: name
      value: string
      description: Required parameter for the private_link_scoped_resources resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a private endpoint connection with a given name.

DELETE FROM azure.monitor.private_link_scoped_resources
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND scopeName = '{{ scopeName }}' --required
AND name = '{{ name }}' --required
;