Delete the Azure API Management API Management Service.


Azure > API Management > API Management Service

Azure > API Management > API Management Service > Delete

Process events for Azure API Management service API Management Service resources.

The router receives events from the event handler and creates, updates, or deletes API Management Service resources in the CMDB.


Azure > Resource Group

Azure > API Management > API Management Service > Router

Update the tags for Azure API Management api management service.


Azure > API Management > API Management Service > Set Tags

Enables or Disables the Public Network Access setting for Azure API Management Service


Azure > API Management > API Management Service > Set Public Network Access

Take an action when an Azure API Management api management service is not active based on the&#92;n`Azure &gt; API Management &gt; API Management Service &gt; Active &gt; * policies`.&#92;n&#92;nThe Active control determines whether the resource is in active use, and if not, has&#92;nthe ability to delete / cleanup the resource. When running an automated compliance&#92;nenvironment, it&#39;s common to end up with a wide range of alarms that are difficult&#92;nand time consuming to clear. The Active control brings automated, well-defined&#92;ncontrol to this process.&#92;n&#92;nThe Active control checks the status of all defined Active policies for the&#92;nresource (`Azure &gt; API Management &gt; API Management Service &gt; Active &gt; *`),&#92;nraises an alarm, and takes the defined enforcement action. Each Active&#92;nsub-policy can calculate a status of active, inactive or skipped. Generally,&#92;nif the resource appears to be Active for any reason it will be considered Active.&#92;n&#92;n**Note:** In contrast with Approved, where if the resource appears to be Unapproved&#92;nfor any reason it will be considered Unapproved.&#92;n&#92;nSee [Active](https://turbot.com/guardrails/docs/concepts/guardrails/active) for more information.&#92;n

Azure > API Management > API Management Service > Active > Age

Azure > API Management > API Management Service > Active > Last Modified

Azure > API Management > API Management Service > Active

This control serves as a hierarchical parent for more specific Allowed controls, such as region-based controls and custom rule-based controls.&#92;n

Azure > API Management > API Management Service > Allowed

Take an action when an Azure API Management api management service is not allowed based on custom rules.&#92;n&#92;nThe `Allowed &gt; Custom` control checks if the api management service is allowed based on the `Allowed &gt; Custom &gt; *` policies. If the api management service is not allowed, this control raises an alarm and takes the defined enforcement action.&#92;n&#92;nFor any enforcement actions that specify `if new`, e.g., `Enforce: Delete if not allowed and resource is new`, this control will only take the enforcement actions for resources created within the last 60 minutes.&#92;n

Azure > API Management > API Management Service > Allowed > Custom > Rules

Azure > API Management > API Management Service > Allowed > Custom

Take an action when an Azure API Management api management service is created in a region that is not allowed.&#92;n&#92;nThe `Allowed &gt; Region` control checks if the api management service is created in an allowed region based on the `Allowed &gt; Region &gt; *` policies. If the api management service is created in a region that is not in the allowed list, this control raises an alarm and takes the defined enforcement action.&#92;n&#92;nFor any enforcement actions that specify `if new`, e.g., `Enforce: Delete if region not allowed and api management service is new`, this control will only take the enforcement actions for resources created within the last 60 minutes.&#92;n

Azure > API Management > API Management Service > Allowed > Region > Regions

Azure > API Management > API Management Service > Allowed > Region

Take an action when an Azure API Management api management service is not approved based on `Azure &gt; API Management &gt; API Management Service &gt; Approved &gt; * policies`.&#92;n&#92;nThe 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.&#92;n&#92;nFor 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.&#92;n&#92;nSee [Approved](https://turbot.com/guardrails/docs/concepts/guardrails/approved) for more information.&#92;n

Azure > API Management > API Management Service > Approved > Custom

Azure > API Management > API Management Service > Approved > Usage

Azure > API Management > Enabled

Azure > API Management > API Management Service > Approved > Regions

Azure > API Management > API Management Service > Approved

Record and synchronize details for the Azure API Management api management service into the CMDB.&#92;n&#92;nThe [CMDB](https://turbot.com/guardrails/docs/concepts/guardrails/cmdb) control is&#92;nresponsible for populating and updating all the attributes for that&#92;nresource type in the Guardrails CMDB.&#92;n&#92;n**Note:** If CMDB is set to Skip for a resource, then it will not be added&#92;nto the CMDB, and no controls that target it will run.&#92;n&#92;nCMDB controls also use the Regions policy associated with the resource. If&#92;nregion is not in `Azure &gt; API Management &gt; API Management Service &gt; Regions` policy, the CMDB control will delete the&#92;nresource from the CMDB.&#92;n

Azure > API Management > API Management Service > Regions

Azure > API Management > API Management Service > CMDB

Discover all Azure API Management api management service resources and add them to the CMDB.&#92;n&#92;nThe [Discovery](https://turbot.com/guardrails/docs/concepts/guardrails/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](https://turbot.com/guardrails/docs/concepts/guardrails/cmdb) control.&#92;n&#92;n**Note:** Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in `Azure &gt; API Management &gt; API Management Service &gt; Regions` policy, the CMDB control will delete the resource from the CMDB.&#92;n

Azure > API Management > API Management Service > Discovery

Configure public network access settings for `Azure &gt; API Management &gt; API Management Service`.&#92;n&#92;nThe Public Network Access control evaluates the current public network access configuration against the policy requirements, raises an alarm when settings don&#39;t match, and takes enforcement action when configured to do so. When public network access needs to be disabled, the control verifies that appropriate private endpoint connections exist before enforcement.&#92;n

Azure > API Management > API Management Service > Public Network Access

Take an action when an Azure API Management api management service tags is not updated based on the `Azure &gt; API Management &gt; API Management Service &gt; Tags &gt; *` policies.&#92;n&#92;nIf the resource is not updated with the tags defined in `Azure &gt; API Management &gt; API Management Service &gt; Tags &gt; Template`, this control raises an alarm and takes the defined enforcement action.&#92;n&#92;nSee [Tags](https://turbot.com/guardrails/docs/concepts/guardrails/tagging) for more information.&#92;n

Azure > API Management > API Management Service > Tags > Template

Azure > API Management > API Management Service > Tags

apiManagement

apiManagementAka

test01

apiManagementService

apiManagementServiceAka

apiManagementServiceServiceNow

provisioningState

invalid - Hyphen can not be at last position

serviceName

azure-apimanagement

A list of Azure regions in which Azure API Management resources are allowed for use.&#92;n&#92;nThe expected format is an array of regions names. You may use the &#39;*&#39; and&#92;n&#39;?&#39; wildcard characters.&#92;n&#92;nThis policy is the default value for all Azure API Management resources&#39; Allowed &gt; Regions policies.&#92;n

Azure > API Management

Azure > Subscription

Azure > API Management > Allowed Regions [Default]

A list of Azure regions in which Azure API Management resources are approved for use.&#92;n&#92;nThe expected format is an array of regions names. You may use the &#39;*&#39; and&#92;n&#39;?&#39; wildcard characters.&#92;n&#92;nThis policy is the default value for all Azure API Management resources&#39; Approved &gt; Regions policies.&#92;n

Azure > API Management > Approved Regions [Default]

The Event Grid event pattern used by the Azure API Management module to specify&#92;nwhich events to forward to the Guardrails Event Handlers [Event Grid].&#92;n&#92;nThis policy automatically generates operation filters based on which&#92;nresource types have CMDB enabled. Only enabled resource types will&#92;nhave their events forwarded to Guardrails.&#92;n

Azure > Turbot > Event Handlers [Event Grid] > Custom Event Patterns

Azure > Turbot > Event Handlers [Event Grid] > Custom Event Patterns > @turbot/azure-apimanagement

Azure > API Management > Permissions > Levels

Configure whether permissions policies are in effect for Azure API Management&#92;nThis setting does not affect Subscription level permissions (Azure/Admin, Azure/Owner, etc)&#92;n

Azure > API Management > Permissions

Azure > API Management > Permissions > Levels > Modifiers

Define the permissions levels that can be used to grant access to Storage an&#92;nAzure Subscription.  Permissions levels defined will appear in the UI to assign&#92;naccess to Guardrails users.&#92;n

A map of Azure API to Guardrails Permission Level used to customize Guardrails&#39;&#92;nstandard permissions. You can add, remove or redefine the mapping of&#92;nAzure API operations to Guardrails permissions levels here.&#92;n&#92;n```&#92;nexample:&#92;n  - &quot;Microsoft.API Management/API Management/delete&quot;: operator&#92;n  - &quot;Microsoft.API Management/API Management/write&quot;: admin&#92;n  - &quot;Microsoft.API Management/API Management/read&quot;: readonly&#92;n```&#92;n

A list of Azure regions in which Azure API Management resources are supported for use.&#92;n&#92;nThe expected format is an array of regions names. You may use the &#39;*&#39; and&#92;n&#39;?&#39; wildcard characters.&#92;n&#92;nThis policy is the default value for all Azure API Management resources&#39; Regions policies.&#92;n

Azure > API Management > Regions

Determine the action to take when an Azure API Management api management service, based on the `Azure &gt; API Management &gt; API Management Service &gt; Active &gt; *` policies.&#92;n&#92;nThe control determines whether the resource is in active use, and if not,&#92;nhas the ability to delete / cleanup the resource. When running an automated&#92;ncompliance environment, it&#39;s common to end up with a wide range of alarms&#92;nthat are difficult and time consuming to clear. The Active control brings&#92;nautomated, well-defined control to this process.&#92;n&#92;nThe Active control checks the status of all defined Active policies for the&#92;nresource (`Azure &gt; API Management &gt; API Management Service &gt; Active &gt; *`), raises an alarm, and takes the defined enforcement&#92;naction. Each Active sub-policy can calculate a status of active, inactive&#92;nor skipped. Generally, if the resource appears to be Active for any reason&#92;nit will be considered Active.&#92;n&#92;n**Note:** In contrast with Approved, where if the&#92;nresource appears to be Unapproved for any reason it will be considered&#92;nUnapproved.&#92;n&#92;nSee [Active](https://turbot.com/guardrails/docs/concepts/guardrails/active) for more information.&#92;n

The age after which the Azure API Management api management service&#92;nis no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.&#92;n&#92;nThe [Active](https://turbot.com/guardrails/docs/concepts/guardrails/active)&#92;ncontrol determines whether the resource is in active use, and if not, has&#92;nthe ability to delete / cleanup the resource. When running an automated&#92;ncompliance environment, it&#39;s common to end up with a wide range of alarms&#92;nthat are difficult and time consuming to clear. The Active control brings&#92;nautomated, well-defined control to this process.&#92;n&#92;nThe Active control checks the status of all defined Active policies for the&#92;nresource (`Azure &gt; API Management &gt; API Management Service &gt; Active &gt; *`),&#92;nraises an alarm, and takes the defined enforcement action. Each Active&#92;nsub-policy can calculate a status of active, inactive or skipped. Generally,&#92;nif the resource appears to be Active for any reason it will be considered Active.&#92;n&#92;n**Note** In contrast with Approved, where if the resource appears to be Unapproved&#92;nfor any reason it will be considered Unapproved.&#92;n&#92;nSee [Active](https://turbot.com/guardrails/docs/concepts/guardrails/active) for more information.&#92;n

The number of days since the Azure API Management api management service was last modified before it is considered&#92;ninactive.&#92;n&#92;nThe [Active](https://turbot.com/guardrails/docs/concepts/guardrails/active)&#92;ncontrol determines whether the resource is in active use, and if not, has&#92;nthe ability to delete / cleanup the resource. When running an automated&#92;ncompliance environment, it&#39;s common to end up with a wide range of alarms&#92;nthat are difficult and time consuming to clear. The Active control brings&#92;nautomated, well-defined control to this process.&#92;n&#92;nThe Active control checks the status of all defined Active policies for the&#92;nresource (`Azure &gt; API Management &gt; API Management Service &gt; Active &gt; *`), raises an alarm, and takes the defined enforcement&#92;naction. Each Active sub-policy can calculate a status of active, inactive&#92;nor skipped. Generally, if the resource appears to be Active for any reason&#92;nit will be considered Active.&#92;n&#92;n**Note** In contrast with Approved, where if the&#92;nresource appears to be Unapproved for any reason it will be considered&#92;nUnapproved.&#92;n

This policy serves as a hierarchical parent for more specific Allowed policies, such as region-based policies and custom rule-based policies.&#92;n

Determine the action to take when an Azure API Management api management service is not allowed based on custom rules.&#92;n&#92;nThe `Allowed &gt; Custom` control checks if the api management service is allowed based on the `Allowed &gt; Custom &gt; *` policies. If the api management service is not allowed, the control raises an alarm and takes the defined enforcement action.&#92;n&#92;nFor any enforcement actions that specify `if new`, e.g., `Enforce: Delete if not allowed and resource is new`, the control will only take the enforcement actions for resources created within the last 60 minutes.&#92;n

Determine whether the Azure API Management api management service is allowed to exist based on custom rules.&#92;n&#92;nThis policy will be evaluated by the `Allowed &gt; Custom` control. If an Azure API Management api management service is not allowed, it will be subject to the action specified in the `Allowed &gt; Custom` policy.&#92;n&#92;n**Note**: The policy value must be a string with a value of `Allowed`, `Not allowed` or `Skip`, or in the form of YAML objects. The object(s) must contain the key `result` with its value as `Allowed` or `Not allowed`. A custom title and message can also be added using the keys `title` and `message` respectively.&#92;n

string

Determine the action to take when an Azure API Management api management service is created in a region that is not allowed.&#92;n&#92;nThe `Allowed &gt; Region` control checks if the api management service is created in an allowed region based on the `Allowed &gt; Region &gt; *` policies. If the api management service is created in a region that is not in the allowed list, the control raises an alarm and takes the defined enforcement action.&#92;n&#92;nFor any enforcement actions that specify `if new`, e.g., `Enforce: Delete if region not allowed and resource is new`, the control will only take the enforcement actions for resources created within the last 60 minutes.&#92;n

A list of Azure regions in which Azure API Management api management services are allowed for use.&#92;n&#92;nThe expected format is an array of regions names. You may use the &#39;*&#39; and &#39;?&#39; wildcard characters.&#92;n&#92;nThis policy will be evaluated by the `Allowed &gt; Region` control. If an Azure API Management api management service is created in a region that is not in the allowed list, it will be subject to the action specified in the `Allowed &gt; Region` policy.&#92;n

Determine the action to take when an Azure API Management api management service is not approved based on `Azure &gt; API Management &gt; API Management Service &gt; Approved &gt; *` policies.&#92;n&#92;nThe 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.&#92;n&#92;nFor 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.&#92;n&#92;nSee [Approved](https://turbot.com/guardrails/docs/concepts/guardrails/approved) for more information.&#92;n

Determine whether the Azure API Management api management service is allowed to exist.&#92;nThis 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 &gt; API Management &gt; API Management Service &gt; Approved` policy.&#92;nSee [Approved](https://turbot.com/guardrails/docs/concepts/guardrails/approved) for more information.&#92;n&#92;n**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.&#92;n

A list of Azure regions in which Azure API Management api management services are approved for use.&#92;n&#92;nThe expected format is an array of regions names. You may use the &#39;*&#39; and &#39;?&#39; wildcard characters.&#92;n&#92;nThis 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 &gt; API Management &gt; API Management Service &gt; Approved` policy.&#92;n&#92;nSee [Approved](https://turbot.com/guardrails/docs/concepts/guardrails/approved) for more information.&#92;n

Determine whether the Azure API Management api management service is allowed to exist.&#92;n&#92;nThis 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 &gt; API Management &gt; API Management Service &gt; Approved` policy.&#92;n&#92;nSee [Approved](https://turbot.com/guardrails/docs/concepts/guardrails/approved) for more information.&#92;n

Configure whether to record and synchronize details for the Azure API Management api management service into the CMDB.&#92;n&#92;nThe [CMDB](https://turbot.com/guardrails/docs/concepts/guardrails/cmdb) control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.&#92;nAll policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to **&quot;Enforce: Enabled&quot;**.&#92;n&#92;nIf 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.&#92;n&#92;nTo cleanup resources and stop tracking changes, set this policy to **&quot;Enforce: Disabled&quot;**.&#92;n&#92;nCMDB controls also use the Regions policy associated with the resource. If region is not in `Azure &gt; API Management &gt; API Management Service &gt; Regions` policy, the CMDB control will delete the resource from the CMDB.&#92;n&#92;n(**Note**: Setting CMDB to **&quot;Skip&quot;** will also pause these changes.)&#92;n

Configure public network access settings for `Azure &gt; API Management &gt; API Management Service`.&#92;n&#92;nThe Public Network Access policy determines whether the public network access for Azure API Management Service should be Enabled or Disabled. When public network access is disabled, the API Management service can only be accessed through private endpoints, providing enhanced security by preventing public internet access to the service.&#92;n

A list of Azure regions in which Azure API Management api management services are supported for use.&#92;n&#92;nAny api management services in a region not listed here will not be recorded in CMDB.&#92;n&#92;nThe expected format is an array of regions names. You may use the &#39;*&#39; and&#92;n&#39;?&#39; wildcard characters.&#92;n

Determine the action to take when an Azure API Management api management service tags are not updated based on the `Azure &gt; API Management &gt; API Management Service &gt; Tags &gt; *` policies.&#92;n&#92;nThe control ensure Azure API Management api management service tags include tags defined in `Azure &gt; API Management &gt; API Management Service &gt; Tags &gt; Template`.&#92;n&#92;nTags 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.&#92;n&#92;nSee [Tags](https://turbot.com/guardrails/docs/concepts/guardrails/tagging) for more information.&#92;n

The template is used to generate the keys and values for Azure API Management api management service.&#92;n&#92;nTags 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.&#92;n&#92;nSee [Tags](https://turbot.com/guardrails/docs/concepts/guardrails/tagging) for more information.&#92;n

A template used to generate the keys and values for Azure API Management resources.&#92;n&#92;nBy default, all API Management resource Tags &gt; Template policies will use this value.&#92;n

Azure > API Management > Tags Template [Default]

A calculated policy that Guardrails uses to create a compiled list of ALL&#92;npermissions for Azure API Management that is used as input to the control that manages&#92;nthe IAM stack.&#92;n

Azure > Turbot > Permissions > Compiled > Service Permissions

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

A calculated policy that Guardrails uses to create a compiled list of ALL&#92;npermission levels for Azure API Management that is used as input to the&#92;nstack that manages the Guardrails IAM permissions objects.&#92;n

Azure > Turbot > Permissions > Compiled > Levels

Azure > Turbot > Permissions > Compiled > Levels > @turbot/azure-apimanagement

The API Management resource type enables users to publish, manage, secure, and analyze APIs in a few minutes, known as instances, that can run applications and services.&#92;n

Azure

Azure > API Management > API Management Service > ServiceNow

The API Management service is a part of the Microsoft Azure cloud platform. Each API Management Service resource is a fully managed service that allows developers to publish, secure, transform, maintain, and monitor APIs. It can be used to create, manage, and consume APIs effectively.&#92;n

Mod: azure-apimanagement

Recommended Version

Resource Types

Controls

IAM Roles

Policies