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

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.
encryption	object	The encryption settings for a configuration store.
healthStatus	string	The health status of the resource. Known values are: "Undetermined", "Healthy", "Warning", and "Unhealthy". (Undetermined, Healthy, Warning, Unhealthy)
identity	object	The identity of the EnterprisePolicy.
kind	string	The kind (type) of Enterprise Policy. Required. Known values are: "Lockbox", "PrivateEndpoint", "Encryption", "NetworkInjection", and "Identity". (Lockbox, PrivateEndpoint, Encryption, NetworkInjection, Identity)
location	string	The geo-location where the resource lives. Required.
lockbox	object	Settings concerning lockbox.
networkInjection	object	Settings concerning network injection.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The internally assigned unique identifier of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
encryption	object	The encryption settings for a configuration store.
healthStatus	string	The health status of the resource. Known values are: "Undetermined", "Healthy", "Warning", and "Unhealthy". (Undetermined, Healthy, Warning, Unhealthy)
identity	object	The identity of the EnterprisePolicy.
kind	string	The kind (type) of Enterprise Policy. Required. Known values are: "Lockbox", "PrivateEndpoint", "Encryption", "NetworkInjection", and "Identity". (Lockbox, PrivateEndpoint, Encryption, NetworkInjection, Identity)
location	string	The geo-location where the resource lives. Required.
lockbox	object	Settings concerning lockbox.
networkInjection	object	Settings concerning network injection.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The internally assigned unique identifier of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
encryption	object	The encryption settings for a configuration store.
healthStatus	string	The health status of the resource. Known values are: "Undetermined", "Healthy", "Warning", and "Unhealthy". (Undetermined, Healthy, Warning, Unhealthy)
identity	object	The identity of the EnterprisePolicy.
kind	string	The kind (type) of Enterprise Policy. Required. Known values are: "Lockbox", "PrivateEndpoint", "Encryption", "NetworkInjection", and "Identity". (Lockbox, PrivateEndpoint, Encryption, NetworkInjection, Identity)
location	string	The geo-location where the resource lives. Required.
lockbox	object	Settings concerning lockbox.
networkInjection	object	Settings concerning network injection.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	The internally assigned unique identifier of the resource.
tags	object	Resource tags.
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	enterprise_policy_name, resource_group_name, subscription_id		Get information about an EnterprisePolicy.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieve a list of EnterprisePolicies within a given resource group.
list_by_subscription	select	subscription_id		Retrieve a list of EnterprisePolicies within a subscription.
create_or_update	insert	enterprise_policy_name, resource_group_name, subscription_id, location, kind		Creates an EnterprisePolicy.
update	update	enterprise_policy_name, resource_group_name, subscription_id		Updates an EnterprisePolicy.
create_or_update	replace	enterprise_policy_name, resource_group_name, subscription_id, location, kind		Creates an EnterprisePolicy.
delete	delete	resource_group_name, enterprise_policy_name, subscription_id		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
enterprise_policy_name	string	The EnterprisePolicy name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get information about an EnterprisePolicy.

SELECT
id,
name,
encryption,
healthStatus,
identity,
kind,
location,
lockbox,
networkInjection,
systemData,
systemId,
tags,
type
FROM azure_extras.power_platform.enterprise_policies
WHERE enterprise_policy_name = '{{ enterprise_policy_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieve a list of EnterprisePolicies within a given resource group.

SELECT
id,
name,
encryption,
healthStatus,
identity,
kind,
location,
lockbox,
networkInjection,
systemData,
systemId,
tags,
type
FROM azure_extras.power_platform.enterprise_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Retrieve a list of EnterprisePolicies within a subscription.

SELECT
id,
name,
encryption,
healthStatus,
identity,
kind,
location,
lockbox,
networkInjection,
systemData,
systemId,
tags,
type
FROM azure_extras.power_platform.enterprise_policies
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates an EnterprisePolicy.

INSERT INTO azure_extras.power_platform.enterprise_policies (
tags,
location,
properties,
identity,
kind,
enterprise_policy_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ kind }}' /* required */,
'{{ enterprise_policy_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: enterprise_policies
props:
  - name: enterprise_policy_name
    value: "{{ enterprise_policy_name }}"
    description: Required parameter for the enterprise_policies resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the enterprise_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the enterprise_policies resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The properties that define configuration for the enterprise policy.
    value:
      systemId: "{{ systemId }}"
      lockbox:
        state: "{{ state }}"
      encryption:
        keyVault:
          id: "{{ id }}"
          key:
            name: "{{ name }}"
            version: "{{ version }}"
        state: "{{ state }}"
      networkInjection:
        virtualNetworks:
          - id: "{{ id }}"
            subnet:
              name: "{{ name }}"
      healthStatus: "{{ healthStatus }}"
  - name: identity
    description: |
      The identity of the EnterprisePolicy.
    value:
      systemAssignedIdentityPrincipalId: "{{ systemAssignedIdentityPrincipalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind (type) of Enterprise Policy. Required. Known values are: "Lockbox", "PrivateEndpoint", "Encryption", "NetworkInjection", and "Identity".
    valid_values: ['Lockbox', 'PrivateEndpoint', 'Encryption', 'NetworkInjection', 'Identity']

UPDATE examples

update

Updates an EnterprisePolicy.

UPDATE azure_extras.power_platform.enterprise_policies
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
enterprise_policy_name = '{{ enterprise_policy_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates an EnterprisePolicy.

REPLACE azure_extras.power_platform.enterprise_policies
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
kind = '{{ kind }}'
WHERE 
enterprise_policy_name = '{{ enterprise_policy_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an EnterprisePolicy.

DELETE FROM azure_extras.power_platform.enterprise_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND enterprise_policy_name = '{{ enterprise_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;