Policy types for @turbot/azure-sqlvirtualmachine

Azure > SQL Virtual Machine Service > Approved Regions [Default]

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

URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineServiceApprovedRegionsDefault
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 > SQL Virtual Machine Service > Enabled

Enable Azure SQL Virtual Machine Service service.

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

Azure > SQL Virtual Machine Service > Permissions

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

URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineServicePermissions
Valid Value
[
"Enabled",
"Disabled",
"Enabled if Azure > SQL Virtual Machine Service > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Enabled if Azure > SQL Virtual Machine Service > Enabled"
],
"example": [
"Enabled"
],
"default": "Enabled if Azure > SQL Virtual Machine Service > Enabled"
}

Azure > SQL Virtual Machine Service > 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineServicePermissionsLevels
Default Template Input
[
"{\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"
]
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 > SQL Virtual Machine Service > 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:
- "Microsoft.SQL Virtual Machine Service/SQL Virtual Machine Service/delete": operator
- "Microsoft.SQL Virtual Machine Service/SQL Virtual Machine Service/write": admin
- "Microsoft.SQL Virtual Machine Service/SQL Virtual Machine Service/read": readonly
URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineServicePermissionsLevelsModifiers

Azure > SQL Virtual Machine Service > Regions

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

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

Azure > SQL Virtual Machine Service > SQL Virtual Machine > Active

Determine the action to take when an Azure SQL Virtual Machine Service sql virtual machine, based on the Azure > SQL Virtual Machine Service > SQL Virtual Machine > 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 > SQL Virtual Machine Service > SQL Virtual Machine > 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineActive
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 > SQL Virtual Machine Service > SQL Virtual Machine > Active > Age

The age after which the Azure SQL Virtual Machine Service sql virtual machine 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 > SQL Virtual Machine Service > SQL Virtual Machine > 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineActiveAge
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 > SQL Virtual Machine Service > SQL Virtual Machine > Active > Last Modified

The number of days since the Azure SQL Virtual Machine Service sql virtual machine 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 > SQL Virtual Machine Service > SQL Virtual Machine > 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineActiveLastModified
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 > SQL Virtual Machine Service > SQL Virtual Machine > Approved

Determine the action to take when an Azure SQL Virtual Machine Service sql virtual machine is not approved based on Azure > SQL Virtual Machine Service > SQL Virtual Machine > 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineApproved
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 > SQL Virtual Machine Service > SQL Virtual Machine > Approved > Custom

Determine whether the Azure SQL Virtual Machine Service sql virtual machine is allowed to exist. This policy will be evaluated by the Approved control. If an Azure SQL Virtual Machine Service sql virtual machine is not approved, it will be subject to the action specified in the Azure > SQL Virtual Machine Service > SQL Virtual Machine > 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.

URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineApprovedCustom
Schema
{
"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 > SQL Virtual Machine Service > SQL Virtual Machine > Approved > Regions

A list of Azure regions in which Azure SQL Virtual Machine Service sql virtual machines 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 SQL Virtual Machine Service sql virtual machine is created in a region that is not in the approved list, it will be subject to the action specified in the Azure > SQL Virtual Machine Service > SQL Virtual Machine > Approved policy.

See Approved for more information.

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

Azure > SQL Virtual Machine Service > SQL Virtual Machine > Approved > Usage

Determine whether the Azure SQL Virtual Machine Service sql virtual machine is allowed to exist.

This policy will be evaluated by the Approved control. If an Azure SQL Virtual Machine Service sql virtual machine is not approved, it will be subject to the action specified in the Azure > SQL Virtual Machine Service > SQL Virtual Machine > Approved policy.

See Approved for more information.

URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineApprovedUsage
Valid Value
[
"Not approved",
"Approved",
"Approved if Azure > SQL Virtual Machine Service > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Not approved",
"Approved",
"Approved if Azure > SQL Virtual Machine Service > Enabled"
],
"example": [
"Not approved"
],
"default": "Approved if Azure > SQL Virtual Machine Service > Enabled"
}

Azure > SQL Virtual Machine Service > SQL Virtual Machine > CMDB

Configure whether to record and synchronize details for the Azure SQL Virtual Machine Service sql virtual machine 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 > SQL Virtual Machine Service > SQL Virtual Machine > 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineCmdb
Category
Valid Value
[
"Skip",
"Enforce: Enabled",
"Enforce: Enabled if Sql Virtual Machine provider is Registered",
"Enforce: Disabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Enforce: Enabled",
"Enforce: Enabled if Sql Virtual Machine provider is Registered",
"Enforce: Disabled"
],
"example": [
"Skip"
],
"default": "Enforce: Enabled if Sql Virtual Machine provider is Registered"
}

Azure > SQL Virtual Machine Service > SQL Virtual Machine > Regions

A list of Azure regions in which Azure SQL Virtual Machine Service sql virtual machines are supported for use.

Any sql virtual machines 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineRegions
Default Template Input
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineServiceRegionsDefault\") {\n value\n }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;\n{% endfor %}"

Azure > SQL Virtual Machine Service > SQL Virtual Machine > Tags

Determine the action to take when an Azure SQL Virtual Machine Service sql virtual machine tags are not updated based on the Azure > SQL Virtual Machine Service > SQL Virtual Machine > Tags > * policies.

The control ensure Azure SQL Virtual Machine Service sql virtual machine tags include tags defined in Azure > SQL Virtual Machine Service > SQL Virtual Machine > Tags > Template.

Tags not defined in SQL Virtual Machine 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineTags
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 > SQL Virtual Machine Service > SQL Virtual Machine > Tags > Template

The template is used to generate the keys and values for Azure SQL Virtual Machine Service sql virtual machine.

Tags not defined in SQL Virtual Machine 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-sqlvirtualmachine#/policy/types/sqlVirtualMachineTagsTemplate
Default Template Input
[
"{\n subscription {\n turbot {\n id\n }\n }\n}\n",
"{\n defaultTags: policyValue(uri:\"tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineServiceTagsTemplate\" 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 > SQL Virtual Machine Service > Tags Template [Default]

A template used to generate the keys and values for Azure SQL Virtual Machine Service resources.

By default, all SQL Virtual Machine Service resource Tags > Template policies will use this value.

URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/sqlVirtualMachineServiceTagsTemplate
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-sqlvirtualmachine

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

URI
tmod:@turbot/azure-sqlvirtualmachine#/policy/types/azureLevelsCompiled

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

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

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