Policy types for @turbot/azure-apimanagement
- Azure > API Management > API Management Service > Active
- Azure > API Management > API Management Service > Active > Age
- Azure > API Management > API Management Service > Active > Last Modified
- Azure > API Management > API Management Service > Approved
- Azure > API Management > API Management Service > Approved > Regions
- Azure > API Management > API Management Service > Approved > Usage
- Azure > API Management > API Management Service > CMDB
- Azure > API Management > API Management Service > Regions
- Azure > API Management > API Management Service > Tags
- Azure > API Management > API Management Service > Tags > Template
- Azure > API Management > Approved Regions [Default]
- Azure > API Management > Enabled
- Azure > API Management > Permissions
- Azure > API Management > Permissions > Levels
- Azure > API Management > Permissions > Levels > Modifiers
- Azure > API Management > Regions
- Azure > API Management > Tags Template [Default]
- Azure > Turbot > Permissions > Compiled > Levels > @turbot/azure-apimanagement
- Azure > Turbot > Permissions > Compiled > Service Permissions > @turbot/azure-apimanagement
Azure > API Management > API Management Service > Active
Determine the action to take when an Azure API Management api management service, based on the Azure > API Management > API Management Service > 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 > API Management > API Management Service > 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.
[ "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 > API Management > API Management Service > Active > Age
The age after which the Azure API Management api management service 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 > API Management > API Management Service > 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.
[ "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 > API Management > API Management Service > Active > Last Modified
The number of days since the Azure API Management api management service 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 > API Management > API Management Service > 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.
[ "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 > API Management > API Management Service > Approved
Determine the action to take when an Azure API Management api management service is not approved based on Azure > API Management > API Management Service > 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.
[ "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 > API Management > API Management Service > Approved > Regions
A list of Azure regions in which Azure API Management api management services 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 API Management api management service is created in a region that is not in the approved list, it will be subject to the action specified in the Azure > API Management > API Management Service > Approved
policy.
See Approved for more information.
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-apimanagement#/policy/types/apiManagementApprovedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > API Management > API Management Service > Approved > Usage
Determine whether the Azure API Management api management service is allowed to exist.
This policy will be evaluated by the Approved control. If an Azure API Management api management service is not approved, it will be subject to the action specified in the Azure > API Management > API Management Service > Approved
policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if Azure > API Management > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if Azure > API Management > Enabled" ], "example": [ "Not approved" ], "default": "Approved if Azure > API Management > Enabled"}
Azure > API Management > API Management Service > CMDB
Configure whether to record and synchronize details for the Azure API Management api management service 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 > API Management > API Management Service > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
[ "Skip", "Enforce: Enabled", "Enforce: Enabled if API Management provider is Registered", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Enabled if API Management provider is Registered", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled if API Management provider is Registered"}
Azure > API Management > API Management Service > Regions
A list of Azure regions in which Azure API Management api management services are supported for use.
Any api management services 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.
"{\n regions: policyValue(uri:\"tmod:@turbot/azure-apimanagement#/policy/types/apiManagementRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > API Management > API Management Service > Tags
Determine the action to take when an Azure API Management api management service tags are not updated based on the Azure > API Management > API Management Service > Tags > *
policies.
The control ensure Azure API Management api management service tags include tags defined in Azure > API Management > API Management Service > Tags > Template
.
Tags not defined in API Management Service 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.
[ "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 > API Management > API Management Service > Tags > Template
The template is used to generate the keys and values for Azure API Management api management service.
Tags not defined in API Management Service 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.
[ "{\n subscription {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/azure-apimanagement#/policy/types/apiManagementTagsTemplate\" 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 > API Management > Approved Regions [Default]
A list of Azure regions in which Azure API Management 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 API Management resources' Approved > Regions policies.
"{\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 > API Management > Enabled
Enable Azure API Management service.
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
Azure > API Management > Permissions
Configure whether permissions policies are in effect for Azure API Management This setting does not affect Subscription level permissions (Azure/Admin, Azure/Owner, etc)
[ "Enabled", "Disabled", "Enabled if Azure > API Management > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if Azure > API Management > Enabled" ], "example": [ "Enabled" ], "default": "Enabled if Azure > API Management > Enabled"}
Azure > API Management > 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.
[ "{\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 > API Management > 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.API Management/API Management/delete": operator - "Microsoft.API Management/API Management/write": admin - "Microsoft.API Management/API Management/read": readonly
Azure > API Management > Regions
A list of Azure regions in which Azure API Management 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 API Management resources' Regions policies.
"{\n regions: policyValue(uri:\"tmod:@turbot/azure#/policy/types/regionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Azure > API Management > Tags Template [Default]
A template used to generate the keys and values for Azure API Management resources.
By default, all API Management resource Tags > Template policies will use this value.
"{\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 > Turbot > Permissions > Compiled > Levels > @turbot/azure-apimanagement
A calculated policy that Turbot uses to create a compiled list of ALL permission levels for Azure API Management that is used as input to the stack that manages the Turbot IAM permissions objects.
Azure > Turbot > Permissions > Compiled > Service Permissions > @turbot/azure-apimanagement
A calculated policy that Turbot uses to create a compiled list of ALL permissions for Azure API Management that is used as input to the control that manages the IAM stack.