private_link_scopes

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

Overview

Name	private_link_scopes
Type	Resource
Id	azure.monitor.private_link_scopes

Fields

The following fields are returned by SELECT queries:

get

An Azure Monitor PrivateLinkScope definition.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties that define a Azure Monitor PrivateLinkScope resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

A list containing 0 or more Azure Monitor PrivateLinkScope definitions.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties that define a Azure Monitor PrivateLinkScope resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

A list containing 0 or more Azure Monitor PrivateLinkScope definitions.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties that define a Azure Monitor PrivateLinkScope resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, scopeName		Returns a Azure Monitor PrivateLinkScope.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets a list of Azure Monitor PrivateLinkScopes within a resource group.
list	select	subscriptionId		Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.
create_or_update	insert	resourceGroupName, subscriptionId, scopeName, data__properties		Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
delete	delete	resourceGroupName, subscriptionId, scopeName		Deletes a Azure Monitor PrivateLinkScope.
update_tags	exec	resourceGroupName, subscriptionId, scopeName		Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

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
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

Returns a Azure Monitor PrivateLinkScope.

SELECT
location,
properties,
systemData,
tags
FROM azure.monitor.private_link_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND scopeName = '{{ scopeName }}' -- required
;

list_by_resource_group

Gets a list of Azure Monitor PrivateLinkScopes within a resource group.

SELECT
location,
properties,
systemData,
tags
FROM azure.monitor.private_link_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.monitor.private_link_scopes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

INSERT INTO azure.monitor.private_link_scopes (
data__properties,
data__tags,
data__location,
resourceGroupName,
subscriptionId,
scopeName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ scopeName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: private_link_scopes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_link_scopes resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the private_link_scopes resource.
    - name: scopeName
      value: string
      description: Required parameter for the private_link_scopes resource.
    - name: properties
      value: object
      description: |
        Properties that define a Azure Monitor PrivateLinkScope resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes a Azure Monitor PrivateLinkScope.

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

Lifecycle Methods

update_tags

Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

EXEC azure.monitor.private_link_scopes.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@scopeName='{{ scopeName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;