Personalizar implementações de repositório

Existem duas maneiras principais de personalizar a implantação do conteúdo do seu repositório nos espaços de trabalho do Microsoft Sentinel. Cada método utiliza diferentes ficheiros e sintaxe, por isso, considere estes exemplos para começar. Antes de começar, verifique se os pré-requisitos de conexão e implantação do repositório necessários estão em vigor.

Pré-requisitos

Para personalizar uma implantação de repositório, você precisa de uma conexão de repositório existente. Para criar um, consulte Implantar conteúdo personalizado do repositório. Depois de criar a conexão, certifique-se de atender a estes requisitos:

• Acesso de colaborador ao repositório do GitHub ou ao acesso do Administrador de Projetos ao seu repositório do Azure DevOps
• Ações ativadas para o GitHub e Pipelines ativadas para Azure DevOps
• Certifique-se de que os ficheiros de conteúdo personalizados que pretende implementar nas áreas de trabalho estão num formato suportado. Para obter os formatos suportados, veja Planear o conteúdo do repositório.

Para obter mais informações sobre tipos de conteúdo implementáveis, veja Planear o conteúdo do repositório.

Personalize o fluxo de trabalho ou pipeline

O fluxo de trabalho predefinido só implementa conteúdo modificado desde a última implementação, com base em consolidações no repositório. Personalize o fluxo de trabalho ou pipeline para configurar diferentes gatilhos de implantação, ou para implantar conteúdo exclusivamente de uma pasta raiz específica.

Selecione uma das seguintes abas de acordo com o seu tipo de conexão:

Dimensionar as implementações com ficheiros de parâmetros

Em vez de transmitir parâmetros como valores inline nos seus ficheiros de conteúdo, considere utilizar um ficheiro de parâmetro bicep ou um ficheiro JSON que contenha os valores dos parâmetros. Em seguida, mapeie esses ficheiros de parâmetros para os ficheiros de conteúdo Microsoft Sentinel associados para dimensionar melhor as suas implementações em diferentes áreas de trabalho.

Existem várias formas de mapear ficheiros de parâmetros para os ficheiros de conteúdo. Lembre-se de que os arquivos de parâmetros do Bicep oferecem suporte apenas a modelos de arquivo do Bicep, mas os arquivos de parâmetros JSON oferecem suporte a ambos. O pipeline de implementação de repositórios considera os ficheiros de parâmetros pela seguinte ordem:

1. Existe um mapeamento no sentinel-deployment.config?
   Para obter mais informações, veja Personalizar a configuração da ligação.

2. Existe um ficheiro de parâmetros mapeado pela área de trabalho? Sim, os arquivos de conteúdo estão no mesmo diretório com um arquivo de parâmetros mapeado para um workspace que corresponda a um destes padrões:
   .<WorkspaceID>.bicepparam
   .parameters-<WorkspaceID>.json

3. Existe um ficheiro de parâmetros predefinido? Sim, os ficheiros de conteúdo estão no mesmo diretório com um ficheiro de parâmetro que corresponde a um destes padrões:
   .bicepparam
   .parameters.json

Evite conflitos com múltiplas implementações de áreas de trabalho ao mapear os ficheiros de parâmetros através do ficheiro de configuração ou ao especificar o ID da área de trabalho no nome do ficheiro.

Modificar o ficheiro de parâmetro mapeado listado no sentinel-deployment.config aciona a implementação do respetivo ficheiro de conteúdo emparelhado. Adicionar ou modificar um ficheiro de parâmetros mapeado por área de trabalho ou um ficheiro de parâmetros predefinido também aciona uma implementação dos ficheiros de conteúdo emparelhado juntamente com os parâmetros recentemente modificados, a menos que esteja em vigor um mapeamento de parâmetros de precedência superior. Outros ficheiros de conteúdo não são implementados desde que a funcionalidade de implementações inteligentes ainda esteja ativada no ficheiro de definição de fluxo de trabalho/pipeline.

Personalizar a configuração da ligação

O script de implementação para repositórios suporta a utilização de um ficheiro de configuração de implementação para cada ramo de repositório a partir de julho de 2022. O ficheiro JSON de configuração ajuda-o a mapear ficheiros de parâmetros para ficheiros de conteúdo relevantes, a atribuir prioridades a conteúdos específicos em implementações e a excluir conteúdos específicos de implementações.

1. Crie o ficheiro sentinel-deployment.config na raiz do seu repositório.

   

2. Inclua o conteúdo estruturado em três secções opcionais, "prioritizedcontentfiles":, "excludecontentfiles":e "parameterfilemappings":. Se não estiverem incluídas secções ou o ficheiro .config for omitido, o processo de implementação continuará a ser executado. As secções inválidas ou não reconhecidas são ignoradas.

Aqui está um exemplo do conteúdo completo de um arquivo sentinel-deployment.config válido. Este exemplo também pode ser encontrado no exemplo de repositórios CICD do Microsoft Sentinel.

{
  "prioritizedcontentfiles": [
    "parsers/Sample/ASimAuthenticationAWSCloudTrail.json",
    "workbooks/sample/TrendMicroDeepSecurityAttackActivity_ARM.json",
    "Playbooks/PaloAlto-PAN-OS/PaloAltoCustomConnector/azuredeploy.bicep"
  ], 
  "excludecontentfiles": [
     "Detections/Sample/PaloAlto-PortScanning.json",
     "parameters"
  ],
  "parameterfilemappings": {
    "879001c8-2181-4374-be7d-72e5dc69bd2b": {
      "Playbooks/PaloAlto-PAN-OS/Playbooks/PaloAlto-PAN-OS-BlockIP/azuredeploy.bicep": "parameters/samples/auzredeploy.bicepparam"
    },
    "9af71571-7181-4cef-992e-ef3f61506b4e": {
      "Playbooks/Enrich-SentinelIncident-GreyNoiseCommunity-IP/azuredeploy.json": "path/to/any-parameter-file.json"
    }
  },
  "DummySection": "This shouldn't impact deployment"
}

• Para priorizar arquivos de conteúdo:

  À medida que a quantidade de conteúdo no seu repositório aumenta, os tempos de implementação podem aumentar. Adicione conteúdo sensível ao tempo a esta seção para priorizar sua implantação quando um acionador for disparado.

  Adicione nomes de caminho completos à "prioritizedcontentfiles": secção. A correspondência com curinga não é suportada no momento.

• Para excluir arquivos de conteúdo, modifique a "excludecontentfiles": seção com nomes completos de caminhos de arquivos individuais .json conteúdo.

• Para mapear parâmetros:

  O script de implantação aceita três métodos de parâmetros de mapeamento (mapeamentos de arquivo de configuração, arquivos de parâmetro mapeados por workspace e arquivos de parâmetro padrão), conforme descrito em Dimensionar suas implantações com arquivos de parâmetro. Os parâmetros de mapeamento através do sentinel-deployment.config têm a precedência mais elevada e garantem que um determinado ficheiro de parâmetro é mapeado para os respetivos ficheiros de conteúdo associados. Modifique a seção "parameterfilemappings": com o ID do espaço de trabalho da conexão de destino e os caminhos completos dos arquivos .json individuais.

Conteúdo relacionado

• Exemplo de repositórios CICD do Microsoft Sentinel.
• Compreender a estrutura e a sintaxe dos ficheiros Bicep
• Parâmetros no Bicep
• Criar arquivo de parâmetros do Resource Manager
• Parâmetros em modelos do ARM