Avaliações do Microsoft.Security

Definição de recurso do Bicep

O tipo de recurso avaliações é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.

Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão no Bicep.

O tipo de recurso de avaliações pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Security/assessments, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Security/assessments@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    additionalData: {
      {customized property}: 'string'
    }
    metadata: {
      assessmentType: 'string'
      categories: [
        'string'
      ]
      description: 'string'
      displayName: 'string'
      implementationEffort: 'string'
      partnerData: {
        partnerName: 'string'
        productName: 'string'
        secret: 'string'
      }
      preview: bool
      remediationDescription: 'string'
      severity: 'string'
      threats: [
        'string'
      ]
      userImpact: 'string'
    }
    partnersData: {
      partnerName: 'string'
      secret: 'string'
    }
    resourceDetails: {
      source: 'string'
      // For remaining properties, see ResourceDetails objects
    }
    status: {
      cause: 'string'
      code: 'string'
      description: 'string'
    }
  }
}

Objetos ResourceDetails

Defina a propriedade de origem para especificar o tipo de objeto.

Para o Azure, use:

  source: 'Azure'

Para OnPremiseSql, use:

  source: 'OnPremiseSql'
  databaseName: 'string'
  machineName: 'string'
  serverName: 'string'
  sourceComputerId: 'string'
  vmuuid: 'string'
  workspaceId: 'string'

Valores de propriedade

assessments

Nome Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 260

Caracteres válidos:
Caracteres alfanuméricos, sublinhados e hifens.
scope Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação. Recurso de destino

Para o Bicep, defina essa propriedade como o nome simbólico do recurso para aplicar o recurso de extensão.
properties Descreve as propriedades de uma avaliação. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Nome Descrição Valor
additionalData Dados adicionais sobre a avaliação SecurityAssessmentPropertiesBaseAdditionalData
metadata Descreve as propriedades de metadados de avaliação. SecurityAssessmentMetadataProperties
partnersData Dados referentes à integração de parceiros de terceiros SecurityAssessmentPartnerData
resourceDetails Detalhes do recurso que foi avaliado ResourceDetails (obrigatório)
status O resultado da avaliação AssessmentStatusOrAssessmentStatusResponse (obrigatório)

SecurityAssessmentPropertiesBaseAdditionalData

Nome Descrição Valor
{propriedade personalizada} string

SecurityAssessmentMetadataProperties

Nome Descrição Valor
assessmentType BuiltIn se a avaliação com base na definição de Azure Policy interna, Personalizar se a avaliação com base na definição de Azure Policy personalizada 'BuiltIn'
'CustomPolicy'
'CustomerManaged'
'VerifiedPartner' (obrigatório)
Categorias Matriz de cadeia de caracteres que contém qualquer um dos:
'Compute'
'Dados'
'IdentityAndAccess'
'IoT'
'Rede'
descrição Descrição legível humana da avaliação string
displayName Nome de exibição amigável da avaliação cadeia de caracteres (obrigatório)
implementationEffort O esforço de implementação necessário para corrigir essa avaliação 'Alto'
'Low'
'Moderado'
partnerData Descreve o parceiro que criou a avaliação SecurityAssessmentMetadataPartnerData
preview True se essa avaliação estiver em versão prévia status bool
remediationDescription Descrição legível por humanos do que você deve fazer para atenuar esse problema de segurança string
severidade O nível de gravidade da avaliação 'Alto'
'Low'
'Medium' (obrigatório)
ameaças Matriz de cadeia de caracteres que contém qualquer um dos:
'accountBreach'
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
'missingCoverage'
'threatResistance'
userImpact O impacto do usuário na avaliação 'Alto'
'Low'
'Moderado'

SecurityAssessmentMetadataPartnerData

Nome Descrição Valor
partnerName Nome da empresa do parceiro cadeia de caracteres (obrigatório)
productName Nome do produto do parceiro que criou a avaliação string
segredo Segredo para autenticar o parceiro e verificar se ele criou a avaliação – somente gravação cadeia de caracteres (obrigatório)

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

SecurityAssessmentPartnerData

Nome Descrição Valor
partnerName Nome da empresa do parceiro cadeia de caracteres (obrigatório)
segredo segredo para autenticar o parceiro – somente gravação cadeia de caracteres (obrigatório)

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

ResourceDetails

Nome Descrição Valor
source Definir o tipo de objeto Azure
OnPremiseSql (obrigatório)

AzureResourceDetails

Nome Descrição Valor
source A plataforma em que o recurso avaliado reside 'Azure' (obrigatório)

OnPremiseSqlResourceDetails

Nome Descrição Valor
source A plataforma em que o recurso avaliado reside 'OnPremiseSql' (obrigatório)
databaseName O nome do banco de dados Sql instalado no computador cadeia de caracteres (obrigatório)
machineName O nome do computador cadeia de caracteres (obrigatório)
serverName O nome do sql server instalado no computador cadeia de caracteres (obrigatório)
sourceComputerId A ID do agente do oms instalada no computador cadeia de caracteres (obrigatório)
vmuuid A ID exclusiva do computador cadeia de caracteres (obrigatório)
workspaceId ID de recurso do Azure do workspace ao qual o computador está anexado cadeia de caracteres (obrigatório)

AssessmentStatusOrAssessmentStatusResponse

Nome Descrição Valor
cause Código programático para a causa da avaliação status string
code Código programático para o status da avaliação 'Íntegro'
'NotApplicable'
'Não íntegro' (obrigatório)
descrição Descrição legível por humanos do status de avaliação string

Definição de recurso de modelo do ARM

O tipo de recurso de avaliações é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.

Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão em modelos do ARM.

O tipo de recurso de avaliações pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Security/assessments, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.Security/assessments",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "additionalData": {
      "{customized property}": "string"
    },
    "metadata": {
      "assessmentType": "string",
      "categories": [ "string" ],
      "description": "string",
      "displayName": "string",
      "implementationEffort": "string",
      "partnerData": {
        "partnerName": "string",
        "productName": "string",
        "secret": "string"
      },
      "preview": "bool",
      "remediationDescription": "string",
      "severity": "string",
      "threats": [ "string" ],
      "userImpact": "string"
    },
    "partnersData": {
      "partnerName": "string",
      "secret": "string"
    },
    "resourceDetails": {
      "source": "string"
      // For remaining properties, see ResourceDetails objects
    },
    "status": {
      "cause": "string",
      "code": "string",
      "description": "string"
    }
  }
}

Objetos ResourceDetails

Defina a propriedade de origem para especificar o tipo de objeto.

Para o Azure, use:

  "source": "Azure"

Para OnPremiseSql, use:

  "source": "OnPremiseSql",
  "databaseName": "string",
  "machineName": "string",
  "serverName": "string",
  "sourceComputerId": "string",
  "vmuuid": "string",
  "workspaceId": "string"

Valores de propriedade

assessments

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Security/assessments'
apiVersion A versão da API do recurso '2021-06-01'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Caracteres alfanuméricos, sublinhados e hifens.
scope Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação. Recurso de destino

Para JSON, defina o valor como o nome completo do recurso ao qual aplicar o recurso de extensão .
properties Descreve as propriedades de uma avaliação. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Nome Descrição Valor
additionalData Dados adicionais sobre a avaliação SecurityAssessmentPropertiesBaseAdditionalData
metadata Descreve as propriedades de metadados de avaliação. SecurityAssessmentMetadataProperties
partnersData Dados referentes à integração de parceiros de terceiros SecurityAssessmentPartnerData
resourceDetails Detalhes do recurso que foi avaliado ResourceDetails (obrigatório)
status O resultado da avaliação AssessmentStatusOrAssessmentStatusResponse (obrigatório)

SecurityAssessmentPropertiesBaseAdditionalData

Nome Descrição Valor
{propriedade personalizada} string

SecurityAssessmentMetadataProperties

Nome Descrição Valor
assessmentType BuiltIn se a avaliação com base na definição de Azure Policy interna, Personalizar se a avaliação com base na definição de Azure Policy personalizada 'BuiltIn'
'CustomPolicy'
'CustomerManaged'
'VerifiedPartner' (obrigatório)
Categorias Matriz de cadeia de caracteres que contém qualquer um dos:
'Compute'
'Dados'
'IdentityAndAccess'
'IoT'
'Rede'
descrição Descrição legível da avaliação string
displayName Nome de exibição amigável da avaliação cadeia de caracteres (obrigatório)
implementationEffort O esforço de implementação necessário para corrigir essa avaliação 'Alto'
'Low'
'Moderado'
partnerData Descreve o parceiro que criou a avaliação SecurityAssessmentMetadataPartnerData
preview True se essa avaliação estiver em versão prévia status bool
remediationDescription Descrição legível do que você deve fazer para atenuar esse problema de segurança string
severidade O nível de gravidade da avaliação 'Alto'
'Low'
'Medium' (obrigatório)
ameaças Matriz de cadeia de caracteres que contém qualquer um dos:
'accountBreach'
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
'missingCoverage'
'threatResistance'
userImpact O impacto do usuário na avaliação 'Alto'
'Low'
'Moderado'

SecurityAssessmentMetadataPartnerData

Nome Descrição Valor
partnerName Nome da empresa do parceiro cadeia de caracteres (obrigatório)
productName Nome do produto do parceiro que criou a avaliação string
segredo Segredo para autenticar o parceiro e verificar se ele criou a avaliação – somente gravação cadeia de caracteres (obrigatório)

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

SecurityAssessmentPartnerData

Nome Descrição Valor
partnerName Nome da empresa do parceiro cadeia de caracteres (obrigatório)
segredo segredo para autenticar o parceiro – somente gravação cadeia de caracteres (obrigatório)

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

ResourceDetails

Nome Descrição Valor
source Definir o tipo de objeto Azure
OnPremiseSql (obrigatório)

AzureResourceDetails

Nome Descrição Valor
source A plataforma em que o recurso avaliado reside 'Azure' (obrigatório)

OnPremiseSqlResourceDetails

Nome Descrição Valor
source A plataforma em que o recurso avaliado reside 'OnPremiseSql' (obrigatório)
databaseName O nome do banco de dados Sql instalado no computador cadeia de caracteres (obrigatório)
machineName O nome do computador cadeia de caracteres (obrigatório)
serverName O nome do sql server instalado no computador cadeia de caracteres (obrigatório)
sourceComputerId A ID do agente do oms instalada no computador cadeia de caracteres (obrigatório)
vmuuid A ID exclusiva do computador cadeia de caracteres (obrigatório)
workspaceId ID de recurso do Azure do workspace ao qual o computador está anexado cadeia de caracteres (obrigatório)

AssessmentStatusOrAssessmentStatusResponse

Nome Descrição Valor
cause Código programático para a causa da avaliação status string
code Código programático para o status da avaliação 'Saudável'
'NotApplicable'
'Não íntegro' (obrigatório)
descrição Descrição legível por humanos do status de avaliação string

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso avaliações é um recurso de extensão, o que significa que você pode aplicá-lo a outro recurso.

Use a parent_id propriedade nesse recurso para definir o escopo desse recurso.

O tipo de recurso de avaliações pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Security/assessments, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessments@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      additionalData = {
        {customized property} = "string"
      }
      metadata = {
        assessmentType = "string"
        categories = [
          "string"
        ]
        description = "string"
        displayName = "string"
        implementationEffort = "string"
        partnerData = {
          partnerName = "string"
          productName = "string"
          secret = "string"
        }
        preview = bool
        remediationDescription = "string"
        severity = "string"
        threats = [
          "string"
        ]
        userImpact = "string"
      }
      partnersData = {
        partnerName = "string"
        secret = "string"
      }
      resourceDetails = {
        source = "string"
        // For remaining properties, see ResourceDetails objects
      }
      status = {
        cause = "string"
        code = "string"
        description = "string"
      }
    }
  })
}

Objetos ResourceDetails

Defina a propriedade de origem para especificar o tipo de objeto.

Para o Azure, use:

  source = "Azure"

Para OnPremiseSql, use:

  source = "OnPremiseSql"
  databaseName = "string"
  machineName = "string"
  serverName = "string"
  sourceComputerId = "string"
  vmuuid = "string"
  workspaceId = "string"

Valores de propriedade

assessments

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Security/assessments@2021-06-01"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 260

Caracteres válidos:
Caracteres alfanuméricos, sublinhados e hifens.
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
properties Descreve as propriedades de uma avaliação. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Nome Descrição Valor
additionalData Dados adicionais sobre a avaliação SecurityAssessmentPropertiesBaseAdditionalData
metadata Descreve as propriedades de metadados de avaliação. SecurityAssessmentMetadataProperties
partnersData Dados referentes à integração de parceiros de terceiros SecurityAssessmentPartnerData
resourceDetails Detalhes do recurso que foi avaliado ResourceDetails (obrigatório)
status O resultado da avaliação AssessmentStatusOrAssessmentStatusResponse (obrigatório)

SecurityAssessmentPropertiesBaseAdditionalData

Nome Descrição Valor
{propriedade personalizada} string

SecurityAssessmentMetadataProperties

Nome Descrição Valor
assessmentType BuiltIn se a avaliação com base na definição de Azure Policy interna, Personalizar se a avaliação com base na definição de Azure Policy personalizada "BuiltIn"
"CustomPolicy"
"CustomerManaged"
"VerifiedPartner" (obrigatório)
Categorias Matriz de cadeia de caracteres que contém qualquer um dos:
"Computação"
"Dados"
"IdentityAndAccess"
"IoT"
"Rede"
descrição Descrição legível humana da avaliação string
displayName Nome de exibição amigável da avaliação cadeia de caracteres (obrigatório)
implementationEffort O esforço de implementação necessário para corrigir essa avaliação "High"
"Low"
"Moderado"
partnerData Descreve o parceiro que criou a avaliação SecurityAssessmentMetadataPartnerData
preview True se essa avaliação estiver em versão prévia status bool
remediationDescription Descrição legível do que você deve fazer para atenuar esse problema de segurança string
severidade O nível de gravidade da avaliação "High"
"Low"
"Médio" (obrigatório)
ameaças Matriz de cadeia de caracteres que contém qualquer um dos:
"accountBreach"
"dataExfiltration"
"dataSpillage"
"denialOfService"
"elevationOfPrivilege"
"maliciousInsider"
"missingCoverage"
"threatResistance"
userImpact O impacto do usuário na avaliação "High"
"Low"
"Moderado"

SecurityAssessmentMetadataPartnerData

Nome Descrição Valor
partnerName Nome da empresa do parceiro cadeia de caracteres (obrigatório)
productName Nome do produto do parceiro que criou a avaliação string
segredo Segredo para autenticar o parceiro e verificar se ele criou a avaliação – somente gravação cadeia de caracteres (obrigatório)

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

SecurityAssessmentPartnerData

Nome Descrição Valor
partnerName Nome da empresa do parceiro cadeia de caracteres (obrigatório)
segredo segredo para autenticar o parceiro – somente gravação cadeia de caracteres (obrigatório)

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

ResourceDetails

Nome Descrição Valor
source Definir o tipo de objeto Azure
OnPremiseSql (obrigatório)

AzureResourceDetails

Nome Descrição Valor
source A plataforma em que o recurso avaliado reside "Azure" (obrigatório)

OnPremiseSqlResourceDetails

Nome Descrição Valor
source A plataforma em que o recurso avaliado reside "OnPremiseSql" (obrigatório)
databaseName O nome do banco de dados Sql instalado no computador cadeia de caracteres (obrigatório)
machineName O nome do computador cadeia de caracteres (obrigatório)
serverName O nome do sql server instalado no computador cadeia de caracteres (obrigatório)
sourceComputerId A ID do agente do oms instalada no computador cadeia de caracteres (obrigatório)
vmuuid A ID exclusiva do computador cadeia de caracteres (obrigatório)
workspaceId ID de recurso do Azure do workspace ao qual o computador está anexado cadeia de caracteres (obrigatório)

AssessmentStatusOrAssessmentStatusResponse

Nome Descrição Valor
cause Código programático para a causa da avaliação status string
code Código programático para o status da avaliação "Íntegro"
"NotApplicable"
"Não íntegro" (obrigatório)
descrição Descrição legível por humanos do status de avaliação string