Policy types for @turbot/azure-keyvault
- Azure > Key Vault > Approved Regions [Default]
- Azure > Key Vault > Enabled
- Azure > Key Vault > Key > Active
- Azure > Key Vault > Key > Active > Age
- Azure > Key Vault > Key > Active > Last Modified
- Azure > Key Vault > Key > Approved
- Azure > Key Vault > Key > Approved > Custom
- Azure > Key Vault > Key > Approved > Regions
- Azure > Key Vault > Key > Approved > Usage
- Azure > Key Vault > Key > CMDB
- Azure > Key Vault > Key > Expiration
- Azure > Key Vault > Key > Expiration > Days [Default]
- Azure > Key Vault > Key > Regions
- Azure > Key Vault > Permissions
- Azure > Key Vault > Permissions > Levels
- Azure > Key Vault > Permissions > Levels > Modifiers
- Azure > Key Vault > Regions
- Azure > Key Vault > Secret > Active
- Azure > Key Vault > Secret > Active > Age
- Azure > Key Vault > Secret > Active > Last Modified
- Azure > Key Vault > Secret > Approved
- Azure > Key Vault > Secret > Approved > Custom
- Azure > Key Vault > Secret > Approved > Regions
- Azure > Key Vault > Secret > Approved > Usage
- Azure > Key Vault > Secret > CMDB
- Azure > Key Vault > Secret > Expiration
- Azure > Key Vault > Secret > Expiration > Days [Default]
- Azure > Key Vault > Secret > Regions
- Azure > Key Vault > Tags Template [Default]
- Azure > Key Vault > Vault > Active
- Azure > Key Vault > Vault > Active > Age
- Azure > Key Vault > Vault > Active > Last Modified
- Azure > Key Vault > Vault > Approved
- Azure > Key Vault > Vault > Approved > Custom
- Azure > Key Vault > Vault > Approved > Regions
- Azure > Key Vault > Vault > Approved > Usage
- Azure > Key Vault > Vault > CMDB
- Azure > Key Vault > Vault > Purge Protection
- Azure > Key Vault > Vault > Regions
- Azure > Key Vault > Vault > Tags
- Azure > Key Vault > Vault > Tags > Template
- Azure > Turbot > Permissions > Compiled > Levels > @turbot/azure-keyvault
- Azure > Turbot > Permissions > Compiled > Service Permissions > @turbot/azure-keyvault
Azure > Key Vault > Approved Regions [Default]
A list of Azure regions in which Azure Key Vault resources are approved for use.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
This policy is the default value for all Azure Key Vault resources' Approved > Regions policies.
tmod:@turbot/azure-keyvault#/policy/types/keyVaultApprovedRegionsDefault
"{\n regions: policyValue(uri:\"tmod:@turbot/azure#/policy/types/approvedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Enabled
Enable Azure Key Vault service.
tmod:@turbot/azure-keyvault#/policy/types/keyVaultEnabled
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
Azure > Key Vault > Key > Active
Determine the action to take when an Azure Key Vault key, based on the Azure > Key Vault > Key > Active > *
policies.
The control determines whether the resource is in active use, and if not,
has the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Key > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note: In contrast with Approved, where if the
resource appears to be Unapproved for any reason it will be considered
Unapproved.
See Active for more information.
tmod:@turbot/azure-keyvault#/policy/types/keyActive
[ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning"]
{ "type": "string", "enum": [ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning" ], "example": [ "Check: Active" ], "default": "Skip"}
Azure > Key Vault > Key > Active > Age
The age after which the Azure Key Vault key
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Key > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note In contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
tmod:@turbot/azure-keyvault#/policy/types/keyActiveAge
[ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days"]
{ "type": "string", "enum": [ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days" ], "example": [ "Force inactive if age > 90 days" ], "default": "Skip"}
Azure > Key Vault > Key > Active > Last Modified
The number of days since the Azure Key Vault key was last modified before it is considered
inactive.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Key > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note In contrast with Approved, where if the
resource appears to be Unapproved for any reason it will be considered
Unapproved.
tmod:@turbot/azure-keyvault#/policy/types/keyActiveLastModified
[ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days"]
{ "type": "string", "enum": [ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days" ], "example": [ "Active if last modified <= 90 days" ], "default": "Skip"}
Azure > Key Vault > Key > Approved
Determine the action to take when an Azure Key Vault key is not approved based on Azure > Key Vault > Key > Approved > *
policies.
The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.
For any enforcement actions that specify if new
, e.g., Enforce: Delete unapproved if new
, this control will only take the enforcement actions for resources created within the last 60 minutes.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/keyApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
Azure > Key Vault > Key > Approved > Custom
Determine whether the Azure Key Vault key is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure Key Vault key is not approved, it will be subject to the action specified in the Azure > Key Vault > Key > Approved
policy.
See Approved for more information.
Note: The policy value must be a string with a value of Approved
, Not approved
or Skip
, or in the form of YAML objects. The object(s) must contain the key result
with its value as Approved
or Not approved
. A custom title and message can also be added using the keys title
and message
respectively.
tmod:@turbot/azure-keyvault#/policy/types/keyApprovedCustom
{ "example": [ "Approved", "Not approved", "Skip", { "result": "Approved" }, { "title": "string", "result": "Not approved" }, { "title": "string", "result": "Approved", "message": "string" }, [ { "title": "string", "result": "Approved", "message": "string" }, { "title": "string", "result": "Not approved", "message": "string" } ] ], "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false } }, { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false }, { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } ], "default": "Skip"}
Azure > Key Vault > Key > Approved > Regions
A list of Azure regions in which Azure Key Vault keys are approved for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy will be evaluated by the Approved control. If an Azure Key Vault key is created in a region that is not in the approved list, it will be subject to the action specified in the Azure > Key Vault > Key > Approved
policy.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/keyApprovedRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultApprovedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Key > Approved > Usage
Determine whether the Azure Key Vault key is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure Key Vault key is not approved, it will be subject to the action specified in the Azure > Key Vault > Key > Approved
policy.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/keyApprovedUsage
[ "Not approved", "Approved", "Approved if Azure > Key Vault > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if Azure > Key Vault > Enabled" ], "example": [ "Not approved" ], "default": "Approved if Azure > Key Vault > Enabled"}
Azure > Key Vault > Key > CMDB
Configure whether to record and synchronize details for the Azure Key Vault key into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".
If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.
To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".
CMDB controls also use the Regions policy associated with the resource. If region is not in Azure > Key Vault > Key > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/azure-keyvault#/policy/types/keyCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if KeyVault provider is Registered", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if KeyVault provider is Registered", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if KeyVault provider is Registered"}
Azure > Key Vault > Key > Expiration
Define the expiration setting required for Azure > Key Vault > Key
.
Enabling key expiration ensures compliance with security policies by validating that all keys are configured to expire, thereby preventing unauthorized, prolonged use of outdated or potentially compromised keys.
tmod:@turbot/azure-keyvault#/policy/types/keyExpiration
[ "Skip", "Check: Expiration", "Enforce: Expiration"]
{ "type": "string", "enum": [ "Skip", "Check: Expiration", "Enforce: Expiration" ], "example": [ "Check: Expiration" ], "default": "Skip"}
Azure > Key Vault > Key > Expiration > Days [Default]
Specify the expiration period for Azure > Key Vault > Key
by defining the number of days until the key expires. Upon setting, the control calculates the exact expiration date based on the provided duration from the current time.
tmod:@turbot/azure-keyvault#/policy/types/keyExpirationDaysDefault
{ "type": "integer", "default": 730}
Azure > Key Vault > Key > Regions
A list of Azure regions in which Azure Key Vault keys are supported for use.
Any keys in a region not listed here will not be recorded in CMDB.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
tmod:@turbot/azure-keyvault#/policy/types/keyRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Permissions
Configure whether permissions policies are in effect for Azure Key Vault
This setting does not affect Subscription level permissions (Azure/Admin, Azure/Owner, etc)
tmod:@turbot/azure-keyvault#/policy/types/keyVaultPermissions
[ "Enabled", "Disabled", "Enabled if Azure > Key Vault > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if Azure > Key Vault > Enabled" ], "example": [ "Enabled" ], "default": "Enabled if Azure > Key Vault > Enabled"}
Azure > Key Vault > Permissions > Levels
Define the permissions levels that can be used to grant access to Storage an
Azure Subscription. Permissions levels defined will appear in the UI to assign
access to Guardrails users.
tmod:@turbot/azure-keyvault#/policy/types/keyVaultPermissionsLevels
[ "{\n item: subscription {\n turbot{\n id\n }\n }\n}\n", "{\n availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyTypeId:'tmod:@turbot/azure-iam#/policy/types/permissionsLevelsDefault'\") {\n items {\n value\n }\n }\n}\n"]
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "enum": [ "User", "Metadata", "ReadOnly", "Operator", "Admin", "Owner" ] }}
Azure > Key Vault > Permissions > Levels > Modifiers
A map of Azure API to Guardrails Permission Level used to customize Guardrails'
standard permissions. You can add, remove or redefine the mapping of
Azure API operations to Guardrails permissions levels here.<br />example:<br /> - "Microsoft.Key Vault/Key Vault/delete": operator<br /> - "Microsoft.Key Vault/Key Vault/write": admin<br /> - "Microsoft.Key Vault/Key Vault/read": readonly<br />
tmod:@turbot/azure-keyvault#/policy/types/keyVaultPermissionsLevelsModifiers
Azure > Key Vault > Regions
A list of Azure regions in which Azure Key Vault resources are supported for use.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
This policy is the default value for all Azure Key Vault resources' Regions policies.
tmod:@turbot/azure-keyvault#/policy/types/keyVaultRegionsDefault
{ "allOf": [ { "$ref": "azure#/definitions/regionNameMatcherList" }, { "default": [ "australiacentral", "australiaeast", "australiasoutheast", "brazilsouth", "canadacentral", "canadaeast", "centralindia", "centralus", "eastasia", "eastus", "eastus2", "francecentral", "germanywestcentral", "japaneast", "japanwest", "koreacentral", "koreasouth", "northcentralus", "northeurope", "norwayeast", "southafricanorth", "southcentralus", "southeastasia", "southindia", "uaenorth", "uksouth", "ukwest", "usgovarizona", "usgoviowa", "usgovtexas", "usgovvirginia", "westcentralus", "westeurope", "westindia", "westus", "westus2" ] } ]}
Azure > Key Vault > Secret > Active
Determine the action to take when an Azure Key Vault secret, based on the Azure > Key Vault > Secret > Active > *
policies.
The control determines whether the resource is in active use, and if not,
has the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Secret > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note: In contrast with Approved, where if the
resource appears to be Unapproved for any reason it will be considered
Unapproved.
See Active for more information.
tmod:@turbot/azure-keyvault#/policy/types/secretActive
[ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning"]
{ "type": "string", "enum": [ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning" ], "example": [ "Check: Active" ], "default": "Skip"}
Azure > Key Vault > Secret > Active > Age
The age after which the Azure Key Vault secret
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Secret > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note In contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
tmod:@turbot/azure-keyvault#/policy/types/secretActiveAge
[ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days"]
{ "type": "string", "enum": [ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days" ], "example": [ "Force inactive if age > 90 days" ], "default": "Skip"}
Azure > Key Vault > Secret > Active > Last Modified
The number of days since the Azure Key Vault secret was last modified before it is considered
inactive.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Secret > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note In contrast with Approved, where if the
resource appears to be Unapproved for any reason it will be considered
Unapproved.
tmod:@turbot/azure-keyvault#/policy/types/secretActiveLastModified
[ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days"]
{ "type": "string", "enum": [ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days" ], "example": [ "Active if last modified <= 90 days" ], "default": "Skip"}
Azure > Key Vault > Secret > Approved
Determine the action to take when an Azure Key Vault secret is not approved based on Azure > Key Vault > Secret > Approved > *
policies.
The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.
For any enforcement actions that specify if new
, e.g., Enforce: Delete unapproved if new
, this control will only take the enforcement actions for resources created within the last 60 minutes.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/secretApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
Azure > Key Vault > Secret > Approved > Custom
Determine whether the Azure Key Vault secret is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure Key Vault secret is not approved, it will be subject to the action specified in the Azure > Key Vault > Secret > Approved
policy.
See Approved for more information.
Note: The policy value must be a string with a value of Approved
, Not approved
or Skip
, or in the form of YAML objects. The object(s) must contain the key result
with its value as Approved
or Not approved
. A custom title and message can also be added using the keys title
and message
respectively.
tmod:@turbot/azure-keyvault#/policy/types/secretApprovedCustom
{ "example": [ "Approved", "Not approved", "Skip", { "result": "Approved" }, { "title": "string", "result": "Not approved" }, { "title": "string", "result": "Approved", "message": "string" }, [ { "title": "string", "result": "Approved", "message": "string" }, { "title": "string", "result": "Not approved", "message": "string" } ] ], "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false } }, { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false }, { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } ], "default": "Skip"}
Azure > Key Vault > Secret > Approved > Regions
A list of Azure regions in which Azure Key Vault secrets are approved for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy will be evaluated by the Approved control. If an Azure Key Vault secret is created in a region that is not in the approved list, it will be subject to the action specified in the Azure > Key Vault > Secret > Approved
policy.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/secretApprovedRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultApprovedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Secret > Approved > Usage
Determine whether the Azure Key Vault secret is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure Key Vault secret is not approved, it will be subject to the action specified in the Azure > Key Vault > Secret > Approved
policy.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/secretApprovedUsage
[ "Not approved", "Approved", "Approved if Azure > Key Vault > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if Azure > Key Vault > Enabled" ], "example": [ "Not approved" ], "default": "Approved if Azure > Key Vault > Enabled"}
Azure > Key Vault > Secret > CMDB
Configure whether to record and synchronize details for the Azure Key Vault secret into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".
If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.
To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".
CMDB controls also use the Regions policy associated with the resource. If region is not in Azure > Key Vault > Secret > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/azure-keyvault#/policy/types/secretCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if KeyVault provider is Registered", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if KeyVault provider is Registered", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if KeyVault provider is Registered"}
Azure > Key Vault > Secret > Expiration
Define the expiration setting required for Azure > Key Vault > Secret
.
Enabling secret expiration ensures compliance with security policies by validating that all secrets are configured to expire, thereby preventing unauthorized, prolonged use of outdated or potentially compromised secrets.
tmod:@turbot/azure-keyvault#/policy/types/secretExpiration
[ "Skip", "Check: Expiration", "Enforce: Expiration"]
{ "type": "string", "enum": [ "Skip", "Check: Expiration", "Enforce: Expiration" ], "example": [ "Check: Expiration" ], "default": "Skip"}
Azure > Key Vault > Secret > Expiration > Days [Default]
Specify the expiration period for Azure > Key Vault > Secret
by defining the number of days until the secret expires. Upon setting, the control calculates the exact expiration date based on the provided duration from the current time.
tmod:@turbot/azure-keyvault#/policy/types/secretExpirationDaysDefault
{ "type": "integer", "default": 730}
Azure > Key Vault > Secret > Regions
A list of Azure regions in which Azure Key Vault secrets are supported for use.
Any secrets in a region not listed here will not be recorded in CMDB.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
tmod:@turbot/azure-keyvault#/policy/types/secretRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Tags Template [Default]
A template used to generate the keys and values for Azure Key Vault resources.
By default, all Key Vault resource Tags > Template policies will use this value.
tmod:@turbot/azure-keyvault#/policy/types/keyVaultTagsTemplate
"{\n defaultTags: policyValue(uri:\"tmod:@turbot/azure#/policy/types/defaultTagsTemplate\") {\n value\n }\n}\n"
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Azure > Key Vault > Vault > Active
Determine the action to take when an Azure Key Vault vault, based on the Azure > Key Vault > Vault > Active > *
policies.
The control determines whether the resource is in active use, and if not,
has the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Vault > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note: In contrast with Approved, where if the
resource appears to be Unapproved for any reason it will be considered
Unapproved.
See Active for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultActive
[ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning"]
{ "type": "string", "enum": [ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning" ], "example": [ "Check: Active" ], "default": "Skip"}
Azure > Key Vault > Vault > Active > Age
The age after which the Azure Key Vault vault
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Vault > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note In contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultActiveAge
[ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days"]
{ "type": "string", "enum": [ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days" ], "example": [ "Force inactive if age > 90 days" ], "default": "Skip"}
Azure > Key Vault > Vault > Active > Last Modified
The number of days since the Azure Key Vault vault was last modified before it is considered
inactive.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (Azure > Key Vault > Vault > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note In contrast with Approved, where if the
resource appears to be Unapproved for any reason it will be considered
Unapproved.
tmod:@turbot/azure-keyvault#/policy/types/vaultActiveLastModified
[ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days"]
{ "type": "string", "enum": [ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days" ], "example": [ "Active if last modified <= 90 days" ], "default": "Skip"}
Azure > Key Vault > Vault > Approved
Determine the action to take when an Azure Key Vault vault is not approved based on Azure > Key Vault > Vault > Approved > *
policies.
The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.
For any enforcement actions that specify if new
, e.g., Enforce: Delete unapproved if new
, this control will only take the enforcement actions for resources created within the last 60 minutes.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
Azure > Key Vault > Vault > Approved > Custom
Determine whether the Azure Key Vault vault is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure Key Vault vault is not approved, it will be subject to the action specified in the Azure > Key Vault > Vault > Approved
policy.
See Approved for more information.
Note: The policy value must be a string with a value of Approved
, Not approved
or Skip
, or in the form of YAML objects. The object(s) must contain the key result
with its value as Approved
or Not approved
. A custom title and message can also be added using the keys title
and message
respectively.
tmod:@turbot/azure-keyvault#/policy/types/vaultApprovedCustom
{ "example": [ "Approved", "Not approved", "Skip", { "result": "Approved" }, { "title": "string", "result": "Not approved" }, { "title": "string", "result": "Approved", "message": "string" }, [ { "title": "string", "result": "Approved", "message": "string" }, { "title": "string", "result": "Not approved", "message": "string" } ] ], "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false } }, { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false }, { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } ], "default": "Skip"}
Azure > Key Vault > Vault > Approved > Regions
A list of Azure regions in which Azure Key Vault vaults are approved for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy will be evaluated by the Approved control. If an Azure Key Vault vault is created in a region that is not in the approved list, it will be subject to the action specified in the Azure > Key Vault > Vault > Approved
policy.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultApprovedRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultApprovedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Vault > Approved > Usage
Determine whether the Azure Key Vault vault is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure Key Vault vault is not approved, it will be subject to the action specified in the Azure > Key Vault > Vault > Approved
policy.
See Approved for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultApprovedUsage
[ "Not approved", "Approved", "Approved if Azure > Key Vault > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if Azure > Key Vault > Enabled" ], "example": [ "Not approved" ], "default": "Approved if Azure > Key Vault > Enabled"}
Azure > Key Vault > Vault > CMDB
Configure whether to record and synchronize details for the Azure Key Vault vault into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".
If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.
To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".
CMDB controls also use the Regions policy associated with the resource. If region is not in Azure > Key Vault > Vault > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/azure-keyvault#/policy/types/vaultCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if KeyVault provider is Registered", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if KeyVault provider is Registered", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if KeyVault provider is Registered"}
Azure > Key Vault > Vault > Purge Protection
Configure Purge Protection for the Azure > Key Vault > Vault
. Enabling Purge Protection will enforce a mandatory retention period and prevent the permanent deletion of key vaults or secrets prior to the end of the retention period.
tmod:@turbot/azure-keyvault#/policy/types/vaultPurgeProtection
[ "Skip", "Check: Purge Protection Enabled", "Enforce: Enable Purge Protection"]
{ "type": "string", "enum": [ "Skip", "Check: Purge Protection Enabled", "Enforce: Enable Purge Protection" ], "default": "Skip"}
Azure > Key Vault > Vault > Regions
A list of Azure regions in which Azure Key Vault vaults are supported for use.
Any vaults in a region not listed here will not be recorded in CMDB.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
tmod:@turbot/azure-keyvault#/policy/types/vaultRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > Key Vault > Vault > Tags
Determine the action to take when an Azure Key Vault vault tags are not updated based on the Azure > Key Vault > Vault > Tags > *
policies.
The control ensure Azure Key Vault vault tags include tags defined in Azure > Key Vault > Vault > Tags > Template
.
Tags not defined in Vault Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultTags
[ "Skip", "Check: Tags are correct", "Enforce: Set tags"]
{ "type": "string", "enum": [ "Skip", "Check: Tags are correct", "Enforce: Set tags" ], "example": [ "Check: Tags are correct" ], "default": "Skip"}
Azure > Key Vault > Vault > Tags > Template
The template is used to generate the keys and values for Azure Key Vault vault.
Tags not defined in Vault Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
tmod:@turbot/azure-keyvault#/policy/types/vaultTagsTemplate
[ "{\n subscription {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/azure-keyvault#/policy/types/keyVaultTagsTemplate\" resourceId: \"{{ $.subscription.turbot.id }}\") {\n value\n }\n}\n"]
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Azure > Turbot > Permissions > Compiled > Levels > @turbot/azure-keyvault
A calculated policy that Guardrails uses to create a compiled list of ALL
permission levels for Azure Key Vault that is used as input to the
stack that manages the Guardrails IAM permissions objects.
tmod:@turbot/azure-keyvault#/policy/types/azureLevelsCompiled
Azure > Turbot > Permissions > Compiled > Service Permissions > @turbot/azure-keyvault
A calculated policy that Guardrails uses to create a compiled list of ALL
permissions for Azure Key Vault that is used as input to the control that manages
the IAM stack.
tmod:@turbot/azure-keyvault#/policy/types/azureCompiledServicePermissions