Control types for @turbot/azure-keyvault

• Azure > Key Vault > Key > Active
• Azure > Key Vault > Key > Approved
• Azure > Key Vault > Key > CMDB
• Azure > Key Vault > Key > Discovery
• Azure > Key Vault > Key > Expiration
• Azure > Key Vault > Secret > Active
• Azure > Key Vault > Secret > Approved
• Azure > Key Vault > Secret > CMDB
• Azure > Key Vault > Secret > Discovery
• Azure > Key Vault > Secret > Expiration
• Azure > Key Vault > Vault > Active
• Azure > Key Vault > Vault > Approved
• Azure > Key Vault > Vault > CMDB
• Azure > Key Vault > Vault > Discovery
• Azure > Key Vault > Vault > Purge Protection
• Azure > Key Vault > Vault > Tags

Azure > Key Vault > Key > Active

Take an action when an Azure Key Vault key is not active based on the
Azure > Key Vault > Key > Active > * policies.

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.

Azure > Key Vault > Key > Approved

Take an action 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.

Azure > Key Vault > Key > CMDB

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.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

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.

This control will automatically re-run every 6 hours because Azure does not currently support real-time events for this resource type.

Azure > Key Vault > Key > Discovery

Discover all Azure Key Vault key resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note: Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in Azure > Key Vault > Key > Regions policy, the CMDB control will delete the resource from the CMDB.

This control will automatically re-run every 6 hours because Azure does not currently support real-time events for this resource type.

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.

Azure > Key Vault > Secret > Active

Take an action when an Azure Key Vault secret is not active based on the
Azure > Key Vault > Secret > Active > * policies.

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.

Azure > Key Vault > Secret > Approved

Take an action 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.

Azure > Key Vault > Secret > CMDB

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.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

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.

This control will automatically re-run every 6 hours because Azure does not currently support real-time events for this resource type.

Azure > Key Vault > Secret > Discovery

Discover all Azure Key Vault secret resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note: Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in Azure > Key Vault > Secret > Regions policy, the CMDB control will delete the resource from the CMDB.

This control will automatically re-run every 6 hours because Azure does not currently support real-time events for this resource type.

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.

Azure > Key Vault > Vault > Active

Take an action when an Azure Key Vault vault is not active based on the
Azure > Key Vault > Vault > Active > * policies.

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.

Azure > Key Vault > Vault > Approved

Take an action 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.

Azure > Key Vault > Vault > CMDB

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.

Note: If CMDB is set to Skip for a resource, then it will not be added
to the CMDB, and no controls that target it will run.

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.

Azure > Key Vault > Vault > Discovery

Discover all Azure Key Vault vault resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note: Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in Azure > Key Vault > Vault > Regions policy, the CMDB control will delete the resource from the CMDB.

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.

Azure > Key Vault > Vault > Tags

Take an action when an Azure Key Vault vault tags is not updated based on the Azure > Key Vault > Vault > Tags > * policies.

If the resource is not updated with the tags defined in Azure > Key Vault > Vault > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.