Microsoft.PowerPlatform enterprisePolicies
Bicep resource definition
The enterprisePolicies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.PowerPlatform/enterprisePolicies resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.PowerPlatform/enterprisePolicies@2020-10-30-preview' = {
identity: {
type: 'string'
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
encryption: {
keyVault: {
id: 'string'
key: {
name: 'string'
version: 'string'
}
}
state: 'string'
}
healthStatus: 'string'
lockbox: {
state: 'string'
}
networkInjection: {
virtualNetworks: {
nextLink: 'string'
value: [
{
id: 'string'
subnet: {
name: 'string'
}
}
]
}
}
}
tags: {
{customized property}: 'string'
}
}
Property values
EnterprisePolicyIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. | 'None' 'SystemAssigned' |
KeyProperties
| Name | Description | Value |
|---|---|---|
| name | The identifier of the key vault key used to encrypt data. | string |
| version | The version of the identity which will be used to access key vault. | string |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| id | Uri of KeyVault | string |
| key | Identity of the secret that includes name and version. | KeyProperties |
Microsoft.PowerPlatform/enterprisePolicies
| Name | Description | Value |
|---|---|---|
| identity | The identity of the EnterprisePolicy. | EnterprisePolicyIdentity |
| kind | The kind (type) of Enterprise Policy. | 'Encryption' 'Identity' 'Lockbox' 'NetworkInjection' 'PrivateEndpoint' (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The properties that define configuration for the enterprise policy | Properties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Properties
| Name | Description | Value |
|---|---|---|
| encryption | The encryption settings for a configuration store. | PropertiesEncryption |
| healthStatus | The health status of the resource. | 'Healthy' 'Undetermined' 'Unhealthy' 'Warning' |
| lockbox | Settings concerning lockbox. | PropertiesLockbox |
| networkInjection | Settings concerning network injection. | PropertiesNetworkInjection |
PropertiesEncryption
| Name | Description | Value |
|---|---|---|
| keyVault | Key vault properties. | KeyVaultProperties |
| state | The state of onboarding, which only appears in the response. | 'Disabled' 'Enabled' 'NotConfigured' |
PropertiesLockbox
| Name | Description | Value |
|---|---|---|
| state | lockbox configuration | 'Disabled' 'Enabled' 'NotConfigured' |
PropertiesNetworkInjection
| Name | Description | Value |
|---|---|---|
| virtualNetworks | Network injection configuration | VirtualNetworkPropertiesList |
SubnetProperties
| Name | Description | Value |
|---|---|---|
| name | Subnet name. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
VirtualNetworkProperties
| Name | Description | Value |
|---|---|---|
| id | Uri of the virtual network. | string |
| subnet | Properties of a subnet. | SubnetProperties |
VirtualNetworkPropertiesList
| Name | Description | Value |
|---|---|---|
| nextLink | Next page link if any. | string |
| value | Array of virtual networks. | VirtualNetworkProperties[] |
ARM template resource definition
The enterprisePolicies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.PowerPlatform/enterprisePolicies resource, add the following JSON to your template.
{
"type": "Microsoft.PowerPlatform/enterprisePolicies",
"apiVersion": "2020-10-30-preview",
"name": "string",
"identity": {
"type": "string"
},
"kind": "string",
"location": "string",
"properties": {
"encryption": {
"keyVault": {
"id": "string",
"key": {
"name": "string",
"version": "string"
}
},
"state": "string"
},
"healthStatus": "string",
"lockbox": {
"state": "string"
},
"networkInjection": {
"virtualNetworks": {
"nextLink": "string",
"value": [
{
"id": "string",
"subnet": {
"name": "string"
}
}
]
}
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
EnterprisePolicyIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. | 'None' 'SystemAssigned' |
KeyProperties
| Name | Description | Value |
|---|---|---|
| name | The identifier of the key vault key used to encrypt data. | string |
| version | The version of the identity which will be used to access key vault. | string |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| id | Uri of KeyVault | string |
| key | Identity of the secret that includes name and version. | KeyProperties |
Microsoft.PowerPlatform/enterprisePolicies
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-10-30-preview' |
| identity | The identity of the EnterprisePolicy. | EnterprisePolicyIdentity |
| kind | The kind (type) of Enterprise Policy. | 'Encryption' 'Identity' 'Lockbox' 'NetworkInjection' 'PrivateEndpoint' (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The properties that define configuration for the enterprise policy | Properties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.PowerPlatform/enterprisePolicies' |
Properties
| Name | Description | Value |
|---|---|---|
| encryption | The encryption settings for a configuration store. | PropertiesEncryption |
| healthStatus | The health status of the resource. | 'Healthy' 'Undetermined' 'Unhealthy' 'Warning' |
| lockbox | Settings concerning lockbox. | PropertiesLockbox |
| networkInjection | Settings concerning network injection. | PropertiesNetworkInjection |
PropertiesEncryption
| Name | Description | Value |
|---|---|---|
| keyVault | Key vault properties. | KeyVaultProperties |
| state | The state of onboarding, which only appears in the response. | 'Disabled' 'Enabled' 'NotConfigured' |
PropertiesLockbox
| Name | Description | Value |
|---|---|---|
| state | lockbox configuration | 'Disabled' 'Enabled' 'NotConfigured' |
PropertiesNetworkInjection
| Name | Description | Value |
|---|---|---|
| virtualNetworks | Network injection configuration | VirtualNetworkPropertiesList |
SubnetProperties
| Name | Description | Value |
|---|---|---|
| name | Subnet name. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
VirtualNetworkProperties
| Name | Description | Value |
|---|---|---|
| id | Uri of the virtual network. | string |
| subnet | Properties of a subnet. | SubnetProperties |
VirtualNetworkPropertiesList
| Name | Description | Value |
|---|---|---|
| nextLink | Next page link if any. | string |
| value | Array of virtual networks. | VirtualNetworkProperties[] |
Terraform (AzAPI provider) resource definition
The enterprisePolicies resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.PowerPlatform/enterprisePolicies resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.PowerPlatform/enterprisePolicies@2020-10-30-preview"
name = "string"
identity = {
type = "string"
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
encryption = {
keyVault = {
id = "string"
key = {
name = "string"
version = "string"
}
}
state = "string"
}
healthStatus = "string"
lockbox = {
state = "string"
}
networkInjection = {
virtualNetworks = {
nextLink = "string"
value = [
{
id = "string"
subnet = {
name = "string"
}
}
]
}
}
}
})
}
Property values
EnterprisePolicyIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. | 'None' 'SystemAssigned' |
KeyProperties
| Name | Description | Value |
|---|---|---|
| name | The identifier of the key vault key used to encrypt data. | string |
| version | The version of the identity which will be used to access key vault. | string |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| id | Uri of KeyVault | string |
| key | Identity of the secret that includes name and version. | KeyProperties |
Microsoft.PowerPlatform/enterprisePolicies
| Name | Description | Value |
|---|---|---|
| identity | The identity of the EnterprisePolicy. | EnterprisePolicyIdentity |
| kind | The kind (type) of Enterprise Policy. | 'Encryption' 'Identity' 'Lockbox' 'NetworkInjection' 'PrivateEndpoint' (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The properties that define configuration for the enterprise policy | Properties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.PowerPlatform/enterprisePolicies@2020-10-30-preview" |
Properties
| Name | Description | Value |
|---|---|---|
| encryption | The encryption settings for a configuration store. | PropertiesEncryption |
| healthStatus | The health status of the resource. | 'Healthy' 'Undetermined' 'Unhealthy' 'Warning' |
| lockbox | Settings concerning lockbox. | PropertiesLockbox |
| networkInjection | Settings concerning network injection. | PropertiesNetworkInjection |
PropertiesEncryption
| Name | Description | Value |
|---|---|---|
| keyVault | Key vault properties. | KeyVaultProperties |
| state | The state of onboarding, which only appears in the response. | 'Disabled' 'Enabled' 'NotConfigured' |
PropertiesLockbox
| Name | Description | Value |
|---|---|---|
| state | lockbox configuration | 'Disabled' 'Enabled' 'NotConfigured' |
PropertiesNetworkInjection
| Name | Description | Value |
|---|---|---|
| virtualNetworks | Network injection configuration | VirtualNetworkPropertiesList |
SubnetProperties
| Name | Description | Value |
|---|---|---|
| name | Subnet name. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
VirtualNetworkProperties
| Name | Description | Value |
|---|---|---|
| id | Uri of the virtual network. | string |
| subnet | Properties of a subnet. | SubnetProperties |
VirtualNetworkPropertiesList
| Name | Description | Value |
|---|---|---|
| nextLink | Next page link if any. | string |
| value | Array of virtual networks. | VirtualNetworkProperties[] |