Personalizar implementações de repositório

Existem duas formas principais de personalizar a implementação do conteúdo do seu repositório para áreas 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, certifique-se de que os pré-requisitos necessários para ligação ao repositório e implementação estão em vigor.

Pré-requisitos

Para personalizar a implantação de um repositório, precisa de uma ligação a um repositório existente. Para criar um, consulte Implementar conteúdo personalizado a partir do seu repositório. Depois de criar a ligação, certifique-se de que cumpre 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.

Personalizar o fluxo de trabalho ou a cadeia de processamento

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 implementação, ou para implementar conteúdo exclusivamente a partir de uma pasta raiz específica.

Selecione um dos seguintes separadores consoante o seu tipo de ligaçã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. Tenha em atenção que os ficheiros de parâmetros Bicep só suportam modelos de ficheiros Bicep, mas os ficheiros de parâmetros JSON suportam ambos os tipos. 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 ficheiros de conteúdo estão no mesmo diretório com um ficheiro de parâmetros mapeado para a área de trabalho 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.

Eis um exemplo do conteúdo completo de um ficheiro 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 ficheiros 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 urgente a esta secção para dar prioridade à sua disponibilização quando um acionador é ativado.

  Adicione nomes de caminho completos à "prioritizedcontentfiles": secção. A correspondência de carateres universais não é suportada neste momento.

• Para excluir ficheiros de conteúdo, modifique a "excludecontentfiles": secção com os nomes completos dos percursos individuais .json ficheiros de conteúdo.

• Para mapear os parâmetros:

  O script de implementação aceita três métodos de mapeamento de parâmetros (mapeamentos de ficheiros de configuração, ficheiros de parâmetros mapeados por workspace e ficheiros de parâmetros padrão), conforme descrito em Escalar as suas implantações com ficheiros de parâmetros. 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 secção "parameterfilemappings": com o ID da área de trabalho da sua ligação de destino e os caminhos completos dos ficheiros .json individuais.

Conteúdos relacionados

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