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

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.
kind	string	The kind of scoped Azure monitor resource. Known values are: "Resource" and "Metrics". (Resource, Metrics)
linkedResourceId	string	The resource id of the scoped Azure monitor resource.
provisioningState	string	State of the Azure monitor resource. Known values are: "Succeeded", "Provisioning", "Failed", and "Canceled". (Succeeded, Provisioning, Failed, Canceled)
subscriptionLocation	string	The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
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_private_link_scope

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.
kind	string	The kind of scoped Azure monitor resource. Known values are: "Resource" and "Metrics". (Resource, Metrics)
linkedResourceId	string	The resource id of the scoped Azure monitor resource.
provisioningState	string	State of the Azure monitor resource. Known values are: "Succeeded", "Provisioning", "Failed", and "Canceled". (Succeeded, Provisioning, Failed, Canceled)
subscriptionLocation	string	The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
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, scope_name, name, subscription_id		Gets a scoped resource in a private link scope.
list_by_private_link_scope	select	resource_group_name, scope_name, subscription_id	kind	Gets all scoped resources on a private link scope.
create_or_update	insert	resource_group_name, scope_name, name, subscription_id		Add an Azure monitor scoped resource in the private link scope.
create_or_update	replace	resource_group_name, scope_name, name, subscription_id		Add an Azure monitor scoped resource in the private link scope.
delete	delete	resource_group_name, scope_name, name, subscription_id		Deletes an Azure monitor scoped resource 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. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scope_name	string	The name of the Azure Monitor PrivateLinkScope resource. Required.
subscription_id	string
kind	string	The kind of the private link resource. Not specifying a kind will return scoped resources of all kinds. Default value is None.

SELECT examples

get

Gets a scoped resource in a private link scope.

SELECT
id,
name,
kind,
linkedResourceId,
provisioningState,
subscriptionLocation,
systemData,
type
FROM azure.monitor.private_link_scoped_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scope_name = '{{ scope_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_private_link_scope

Gets all scoped resources on a private link scope.

SELECT
id,
name,
kind,
linkedResourceId,
provisioningState,
subscriptionLocation,
systemData,
type
FROM azure.monitor.private_link_scoped_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scope_name = '{{ scope_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND kind = '{{ kind }}'
;

INSERT examples

create_or_update

Add an Azure monitor scoped resource in the private link scope.

INSERT INTO azure.monitor.private_link_scoped_resources (
properties,
resource_group_name,
scope_name,
name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scope_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_scoped_resources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_link_scoped_resources resource.
  - name: scope_name
    value: "{{ scope_name }}"
    description: Required parameter for the private_link_scoped_resources resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the private_link_scoped_resources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_link_scoped_resources resource.
  - name: properties
    description: |
      Resource properties.
    value:
      kind: "{{ kind }}"
      linkedResourceId: "{{ linkedResourceId }}"
      subscriptionLocation: "{{ subscriptionLocation }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Add an Azure monitor scoped resource in the private link scope.

REPLACE azure.monitor.private_link_scoped_resources
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scope_name = '{{ scope_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an Azure monitor scoped resource with a given name.

DELETE FROM azure.monitor.private_link_scoped_resources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND scope_name = '{{ scope_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;