Avaliações do Microsoft.Security
Definição de recurso do 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 de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Security/assessments, adicione o Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.Security/assessments@2021-06-01' = {
scope: resourceSymbolicName or scope
name: '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 do Azure, use:
{
source: 'Azure'
}
Para OnPremiseSql, use:
{
databaseName: 'string'
machineName: 'string'
serverName: 'string'
source: 'OnPremiseSql'
sourceComputerId: 'string'
vmuuid: 'string'
workspaceId: 'string'
}
Valores de propriedade
AssessmentStatusOrAssessmentStatusResponse
| Nome | Descrição | Valor |
|---|---|---|
| causa | Código programático para a causa do status da avaliação | corda |
| código | Código programático para o status da avaliação | 'Íntegro' 'NotApplicable' 'Não íntegro' (obrigatório) |
| descrição | Descrição legível humana do status da avaliação | corda |
AzureResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| fonte | A plataforma em que o recurso avaliado reside | 'Azure' (obrigatório) |
Microsoft.Security/assessments
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | Descreve as propriedades de uma avaliação. | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| âmbito | Use ao criar um recurso em um escopo diferente do escopo de implantação. | Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão . |
OnPremiseSqlResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| 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) |
| fonte | A plataforma em que o recurso avaliado reside | 'OnPremiseSql' (obrigatório) |
| sourceComputerId | A ID do agente 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) |
ResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| fonte | Defina como 'Azure' para o tipo AzureResourceDetails. Defina como 'OnPremiseSql' para o tipo OnPremiseSqlResourceDetails. | 'Azure' 'OnPremiseSql' (obrigatório) |
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 | corda |
| segredo | Segredo para autenticar o parceiro e verificar se ele criou a avaliação – somente gravação | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentMetadataProperties
| Nome | Descrição | Valor |
|---|---|---|
| assessmentType | BuiltIn se a avaliação baseada na definição interna do Azure Policy, Personalizar se a avaliação com base na definição personalizada do Azure Policy | 'BuiltIn' 'CustomerManaged' 'CustomPolicy' '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 | corda |
| 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' 'Baixo' 'Moderado' |
| partnerData | Descreve o parceiro que criou a avaliação | securityAssessmentMetadataPartnerData |
| Visualizar | True se essa avaliação estiver no status de versão prévia | Bool |
| remediationDescription | Descrição legível humana do que você deve fazer para atenuar esse problema de segurança | corda |
| severidade | O nível de gravidade da avaliação | 'Alto' 'Baixo' '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' 'Baixo' 'Moderado' |
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 | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentPropertiesBaseAdditionalData
| Nome | Descrição | Valor |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| Nome | Descrição | Valor |
|---|---|---|
| additionalData | Dados adicionais sobre a avaliação | SecurityAssessmentPropertiesBaseAdditionalData |
| metadados | 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) |
| estado | O resultado da avaliação | AssessmentStatusOrAssessmentStatusResponse (obrigatório) |
Definição de recurso de modelo do ARM
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 de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Security/assessments, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Security/assessments",
"apiVersion": "2021-06-01",
"name": "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 do Azure, use:
{
"source": "Azure"
}
Para OnPremiseSql, use:
{
"databaseName": "string",
"machineName": "string",
"serverName": "string",
"source": "OnPremiseSql",
"sourceComputerId": "string",
"vmuuid": "string",
"workspaceId": "string"
}
Valores de propriedade
AssessmentStatusOrAssessmentStatusResponse
| Nome | Descrição | Valor |
|---|---|---|
| causa | Código programático para a causa do status da avaliação | corda |
| código | Código programático para o status da avaliação | 'Íntegro' 'NotApplicable' 'Não íntegro' (obrigatório) |
| descrição | Descrição legível humana do status da avaliação | corda |
AzureResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| fonte | A plataforma em que o recurso avaliado reside | 'Azure' (obrigatório) |
Microsoft.Security/assessments
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2021-06-01' |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | Descreve as propriedades de uma avaliação. | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| tipo | O tipo de recurso | 'Microsoft.Security/assessments' |
OnPremiseSqlResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| 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) |
| fonte | A plataforma em que o recurso avaliado reside | 'OnPremiseSql' (obrigatório) |
| sourceComputerId | A ID do agente 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) |
ResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| fonte | Defina como 'Azure' para o tipo AzureResourceDetails. Defina como 'OnPremiseSql' para o tipo OnPremiseSqlResourceDetails. | 'Azure' 'OnPremiseSql' (obrigatório) |
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 | corda |
| segredo | Segredo para autenticar o parceiro e verificar se ele criou a avaliação – somente gravação | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentMetadataProperties
| Nome | Descrição | Valor |
|---|---|---|
| assessmentType | BuiltIn se a avaliação baseada na definição interna do Azure Policy, Personalizar se a avaliação com base na definição personalizada do Azure Policy | 'BuiltIn' 'CustomerManaged' 'CustomPolicy' '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 | corda |
| 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' 'Baixo' 'Moderado' |
| partnerData | Descreve o parceiro que criou a avaliação | securityAssessmentMetadataPartnerData |
| Visualizar | True se essa avaliação estiver no status de versão prévia | Bool |
| remediationDescription | Descrição legível humana do que você deve fazer para atenuar esse problema de segurança | corda |
| severidade | O nível de gravidade da avaliação | 'Alto' 'Baixo' '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' 'Baixo' 'Moderado' |
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 | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentPropertiesBaseAdditionalData
| Nome | Descrição | Valor |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| Nome | Descrição | Valor |
|---|---|---|
| additionalData | Dados adicionais sobre a avaliação | SecurityAssessmentPropertiesBaseAdditionalData |
| metadados | 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) |
| estado | O resultado da avaliação | AssessmentStatusOrAssessmentStatusResponse (obrigatório) |
Definição de recurso do Terraform (provedor de AzAPI)
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 de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Security/assessments, adicione o Terraform a seguir ao seu 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 do Azure, use:
{
source = "Azure"
}
Para OnPremiseSql, use:
{
databaseName = "string"
machineName = "string"
serverName = "string"
source = "OnPremiseSql"
sourceComputerId = "string"
vmuuid = "string"
workspaceId = "string"
}
Valores de propriedade
AssessmentStatusOrAssessmentStatusResponse
| Nome | Descrição | Valor |
|---|---|---|
| causa | Código programático para a causa do status da avaliação | corda |
| código | Código programático para o status da avaliação | 'Íntegro' 'NotApplicable' 'Não íntegro' (obrigatório) |
| descrição | Descrição legível humana do status da avaliação | corda |
AzureResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| fonte | A plataforma em que o recurso avaliado reside | 'Azure' (obrigatório) |
Microsoft.Security/assessments
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| parent_id | A ID do recurso ao qual aplicar esse recurso de extensão. | cadeia de caracteres (obrigatório) |
| Propriedades | Descreve as propriedades de uma avaliação. | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| tipo | O tipo de recurso | "Microsoft.Security/assessments@2021-06-01" |
OnPremiseSqlResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| 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) |
| fonte | A plataforma em que o recurso avaliado reside | 'OnPremiseSql' (obrigatório) |
| sourceComputerId | A ID do agente 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) |
ResourceDetails
| Nome | Descrição | Valor |
|---|---|---|
| fonte | Defina como 'Azure' para o tipo AzureResourceDetails. Defina como 'OnPremiseSql' para o tipo OnPremiseSqlResourceDetails. | 'Azure' 'OnPremiseSql' (obrigatório) |
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 | corda |
| segredo | Segredo para autenticar o parceiro e verificar se ele criou a avaliação – somente gravação | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentMetadataProperties
| Nome | Descrição | Valor |
|---|---|---|
| assessmentType | BuiltIn se a avaliação baseada na definição interna do Azure Policy, Personalizar se a avaliação com base na definição personalizada do Azure Policy | 'BuiltIn' 'CustomerManaged' 'CustomPolicy' '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 | corda |
| 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' 'Baixo' 'Moderado' |
| partnerData | Descreve o parceiro que criou a avaliação | securityAssessmentMetadataPartnerData |
| Visualizar | True se essa avaliação estiver no status de versão prévia | Bool |
| remediationDescription | Descrição legível humana do que você deve fazer para atenuar esse problema de segurança | corda |
| severidade | O nível de gravidade da avaliação | 'Alto' 'Baixo' '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' 'Baixo' 'Moderado' |
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 | corda Restrições: Valor confidencial. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentPropertiesBaseAdditionalData
| Nome | Descrição | Valor |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| Nome | Descrição | Valor |
|---|---|---|
| additionalData | Dados adicionais sobre a avaliação | SecurityAssessmentPropertiesBaseAdditionalData |
| metadados | 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) |
| estado | O resultado da avaliação | AssessmentStatusOrAssessmentStatusResponse (obrigatório) |