REST Resource: folders.locations.securityHealthAnalyticsCustomModules

Recurso: SecurityHealthAnalyticsCustomModule

Representa uma instância de um módulo personalizado do Security Health Analytics, incluindo o nome completo do módulo, o nome de exibição, o estado de ativação e a hora da última atualização. É possível criar um módulo personalizado no nível da organização, da pasta ou do projeto. Os módulos personalizados criados no nível da organização ou da pasta são herdados pelas pastas e projetos descendentes.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "enablementState": enum (EnablementState),
  "updateTime": string,
  "lastEditor": string,
  "ancestorModule": string,
  "customConfig": {
    object (CustomConfig)
  }
}
Campos
name

string

Identificador. O nome completo do recurso do módulo personalizado em um dos seguintes formatos:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
displayName

string

Opcional. O nome de exibição do módulo personalizado do Security Health Analytics. Esse nome de exibição se torna a categoria de descoberta de todas as descobertas retornadas por esse módulo personalizado. O nome de exibição precisa ter entre 1 e 128 caracteres, começar com uma letra minúscula e conter apenas caracteres alfanuméricos ou sublinhados.
enablementState

enum (EnablementState)

Opcional. O estado de ativação do módulo personalizado.
updateTime

string (Timestamp format)

Apenas saída. A hora em que o módulo personalizado foi atualizado pela última vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
lastEditor

string

Apenas saída. O editor que atualizou o módulo personalizado pela última vez.
ancestorModule

string

Apenas saída. Especifica a organização ou pasta de onde o módulo personalizado é herdado. Se estiver vazio, indica que o módulo personalizado foi criado na organização, pasta ou projeto em que você está visualizando o módulo.
customConfig

object (CustomConfig)

Opcional. A configuração personalizada especificada pelo usuário para o módulo.

EnablementState

Possíveis estados de ativação de um módulo personalizado.

Enums
ENABLEMENT_STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
ENABLED O módulo é ativado na organização, pasta ou projeto especificado.
DISABLED O módulo é desativado na organização, pasta ou projeto especificado.
INHERITED O estado é herdado de um módulo ancestral. O módulo será ENABLED ou DISABLED com base no módulo ancestral não herdado mais próximo na hierarquia de recursos. Se você tentar definir um módulo de nível superior (um módulo sem pai) para o estado INHERITED, vai receber um erro INVALID_ARGUMENT.

Métodos

create

 Cria um SecurityHealthAnalyticsCustomModule residente no escopo da organização, pasta ou projeto especificado e também cria recursos SecurityHealthAnalyticsCustomModule herdados para todas as pastas e projetos que são descendentes do pai.

delete

 Exclui o SecurityHealthAnalyticsCustomModule especificado e todos os seus descendentes na hierarquia de recursos.

get

 Recupera um SecurityHealthAnalyticsCustomModule.

list

 Retorna uma lista de todos os recursos SecurityHealthAnalyticsCustomModule do pai especificado.

listDescendant

 Retorna uma lista de todos os recursos SecurityHealthAnalyticsCustomModule residentes na organização, pasta ou projeto especificado e em todos os descendentes.

patch

 Atualiza o SecurityHealthAnalyticsCustomModule com o nome fornecido com base na máscara de atualização fornecida.

simulate

 Simula o resultado do uso de um SecurityHealthAnalyticsCustomModule para verificar um recurso.