apim_checklist.pt.json

{
    "$schema": "checklist.schema.json",
    "categories": [
        {
            "name": "Gerenciamento de identidades e acesso"
        },
        {
            "name": "Topologia de rede e conectividade"
        },
        {
            "name": "Segurança"
        },
        {
            "name": "Gestão"
        },
        {
            "name": "Governança"
        },
        {
            "name": "Automação de plataformas e DevOps"
        }
    ],
    "items": [
        {
            "category": "Governança",
            "guid": "d7941d4a-7b6f-458f-8714-2f8f8c059ad4",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-error-handling-policies",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Melhores práticas de desenvolvimento",
            "text": "Implementar uma política de tratamento de erros em nível global",
            "waf": "Operações"
        },
        {
            "category": "Governança",
            "guid": "0b0c0765-ff37-4369-90bd-3eb23ce71b08",
            "link": "https://learn.microsoft.com/azure/api-management/set-edit-policies?tabs=form#use-base-element-to-set-policy-evaluation-order",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Melhores práticas de desenvolvimento",
            "text": "Certifique-se de que todas as políticas de APIs incluam um <base/> elemento .",
            "waf": "Operações"
        },
        {
            "category": "Governança",
            "guid": "a5c45b03-93b6-42fe-b16b-8fccb6a79902",
            "link": "https://learn.microsoft.com/azure/api-management/policy-fragments",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Melhores práticas de desenvolvimento",
            "text": "Usar fragmentos de política para evitar a repetição das mesmas definições de políticas em várias APIs",
            "waf": "Operações"
        },
        {
            "category": "Governança",
            "guid": "c3818a95-6ff3-4474-88dc-e809b46dad6a",
            "link": "https://learn.microsoft.com/azure/api-management/monetization-support",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Monetização",
            "text": "Se você estiver planejando monetizar suas APIs, consulte o artigo 'suporte à monetização' para obter as práticas recomendadas",
            "waf": "Operações"
        },
        {
            "category": "Governança",
            "guid": "a7d0840a-c8c4-4e83-adec-5ca578eb4049",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-use-azure-monitor#resource-logs",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Monitorização",
            "text": "Habilitar Configurações de Diagnóstico para exportar logs para o Azure Monitor",
            "waf": "Operações"
        },
        {
            "category": "Governança",
            "guid": "8691fa38-45ed-4299-a247-fecd98d35deb",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-app-insights",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Monitorização",
            "text": "Habilite o Application Insights para telemetria mais detalhada",
            "waf": "Operações"
        },
        {
            "category": "Governança",
            "guid": "55fd27bb-76ac-4a91-bc37-049e885be6b7",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-use-azure-monitor",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Monitorização",
            "text": "Configurar alertas sobre as métricas mais críticas",
            "waf": "Operações"
        },
        {
            "category": "Gerenciamento de identidades e acesso",
            "guid": "39460bdb-156f-4dc2-a87f-1e8c11ab0998",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#certificate-management-in-azure-key-vault",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Proteção de dados",
            "text": "Certifique-se de que os certificados SSL personalizados sejam armazenados em um Cofre de Chaves do Azure para que possam ser acessados e atualizados com segurança",
            "waf": "Segurança"
        },
        {
            "category": "Gerenciamento de identidades e acesso",
            "guid": "e9217997-5f6c-479d-8576-8f2adf706ec8",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#azure-ad-authentication-required-for-data-plane-access",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Identidade",
            "text": "Proteger solicitações de entrada para APIs (plano de dados) com o Azure AD",
            "waf": "Segurança"
        },
        {
            "category": "Gerenciamento de identidades e acesso",
            "guid": "5e5f64ba-c90e-480e-8888-398d96cf0bfb",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-aad",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Identidade",
            "text": "Usar o Microsoft Entra ID para autenticar usuários no Portal do Desenvolvedor",
            "waf": "Segurança"
        },
        {
            "category": "Gerenciamento de identidades e acesso",
            "guid": "f8e574ce-280f-49c8-b2ef-68279b081cf3",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-create-groups",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Acesso privilegiado",
            "text": "Criar grupos apropriados para controlar a visibilidade dos produtos",
            "waf": "Segurança"
        },
        {
            "category": "Gestão",
            "guid": "06862505-2d9a-4874-9491-2837b00a3475",
            "link": "https://learn.microsoft.com/azure/api-management/backends",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Práticas recomendadas",
            "text": "Use o recurso Back-ends para eliminar configurações redundantes de back-end de API",
            "waf": "Operações"
        },
        {
            "category": "Gestão",
            "guid": "03b125d5-b69b-4739-b7fd-84b86da4933e",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-properties?tabs=azure-portal",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Práticas recomendadas",
            "text": "Usar Valores Nomeados para armazenar valores comuns que podem ser usados em políticas",
            "waf": "Operações"
        },
        {
            "category": "Gestão",
            "guid": "beae759e-4ddb-4326-bf26-47f87d3454b6",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-deploy-multi-region",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Continuidade de negócios e recuperação de desastres",
            "text": "Para DR, aproveite o nível premium com implantações dimensionadas em duas ou mais regiões para um SLA de 99,99%",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "9c8d1664-dd9a-49d4-bd83-950af0af4044",
            "link": "https://learn.microsoft.com/azure/api-management/high-availability",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Continuidade de negócios e recuperação de desastres",
            "text": "Implante pelo menos uma unidade em duas ou mais zonas de disponibilidade para um SLA aumentado de 99,99%",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "8d2db6e8-85c6-4118-a52c-ae76a4f27934",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#service-native-backup-capability",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Continuidade de negócios e recuperação de desastres",
            "text": "Verifique se há uma rotina de backup automatizada",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "43e60b94-7bca-43a2-aadf-efb04d63a485",
            "link": "https://learn.microsoft.com/azure/api-management/retry-policy",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Failover e cache",
            "text": "Use Políticas para adicionar uma URL de back-end de failover e cache para reduzir chamadas com falha.",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "f96ddac5-77ec-4fa9-8833-4327f052059e",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-cache-external",
            "severity": "Média",
            "subcategory": "Desempenho e escalabilidade",
            "text": "Considere o uso de uma política de cache externo para APIs que podem se beneficiar do cache",
            "training": "https://learn.microsoft.com/training/modules/improve-api-performance-with-apim-caching-policy/"
        },
        {
            "category": "Gestão",
            "guid": "8210699f-8d43-45c2-8f19-57e54134bd8f",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-log-event-hubs",
            "service": "APIM",
            "severity": "Baixo",
            "subcategory": "Desempenho e escalabilidade",
            "text": "Se você precisar registrar em níveis de alto desempenho, considere a política de Hubs de Eventos",
            "waf": "Operações"
        },
        {
            "category": "Gestão",
            "guid": "121bfc39-fa7b-4096-b93b-ab56c1bc0bed",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-sample-flexible-throttling",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Desempenho e escalabilidade",
            "text": "Aplicar políticas de limitação para controlar o número de solicitações por segundo",
            "training": "https://learn.microsoft.com/training/modules/protect-apis-on-api-management/",
            "waf": "Desempenho"
        },
        {
            "category": "Gestão",
            "guid": "bb5f356b-3daf-47a2-a9ee-867a8100bbd5",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-autoscale",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Desempenho e escalabilidade",
            "text": "Configurar o dimensionamento automático para dimensionar o número de instâncias quando a carga aumenta",
            "waf": "Desempenho"
        },
        {
            "category": "Gestão",
            "guid": "84b94abb-59b6-4b9d-8587-3413669468e8",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-provision-self-hosted-gateway",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Desempenho e escalabilidade",
            "text": "Implante gateways auto-hospedados onde o Azure não tem uma região próxima às APIs de back-end.",
            "waf": "Desempenho"
        },
        {
            "category": "Gestão",
            "guid": "1fe8db45-a017-4888-8c4d-4422583cfae0",
            "link": "https://learn.microsoft.com/azure/api-management/upgrade-and-scale#upgrade-and-scale",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Nível Premium",
            "text": "Use a camada premium para cargas de trabalho de produção.",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "1b8d68a4-66cd-44d5-ba94-3ee94440e8d6",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-deploy-multi-region#-route-api-calls-to-regional-backend-services",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Roteamento de Solicitações",
            "text": "No modelo de várias regiões, use Políticas para rotear as solicitações para back-ends regionais com base na disponibilidade ou latência.",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "46f07d33-ef9a-44e8-8f98-67c097c5d8cd",
            "link": "https://learn.microsoft.com/azure/azure-resource-manager/management/azure-subscription-service-limits#api-management-limits",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Limites de recursos",
            "text": "Esteja atento aos limites da APIM",
            "waf": "Fiabilidade"
        },
        {
            "category": "Gestão",
            "guid": "10f58602-f0f9-4d77-972a-956f6e0f2600",
            "link": "https://learn.microsoft.com/en-us/azure/api-management/self-hosted-gateway-overview",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Auto-hospedado",
            "text": "Certifique-se de que as implantações de gateway auto-hospedado sejam resilientes.",
            "waf": "Fiabilidade"
        },
        {
            "category": "Topologia de rede e conectividade",
            "guid": "7519e385-a88b-4d34-966b-6269d686e890",
            "link": "https://learn.microsoft.com/azure/api-management/front-door-api-management",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Conectividade",
            "text": "Usar o Azure Front Door na frente do APIM para implantação em várias regiões",
            "waf": "Desempenho"
        },
        {
            "category": "Topologia de rede e conectividade",
            "guid": "cd45c90e-7690-4753-930b-bf290c69c074",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#virtual-network-integration",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Segurança",
            "text": "Implantar o serviço em uma rede virtual (VNet)",
            "waf": "Segurança"
        },
        {
            "category": "Topologia de rede e conectividade",
            "guid": "02661582-b3d1-48d1-9d7b-c6a918a0ca33",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#network-security-group-support",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Segurança",
            "text": "Implante NSG (grupos de segurança de rede) em suas sub-redes para restringir ou monitorar o tráfego de/para APIM.",
            "waf": "Segurança"
        },
        {
            "category": "Topologia de rede e conectividade",
            "guid": "67437a28-2721-4a2c-becd-caa54c8237a5",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#azure-private-link",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Segurança",
            "text": "Implante pontos de extremidade privados para filtrar o tráfego de entrada quando o APIM não for implantado em uma rede virtual.",
            "waf": "Segurança"
        },
        {
            "category": "Topologia de rede e conectividade",
            "guid": "d698adbd-3288-44cb-b10a-9b572da395ae",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#disable-public-network-access",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Segurança",
            "text": "Desabilitar o acesso à rede pública",
            "waf": "Segurança"
        },
        {
            "category": "Automação de plataformas e DevOps",
            "guid": "0674d750-0c6f-4ac0-8717-ceec04d0bdbd",
            "link": "https://learn.microsoft.com/azure/api-management/automation-manage-api-management",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Automação",
            "text": "Simplifique o gerenciamento com scripts de automação do PowerShell",
            "waf": "Operações"
        },
        {
            "category": "Automação de plataformas e DevOps",
            "guid": "c385bfcd-49fd-4786-81ba-cedbb4c57345",
            "link": "https://learn.microsoft.com/azure/cloud-adoption-framework/scenarios/app-platform/api-management/platform-automation-and-devops#design-recommendations",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Práticas recomendadas",
            "text": "Configure APIM via Infrastructure-as-code. Analise as práticas recomendadas de DevOps do Cloud Adaption Framework APIM Landing Zone Accelerator",
            "waf": "Operações"
        },
        {
            "category": "Automação de plataformas e DevOps",
            "guid": "6c3a27c0-197f-426c-9ffa-86fed51d9ab6",
            "link": "https://learn.microsoft.com/azure/api-management/visual-studio-code-tutorial",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Práticas recomendadas",
            "text": "Promover o uso da extensão API do Visual Studio Code para um desenvolvimento de API mais rápido",
            "waf": "Operações"
        },
        {
            "category": "Automação de plataformas e DevOps",
            "guid": "354f1c03-8112-4965-85ad-c0074bddf231",
            "link": "https://learn.microsoft.com/azure/api-management/devops-api-development-templates",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "DevOps",
            "text": "Implemente DevOps e CI/CD em seu fluxo de trabalho",
            "waf": "Operações"
        },
        {
            "category": "Segurança",
            "guid": "b6439493-426a-45f3-9697-cf65baee208d",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-mutual-certificates-for-clients",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Apis",
            "text": "APIs seguras usando autenticação de certificado de cliente",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "2a67d143-1033-4c0a-8732-680896478f08",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-mutual-certificates",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Apis",
            "text": "Serviços de back-end seguros usando autenticação de certificado de cliente",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "074435f5-4a46-41ac-b521-d6114cb5d845",
            "link": "https://learn.microsoft.com/azure/api-management/mitigate-owasp-api-threats",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Apis",
            "text": "Consulte o artigo \"Recomendações para mitigar as 10 principais ameaças da segurança da API OWASP\" e verifique o que é aplicável às suas APIs",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "5507c4b8-a7f8-41d6-9661-418c987100c9",
            "link": "https://learn.microsoft.com/azure/api-management/authorizations-overview",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Apis",
            "text": "Usar o recurso Autorizações para simplificar o gerenciamento do token OAuth 2.0 para suas APIs de back-end",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "2deee033-b906-4bc2-9f26-c8d3699fe091",
            "link": "https://learn.microsoft.com/azure/api-management/api-management-howto-manage-protocols-ciphers",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Cifras",
            "text": "Use a versão mais recente do TLS ao criptografar informações em trânsito. Desative protocolos e cifras desatualizados e desnecessários quando possível.",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "f8af3d94-1d2b-4070-846f-849197524258",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#im-8-restrict-the-exposure-of-credential-and-secrets",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Proteção de dados",
            "text": "Certifique-se de que os segredos (valores nomeados) sejam armazenados em um Cofre de Chaves do Azure para que possam ser acessados e atualizados com segurança",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "791abd8b-7706-4e31-9569-afefde724be3",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#managed-identities",
            "service": "APIM",
            "severity": "Média",
            "subcategory": "Identidades",
            "text": "Use identidades gerenciadas para autenticar em outros recursos do Azure sempre que possível",
            "waf": "Segurança"
        },
        {
            "category": "Segurança",
            "guid": "220c4ca6-6688-476b-b2b5-425a78e6fb87",
            "link": "https://learn.microsoft.com/security/benchmark/azure/baselines/api-management-security-baseline?toc=%2Fazure%2Fapi-management%2F&bc=%2Fazure%2Fapi-management%2Fbreadcrumb%2Ftoc.json#ns-6-deploy-web-application-firewall",
            "service": "APIM",
            "severity": "Alto",
            "subcategory": "Rede",
            "text": "Usar o WAF (Web Application Firewall) implantando o Application Gateway na frente do APIM",
            "waf": "Segurança"
        }
    ],
    "metadata": {
        "name": "Azure API Management Review",
        "state": "GA",
        "timestamp": "June 10, 2024",
        "waf": "all"
    },
    "severities": [
        {
            "name": "Alto"
        },
        {
            "name": "Média"
        },
        {
            "name": "Baixo"
        }
    ],
    "status": [
        {
            "description": "Esta verificação ainda não foi analisada",
            "name": "Não verificado"
        },
        {
            "description": "Há um item de ação associado a essa verificação",
            "name": "Abrir"
        },
        {
            "description": "Essa verificação foi verificada e não há outros itens de ação associados a ela",
            "name": "Cumprido"
        },
        {
            "description": "Recomendação compreendida, mas não necessária pelos requisitos atuais",
            "name": "Não é necessário"
        },
        {
            "description": "Não aplicável ao projeto atual",
            "name": "N/A"
        }
    ],
    "waf": [
        {
            "name": "Fiabilidade"
        },
        {
            "name": "Segurança"
        },
        {
            "name": "Custar"
        },
        {
            "name": "Operações"
        },
        {
            "name": "Desempenho"
        }
    ],
    "yesno": [
        {
            "name": "Sim"
        },
        {
            "name": "Não"
        }
    ]
}