Policy types for @turbot/azure-aks

Azure > AKS > Approved Regions [Default]

A list of Azure regions in which Azure AKS 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 AKS resources' Approved > Regions policies.

URI
tmod:@turbot/azure-aks#/policy/types/aksApprovedRegionsDefault
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/azure#/policy/types/approvedRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"

Azure > AKS > Enabled

Enable Azure AKS service.

URI
tmod:@turbot/azure-aks#/policy/types/aksEnabled
Valid Value
[
"Enabled",
"Enabled: Metadata Only",
"Disabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Enabled: Metadata Only",
"Disabled"
],
"example": [
"Enabled"
],
"default": "Disabled"
}

Azure > AKS > Managed Cluster > Active

Determine the action to take when an Azure AKS managed cluster, based on the Azure > AKS > Managed Cluster > 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 > AKS > Managed Cluster > 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterActive
Valid Value
[
"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"
]
Schema
{
"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 > AKS > Managed Cluster > Active > Age

The age after which the Azure AKS managed cluster is no longer considered active. If a create time is unavailable, the time Turbot 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 > AKS > Managed Cluster > 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterActiveAge
Valid Value
[
"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"
]
Schema
{
"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 > AKS > Managed Cluster > Active > Last Modified

The number of days since the Azure AKS managed cluster 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 > AKS > Managed Cluster > 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterActiveLastModified
Valid Value
[
"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"
]
Schema
{
"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 > AKS > Managed Cluster > Approved

Determine the action to take when an Azure AKS managed cluster is not approved based on Azure > AKS > Managed Cluster > 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterApproved
Valid Value
[
"Skip",
"Check: Approved",
"Enforce: Delete unapproved if new"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Approved",
"Enforce: Delete unapproved if new"
],
"example": [
"Check: Approved"
],
"default": "Skip"
}

Azure > AKS > Managed Cluster > Approved > Regions

A list of Azure regions in which Azure AKS managed clusters 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 AKS managed cluster is created in a region that is not in the approved list, it will be subject to the action specified in the Azure > AKS > Managed Cluster > Approved policy.

See Approved for more information.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterApprovedRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-aks#/policy/types/aksApprovedRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;\n{% endfor %}"

Azure > AKS > Managed Cluster > Approved > Usage

Determine whether the Azure AKS managed cluster is allowed to exist.

This policy will be evaluated by the Approved control. If an Azure AKS managed cluster is not approved, it will be subject to the action specified in the Azure > AKS > Managed Cluster > Approved policy.

See Approved for more information.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterApprovedUsage
Valid Value
[
"Not approved",
"Approved",
"Approved if Azure > AKS > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Not approved",
"Approved",
"Approved if Azure > AKS > Enabled"
],
"example": [
"Not approved"
],
"default": "Approved if Azure > AKS > Enabled"
}

Azure > AKS > Managed Cluster > CMDB

Configure whether to record and synchronize details for the Azure AKS managed cluster into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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 > AKS > Managed Cluster > Regions policy, the CMDB control will delete the resource from the CMDB.

(Note: Setting CMDB to "Skip" will also pause these changes.)

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterCmdb
Category
Valid Value
[
"Skip",
"Enforce: Enabled",
"Enforce: Enabled if Container Service provider is Registered",
"Enforce: Disabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Enforce: Enabled",
"Enforce: Enabled if Container Service provider is Registered",
"Enforce: Disabled"
],
"example": [
"Skip"
],
"default": "Enforce: Enabled if Container Service provider is Registered"
}

Azure > AKS > Managed Cluster > Regions

A list of Azure regions in which Azure AKS managed clusters are supported for use.

Any managed clusters 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-aks#/policy/types/aksRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;\n{% endfor %}"

Azure > AKS > Managed Cluster > Tags

Determine the action to take when an Azure AKS managed cluster tags are not updated based on the Azure > AKS > Managed Cluster > Tags > * policies.

The control ensure Azure AKS managed cluster tags include tags defined in Azure > AKS > Managed Cluster > Tags > Template.

Tags not defined in Managed Cluster 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterTags
Valid Value
[
"Skip",
"Check: Tags are correct",
"Enforce: Set tags"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Tags are correct",
"Enforce: Set tags"
],
"example": [
"Check: Tags are correct"
],
"default": "Skip"
}

Azure > AKS > Managed Cluster > Tags > Template

The template is used to generate the keys and values for Azure AKS managed cluster.

Tags not defined in Managed Cluster 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.

URI
tmod:@turbot/azure-aks#/policy/types/managedClusterTagsTemplate
Default Template Input
[
"{\n subscription {\n turbot {\n id\n }\n }\n}\n",
"{\n defaultTags: policyValue(uri:\"tmod:@turbot/azure-aks#/policy/types/aksTagsTemplate\" resourceId: \"{{ $.subscription.turbot.id }}\") {\n value\n }\n}\n"
]
Default Template
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"

Azure > AKS > Permissions

Configure whether permissions policies are in effect for Azure AKS This setting does not affect Subscription level permissions (Azure/Admin, Azure/Owner, etc)

URI
tmod:@turbot/azure-aks#/policy/types/aksPermissions
Valid Value
[
"Enabled",
"Disabled",
"Enabled if Azure > AKS > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Enabled if Azure > AKS > Enabled"
],
"example": [
"Enabled"
],
"default": "Enabled if Azure > AKS > Enabled"
}

Azure > AKS > 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 Turbot users.

URI
tmod:@turbot/azure-aks#/policy/types/aksPermissionsLevels
Default Template Input
[
"{\n item: subscription {\n turbot{\n id\n }\n }\n}\n",
"{\n availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyType:'tmod:@turbot/azure-iam#/policy/types/permissionsLevelsDefault'\") {\n items {\n value\n }\n }\n}\n"
]
Default Template
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}\n{% endfor %}"
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"User",
"Metadata",
"ReadOnly",
"Operator",
"Admin",
"Owner"
]
}
}

Azure > AKS > Permissions > Levels > Modifiers

A map of Azure API to Turbot Permission Level used to customize Turbot's standard permissions. You can add, remove or redefine the mapping of Azure API operations to Turbot permissions levels here.

example:
- &quot;Microsoft.AKS/AKS/delete&quot;: operator
- &quot;Microsoft.AKS/AKS/write&quot;: admin
- &quot;Microsoft.AKS/AKS/read&quot;: readonly
URI
tmod:@turbot/azure-aks#/policy/types/aksPermissionsLevelsModifiers

Azure > AKS > Regions

A list of Azure regions in which Azure AKS 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 AKS resources' Regions policies.

URI
tmod:@turbot/azure-aks#/policy/types/aksRegionsDefault
Schema
{
"allOf": [
{
"$ref": "azure#/definitions/regionNameMatcherList"
},
{
"default": [
"australiaeast",
"australiasoutheast",
"brazilsouth",
"canadacentral",
"canadaeast",
"centralindia",
"centralus",
"eastasia",
"eastus",
"eastus2",
"francecentral",
"japaneast",
"japanwest",
"koreacentral",
"koreasouth",
"northcentralus",
"northeurope",
"southafricanorth",
"southcentralus",
"southeastasia",
"southindia",
"uksouth",
"ukwest",
"usgovvirginia",
"westcentralus",
"westeurope",
"westindia",
"westus",
"westus2"
]
}
]
}

Azure > AKS > Tags Template [Default]

A template used to generate the keys and values for Azure AKS resources.

By default, all AKS resource Tags > Template policies will use this value.

URI
tmod:@turbot/azure-aks#/policy/types/aksTagsTemplate
Default Template Input
"{\n defaultTags: policyValue(uri:\"tmod:@turbot/azure#/policy/types/defaultTagsTemplate\") {\n value\n }\n}\n"
Default Template
"{%- 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-aks

A calculated policy that Turbot uses to create a compiled list of ALL permission levels for Azure AKS that is used as input to the stack that manages the Turbot IAM permissions objects.

Azure > Turbot > Permissions > Compiled > Service Permissions > @turbot/azure-aks

A calculated policy that Turbot uses to create a compiled list of ALL permissions for Azure AKS that is used as input to the control that manages the IAM stack.

URI
tmod:@turbot/azure-aks#/policy/types/azureCompiledServicePermissions