enterprise_policies

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

Overview

Name	enterprise_policies
Type	Resource
Id	azure_extras.power_platform.enterprise_policies

Fields

The following fields are returned by SELECT queries:

get

OK. The EnterprisePolicy was returned successfully.

Name	Datatype	Description
identity	object	The identity of the EnterprisePolicy.
kind	string	The kind (type) of Enterprise Policy.
location	string	The geo-location where the resource lives
properties	object	The properties that define configuration for the enterprise policy
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

OK. List of EnterprisePolicies.

Name	Datatype	Description
identity	object	The identity of the EnterprisePolicy.
kind	string	The kind (type) of Enterprise Policy.
location	string	The geo-location where the resource lives
properties	object	The properties that define configuration for the enterprise policy
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_subscription

OK. List of EnterprisePolicies.

Name	Datatype	Description
identity	object	The identity of the EnterprisePolicy.
kind	string	The kind (type) of Enterprise Policy.
location	string	The geo-location where the resource lives
properties	object	The properties that define configuration for the enterprise policy
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	enterprisePolicyName, subscriptionId, resourceGroupName		Get information about an EnterprisePolicy
list_by_resource_group	select	subscriptionId, resourceGroupName		Retrieve a list of EnterprisePolicies within a given resource group
list_by_subscription	select	subscriptionId		Retrieve a list of EnterprisePolicies within a subscription
create_or_update	insert	enterprisePolicyName, subscriptionId, resourceGroupName, data__kind		Creates an EnterprisePolicy
update	update	enterprisePolicyName, subscriptionId, resourceGroupName		Updates an EnterprisePolicy
delete	delete	resourceGroupName, enterprisePolicyName, subscriptionId		Delete an EnterprisePolicy

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
enterprisePolicyName	string	Name of the EnterprisePolicy
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get information about an EnterprisePolicy

SELECT
identity,
kind,
location,
properties,
systemData,
tags
FROM azure_extras.power_platform.enterprise_policies
WHERE enterprisePolicyName = '{{ enterprisePolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_resource_group

Retrieve a list of EnterprisePolicies within a given resource group

SELECT
identity,
kind,
location,
properties,
systemData,
tags
FROM azure_extras.power_platform.enterprise_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Retrieve a list of EnterprisePolicies within a subscription

SELECT
identity,
kind,
location,
properties,
systemData,
tags
FROM azure_extras.power_platform.enterprise_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates an EnterprisePolicy

INSERT INTO azure_extras.power_platform.enterprise_policies (
data__tags,
data__location,
data__identity,
data__kind,
data__properties,
enterprisePolicyName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ kind }}' /* required */,
'{{ properties }}',
'{{ enterprisePolicyName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
identity,
kind,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: enterprise_policies
  props:
    - name: enterprisePolicyName
      value: string
      description: Required parameter for the enterprise_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the enterprise_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the enterprise_policies resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        The identity of the EnterprisePolicy.
    - name: kind
      value: string
      description: |
        The kind (type) of Enterprise Policy.
      valid_values: ['Lockbox', 'PrivateEndpoint', 'Encryption', 'NetworkInjection', 'Identity']
    - name: properties
      value: object
      description: |
        The properties that define configuration for the enterprise policy

UPDATE examples

update

Updates an EnterprisePolicy

UPDATE azure_extras.power_platform.enterprise_policies
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__identity = '{{ identity }}',
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
enterprisePolicyName = '{{ enterprisePolicyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
RETURNING
identity,
kind,
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete an EnterprisePolicy

DELETE FROM azure_extras.power_platform.enterprise_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND enterprisePolicyName = '{{ enterprisePolicyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;