access_policies

Creates, updates, deletes, gets or lists an access_policies resource.

Overview

Name	access_policies
Type	Resource
Id	azure.time_series_insights.access_policies

Fields

The following fields are returned by SELECT queries:

get

The access policy definition was successfully retrieved and is in the response.

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
properties	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_environment

access policies returned successfully.

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
properties	object
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	subscriptionId, resourceGroupName, environmentName, accessPolicyName		Gets the access policy with the specified name in the specified environment.
list_by_environment	select	subscriptionId, resourceGroupName, environmentName		Lists all the available access policies associated with the environment.
create_or_update	insert	subscriptionId, resourceGroupName, environmentName, accessPolicyName, data__properties		Create or update an access policy in the specified environment.
update	update	subscriptionId, resourceGroupName, environmentName, accessPolicyName		Updates the access policy with the specified name in the specified subscription, resource group, and environment.
delete	delete	subscriptionId, resourceGroupName, environmentName, accessPolicyName		Deletes the access policy with the specified name in the specified subscription, resource group, and environment

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
accessPolicyName	string	The name of the Time Series Insights access policy associated with the specified environment.
environmentName	string	The name of the Time Series Insights environment associated with the specified resource group.
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 access policy with the specified name in the specified environment.

SELECT
id,
name,
properties,
type
FROM azure.time_series_insights.access_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
AND accessPolicyName = '{{ accessPolicyName }}' -- required
;

list_by_environment

Lists all the available access policies associated with the environment.

SELECT
id,
name,
properties,
type
FROM azure.time_series_insights.access_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
;

INSERT examples

create_or_update

Create or update an access policy in the specified environment.

INSERT INTO azure.time_series_insights.access_policies (
data__properties,
subscriptionId,
resourceGroupName,
environmentName,
accessPolicyName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ environmentName }}',
'{{ accessPolicyName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_policies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the access_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the access_policies resource.
    - name: environmentName
      value: string
      description: Required parameter for the access_policies resource.
    - name: accessPolicyName
      value: string
      description: Required parameter for the access_policies resource.
    - name: properties
      value: object

UPDATE examples

update

Updates the access policy with the specified name in the specified subscription, resource group, and environment.

UPDATE azure.time_series_insights.access_policies
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND environmentName = '{{ environmentName }}' --required
AND accessPolicyName = '{{ accessPolicyName }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the access policy with the specified name in the specified subscription, resource group, and environment

DELETE FROM azure.time_series_insights.access_policies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND environmentName = '{{ environmentName }}' --required
AND accessPolicyName = '{{ accessPolicyName }}' --required
;