Avaliações Microsoft.Security
Definição de recursos do bíceps
O tipo de recurso de avaliações pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/assessments, adicione o seguinte Bicep 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 source para especificar o tipo de objeto.
Para 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
| Designação | Descrição | Valor |
|---|---|---|
| causa | Código programático para a causa do estado de avaliação | string |
| código | Código programático para o estado da avaliação | 'Saudável' 'Não aplicável' 'Insalubre' (obrigatório) |
| Descrição | Descrição legível por humanos do estado da avaliação | string |
AzureResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| fonte | A plataforma onde reside o recurso avaliado | 'Azure' (obrigatório) |
Microsoft.Security/avaliações
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Descreve as propriedades de uma avaliação. | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| Âmbito de aplicação | 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
| Designação | Descrição | Valor |
|---|---|---|
| Nome do banco de dados | O nome do banco de dados Sql instalado na máquina | string (obrigatório) |
| nome_da_máquina | O nome da máquina | string (obrigatório) |
| Nome do servidor | O nome do servidor Sql instalado na máquina | string (obrigatório) |
| fonte | A plataforma onde reside o recurso avaliado | 'OnPremiseSql' (obrigatório) |
| sourceComputerId | O ID do agente oms instalado na máquina | string (obrigatório) |
| VMUUID | O ID único da máquina | string (obrigatório) |
| workspaceId | ID do recurso do Azure do espaço de trabalho ao qual a máquina está anexada | string (obrigatório) |
ResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| fonte | Defina como 'Azure' para o tipo AzureResourceDetails. Defina como 'OnPremiseSql' para o tipo OnPremiseSqlResourceDetails. | 'Azure' 'OnPremiseSql' (obrigatório) |
SecurityAssessmentMetadataPartnerData
| Designação | Descrição | Valor |
|---|---|---|
| Nome do parceiro | Nome da empresa do parceiro | string (obrigatório) |
| Nome do produto | Nome do produto do parceiro que criou a avaliação | string |
| segredo | Segredo para autenticar o parceiro e verificar se criou a avaliação - escrever apenas | string Restrições: Valor sensível. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentMetadataProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de avaliação | BuiltIn se a avaliação baseada na definição interna da Política do Azure, Personalizada se a avaliação baseada na definição personalizada da Política do Azure | 'Incorporado' 'Gerenciado pelo cliente' 'Política Aduaneira' 'VerifiedPartner' (obrigatório) |
| Categorias | Matriz de cadeia de caracteres contendo qualquer uma das: 'Computação' 'Dados' 'IdentidadeeAcesso' 'IoT' 'Networking' |
|
| Descrição | Descrição legível da avaliação por pessoas | string |
| displayName | Nome de exibição amigável da avaliação | string (obrigatório) |
| implementaçãoEsforço | O esforço de implementação necessário para remediar esta avaliação | 'Alta' 'Baixa' 'Moderado' |
| Dados do parceiro | Descreve o parceiro que criou a avaliação | SecurityAssessmentMetadataPartnerData |
| previsualizar | True se esta avaliação estiver no estado de pré-visualização da versão | Bool |
| remediaçãoDescrição | Descrição legível por humanos do que você deve fazer para mitigar esse problema de segurança | string |
| gravidade | O nível de severidade da avaliação | 'Alta' 'Baixa' «Médio» (obrigatório) |
| ameaças | Matriz de cadeia de caracteres contendo qualquer uma das: 'Violação de contas' «Exfiltração de dados» 'Derrame de dados' 'Negação de Serviço' 'ElevaçãodePrivilégio' 'mal-intencionado' 'Cobertura em falta' 'AmeaçaResistência' |
|
| userImpact | O impacto da avaliação para o utilizador | 'Alta' 'Baixa' 'Moderado' |
SecurityAssessmentPartnerData
| Designação | Descrição | Valor |
|---|---|---|
| Nome do parceiro | Nome da empresa do parceiro | string (obrigatório) |
| segredo | segredo para autenticar o parceiro - escrever apenas | string Restrições: Valor sensível. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentPropertiesBaseAdditionalData
| Designação | Descrição | Valor |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| Designação | Descrição | Valor |
|---|---|---|
| dados adicionais | Dados adicionais relativos à avaliação | SecurityAssessmentPropertiesBaseAdditionalData |
| metadados | Descreve as propriedades de um metadados de avaliação. | SecurityAssessmentMetadataProperties |
| parceirosDados | Dados relativos à integração de parceiros de 3ª parte | SecurityAssessmentPartnerData |
| resourceDetails | Detalhes do recurso que foi avaliado | ResourceDetails (obrigatório) |
| Situação | Resultado da avaliação | AssessmentStatusAssessmentStatusResponse (obrigatório) |
Definição de recurso de modelo ARM
O tipo de recurso de avaliações pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/assessments, adicione o seguinte JSON ao seu 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 source para especificar o tipo de objeto.
Para 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
| Designação | Descrição | Valor |
|---|---|---|
| causa | Código programático para a causa do estado de avaliação | string |
| código | Código programático para o estado da avaliação | 'Saudável' 'Não aplicável' 'Insalubre' (obrigatório) |
| Descrição | Descrição legível por humanos do estado da avaliação | string |
AzureResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| fonte | A plataforma onde reside o recurso avaliado | 'Azure' (obrigatório) |
Microsoft.Security/avaliações
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2021-06-01' |
| Designação | O nome do recurso | string (obrigatório) |
| propriedades | Descreve as propriedades de uma avaliação. | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| tipo | O tipo de recurso | 'Microsoft.Security/avaliações' |
OnPremiseSqlResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| Nome do banco de dados | O nome do banco de dados Sql instalado na máquina | string (obrigatório) |
| nome_da_máquina | O nome da máquina | string (obrigatório) |
| Nome do servidor | O nome do servidor Sql instalado na máquina | string (obrigatório) |
| fonte | A plataforma onde reside o recurso avaliado | 'OnPremiseSql' (obrigatório) |
| sourceComputerId | O ID do agente oms instalado na máquina | string (obrigatório) |
| VMUUID | O ID único da máquina | string (obrigatório) |
| workspaceId | ID do recurso do Azure do espaço de trabalho ao qual a máquina está anexada | string (obrigatório) |
ResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| fonte | Defina como 'Azure' para o tipo AzureResourceDetails. Defina como 'OnPremiseSql' para o tipo OnPremiseSqlResourceDetails. | 'Azure' 'OnPremiseSql' (obrigatório) |
SecurityAssessmentMetadataPartnerData
| Designação | Descrição | Valor |
|---|---|---|
| Nome do parceiro | Nome da empresa do parceiro | string (obrigatório) |
| Nome do produto | Nome do produto do parceiro que criou a avaliação | string |
| segredo | Segredo para autenticar o parceiro e verificar se criou a avaliação - escrever apenas | string Restrições: Valor sensível. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentMetadataProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de avaliação | BuiltIn se a avaliação baseada na definição interna da Política do Azure, Personalizada se a avaliação baseada na definição personalizada da Política do Azure | 'Incorporado' 'Gerenciado pelo cliente' 'Política Aduaneira' 'VerifiedPartner' (obrigatório) |
| Categorias | Matriz de cadeia de caracteres contendo qualquer uma das: 'Computação' 'Dados' 'IdentidadeeAcesso' 'IoT' 'Networking' |
|
| Descrição | Descrição legível da avaliação por pessoas | string |
| displayName | Nome de exibição amigável da avaliação | string (obrigatório) |
| implementaçãoEsforço | O esforço de implementação necessário para remediar esta avaliação | 'Alta' 'Baixa' 'Moderado' |
| Dados do parceiro | Descreve o parceiro que criou a avaliação | SecurityAssessmentMetadataPartnerData |
| previsualizar | True se esta avaliação estiver no estado de pré-visualização da versão | Bool |
| remediaçãoDescrição | Descrição legível por humanos do que você deve fazer para mitigar esse problema de segurança | string |
| gravidade | O nível de severidade da avaliação | 'Alta' 'Baixa' «Médio» (obrigatório) |
| ameaças | Matriz de cadeia de caracteres contendo qualquer uma das: 'Violação de contas' «Exfiltração de dados» 'Derrame de dados' 'Negação de Serviço' 'ElevaçãodePrivilégio' 'mal-intencionado' 'Cobertura em falta' 'AmeaçaResistência' |
|
| userImpact | O impacto da avaliação para o utilizador | 'Alta' 'Baixa' 'Moderado' |
SecurityAssessmentPartnerData
| Designação | Descrição | Valor |
|---|---|---|
| Nome do parceiro | Nome da empresa do parceiro | string (obrigatório) |
| segredo | segredo para autenticar o parceiro - escrever apenas | string Restrições: Valor sensível. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentPropertiesBaseAdditionalData
| Designação | Descrição | Valor |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| Designação | Descrição | Valor |
|---|---|---|
| dados adicionais | Dados adicionais relativos à avaliação | SecurityAssessmentPropertiesBaseAdditionalData |
| metadados | Descreve as propriedades de um metadados de avaliação. | SecurityAssessmentMetadataProperties |
| parceirosDados | Dados relativos à integração de parceiros de 3ª parte | SecurityAssessmentPartnerData |
| resourceDetails | Detalhes do recurso que foi avaliado | ResourceDetails (obrigatório) |
| Situação | Resultado da avaliação | AssessmentStatusAssessmentStatusResponse (obrigatório) |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso de avaliações pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.Security/assessments, adicione o seguinte Terraform 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 source para especificar o tipo de objeto.
Para 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
| Designação | Descrição | Valor |
|---|---|---|
| causa | Código programático para a causa do estado de avaliação | string |
| código | Código programático para o estado da avaliação | 'Saudável' 'Não aplicável' 'Insalubre' (obrigatório) |
| Descrição | Descrição legível por humanos do estado da avaliação | string |
AzureResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| fonte | A plataforma onde reside o recurso avaliado | 'Azure' (obrigatório) |
Microsoft.Security/avaliações
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string (obrigatório) |
| parent_id | A ID do recurso ao qual aplicar esse recurso de extensão. | string (obrigatório) |
| propriedades | Descreve as propriedades de uma avaliação. | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| tipo | O tipo de recurso | "Microsoft.Security/assessments@2021-06-01" |
OnPremiseSqlResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| Nome do banco de dados | O nome do banco de dados Sql instalado na máquina | string (obrigatório) |
| nome_da_máquina | O nome da máquina | string (obrigatório) |
| Nome do servidor | O nome do servidor Sql instalado na máquina | string (obrigatório) |
| fonte | A plataforma onde reside o recurso avaliado | 'OnPremiseSql' (obrigatório) |
| sourceComputerId | O ID do agente oms instalado na máquina | string (obrigatório) |
| VMUUID | O ID único da máquina | string (obrigatório) |
| workspaceId | ID do recurso do Azure do espaço de trabalho ao qual a máquina está anexada | string (obrigatório) |
ResourceDetails
| Designação | Descrição | Valor |
|---|---|---|
| fonte | Defina como 'Azure' para o tipo AzureResourceDetails. Defina como 'OnPremiseSql' para o tipo OnPremiseSqlResourceDetails. | 'Azure' 'OnPremiseSql' (obrigatório) |
SecurityAssessmentMetadataPartnerData
| Designação | Descrição | Valor |
|---|---|---|
| Nome do parceiro | Nome da empresa do parceiro | string (obrigatório) |
| Nome do produto | Nome do produto do parceiro que criou a avaliação | string |
| segredo | Segredo para autenticar o parceiro e verificar se criou a avaliação - escrever apenas | string Restrições: Valor sensível. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentMetadataProperties
| Designação | Descrição | Valor |
|---|---|---|
| tipo de avaliação | BuiltIn se a avaliação baseada na definição interna da Política do Azure, Personalizada se a avaliação baseada na definição personalizada da Política do Azure | 'Incorporado' 'Gerenciado pelo cliente' 'Política Aduaneira' 'VerifiedPartner' (obrigatório) |
| Categorias | Matriz de cadeia de caracteres contendo qualquer uma das: 'Computação' 'Dados' 'IdentidadeeAcesso' 'IoT' 'Networking' |
|
| Descrição | Descrição legível da avaliação por pessoas | string |
| displayName | Nome de exibição amigável da avaliação | string (obrigatório) |
| implementaçãoEsforço | O esforço de implementação necessário para remediar esta avaliação | 'Alta' 'Baixa' 'Moderado' |
| Dados do parceiro | Descreve o parceiro que criou a avaliação | SecurityAssessmentMetadataPartnerData |
| previsualizar | True se esta avaliação estiver no estado de pré-visualização da versão | Bool |
| remediaçãoDescrição | Descrição legível por humanos do que você deve fazer para mitigar esse problema de segurança | string |
| gravidade | O nível de severidade da avaliação | 'Alta' 'Baixa' «Médio» (obrigatório) |
| ameaças | Matriz de cadeia de caracteres contendo qualquer uma das: 'Violação de contas' «Exfiltração de dados» 'Derrame de dados' 'Negação de Serviço' 'ElevaçãodePrivilégio' 'mal-intencionado' 'Cobertura em falta' 'AmeaçaResistência' |
|
| userImpact | O impacto da avaliação para o utilizador | 'Alta' 'Baixa' 'Moderado' |
SecurityAssessmentPartnerData
| Designação | Descrição | Valor |
|---|---|---|
| Nome do parceiro | Nome da empresa do parceiro | string (obrigatório) |
| segredo | segredo para autenticar o parceiro - escrever apenas | string Restrições: Valor sensível. Passe como um parâmetro seguro. (obrigatório) |
SecurityAssessmentPropertiesBaseAdditionalData
| Designação | Descrição | Valor |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| Designação | Descrição | Valor |
|---|---|---|
| dados adicionais | Dados adicionais relativos à avaliação | SecurityAssessmentPropertiesBaseAdditionalData |
| metadados | Descreve as propriedades de um metadados de avaliação. | SecurityAssessmentMetadataProperties |
| parceirosDados | Dados relativos à integração de parceiros de 3ª parte | SecurityAssessmentPartnerData |
| resourceDetails | Detalhes do recurso que foi avaliado | ResourceDetails (obrigatório) |
| Situação | Resultado da avaliação | AssessmentStatusAssessmentStatusResponse (obrigatório) |