access_policies

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

Overview

Name	access_policies
Type	Resource
Id	azure_extras.time_series_insights.access_policies

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.
description	string	An description of the access policy.
principalObjectId	string	The objectId of the principal in Azure Active Directory.
roles	array	The list of roles the principal is assigned on the environment.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_environment

Name	Datatype	Description
value	array	Result of the List access policies operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, environment_name, access_policy_name, subscription_id		Gets the access policy with the specified name in the specified environment.
list_by_environment	select	resource_group_name, environment_name, subscription_id		Lists all the available access policies associated with the environment.
create_or_update	insert	resource_group_name, environment_name, access_policy_name, subscription_id		Create or update an access policy in the specified environment.
update	update	resource_group_name, environment_name, access_policy_name, subscription_id		Updates the access policy with the specified name in the specified subscription, resource group, and environment.
create_or_update	replace	resource_group_name, environment_name, access_policy_name, subscription_id		Create or update an access policy in the specified environment.
delete	delete	resource_group_name, environment_name, access_policy_name, subscription_id		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
access_policy_name	string	The name of the Time Series Insights access policy associated with the specified environment. Required.
environment_name	string	The name of the Time Series Insights environment associated with the specified resource group. Required.
resource_group_name	string	Name of an Azure Resource group. Required.
subscription_id	string

SELECT examples

get

Gets the access policy with the specified name in the specified environment.

SELECT
id,
name,
description,
principalObjectId,
roles,
type
FROM azure_extras.time_series_insights.access_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND access_policy_name = '{{ access_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_environment

Lists all the available access policies associated with the environment.

SELECT
value
FROM azure_extras.time_series_insights.access_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an access policy in the specified environment.

INSERT INTO azure_extras.time_series_insights.access_policies (
properties,
resource_group_name,
environment_name,
access_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ access_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_policies resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the access_policies resource.
  - name: access_policy_name
    value: "{{ access_policy_name }}"
    description: Required parameter for the access_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_policies resource.
  - name: properties
    value:
      principalObjectId: "{{ principalObjectId }}"
      description: "{{ description }}"
      roles:
        - "{{ roles }}"

UPDATE examples

update

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

UPDATE azure_extras.time_series_insights.access_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND access_policy_name = '{{ access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

REPLACE examples

create_or_update

Create or update an access policy in the specified environment.

REPLACE azure_extras.time_series_insights.access_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND access_policy_name = '{{ access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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_extras.time_series_insights.access_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND access_policy_name = '{{ access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;