Compartilhar via

Iot Security Solution - Update

  • Referência
Serviço:
Defender for Cloud
Versão da API:
2019-08-01

Use esse método para atualizar marcas de solução de Segurança IoT existentes ou recursos definidos pelo usuário. Para atualizar outros campos, use o método CreateOrUpdate.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}?api-version=2019-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

O nome do grupo de recursos na assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
solutionName
 path True

string

O nome da solução de Segurança IoT.
subscriptionId
 path True

string

pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

ID da assinatura do Azure
api-version
 query True

string

Versão da API para a operação

Corpo da solicitação

Nome Tipo Description
properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

Lista do status de configuração para cada tipo de recomendação.
properties.userDefinedResources

UserDefinedResourcesProperties

Propriedades dos recursos definidos pelo usuário da solução de Segurança IoT.
tags

object

Marcas de recurso

Respostas

Nome Tipo Description
200 OK

IoTSecuritySolutionModel

Atualizado
Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Use this method to update existing IoT Security solution

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/iotSecuritySolutions/default?api-version=2019-08-01

{
  "tags": {
    "foo": "bar"
  },
  "properties": {
    "userDefinedResources": {
      "query": "where type != \"microsoft.devices/iothubs\" | where name contains \"v2\"",
      "querySubscriptions": [
        "075423e9-7d33-4166-8bdf-3920b04e3735"
      ]
    },
    "recommendationsConfiguration": [
      {
        "recommendationType": "IoT_OpenPorts",
        "status": "Disabled"
      },
      {
        "recommendationType": "IoT_SharedCredentials",
        "status": "Disabled"
      }
    ]
  }
}

Resposta de exemplo

Código de status:
200 
{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/Locations/eastus/IoTSecuritySolutions/default",
  "name": "default",
  "type": "Microsoft.Security/IoTSecuritySolutions",
  "location": "East Us",
  "tags": {
    "foo": "bar"
  },
  "properties": {
    "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1",
    "status": "Enabled",
    "export": [
      "RawEvents"
    ],
    "disabledDataSources": [],
    "displayName": "Solution Default",
    "iotHubs": [
      "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub"
    ],
    "userDefinedResources": {
      "query": "where type != \"microsoft.devices/iothubs\" | where name contains \"v2\"",
      "querySubscriptions": [
        "075423e9-7d33-4166-8bdf-3920b04e3735"
      ]
    },
    "autoDiscoveredResources": [
      "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735",
      "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub"
    ],
    "recommendationsConfiguration": [
      {
        "recommendationType": "IoT_ACRAuthentication",
        "name": "Service Principal Not Used with ACR",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_AgentSendsUnutilizedMessages",
        "name": "Agent sending underutilized messages",
        "status": "TurnedOn"
      },
      {
        "recommendationType": "IoT_Baseline",
        "name": "Operating system (OS) baseline validation failure",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_EdgeHubMemOptimize",
        "name": "Edge Hub memory can be optimized",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_EdgeLoggingOptions",
        "name": "No Logging Configured for Edge Module",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_InconsistentModuleSettings",
        "name": "Module Settings Inconsistent in SecurityGroup",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_InstallAgent",
        "name": "Install the Azure Security of Things Agent",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_IPFilter_DenyAll",
        "name": "Default IP Filter Policy should be Deny",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_IPFilter_PermissiveRule",
        "name": "IP Filter rule includes large IP range",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_OpenPorts",
        "name": "Open Ports On Device",
        "status": "Disabled"
      },
      {
        "recommendationType": "IoT_PermissiveFirewallPolicy",
        "name": "Permissive firewall policy in one of the chains was found",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_PermissiveInputFirewallRules",
        "name": "Permissive firewall rule in the input chain was found",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_PermissiveOutputFirewallRules",
        "name": "Permissive firewall rule in the output chain was found",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_PrivilegedDockerOptions",
        "name": "High level permissions configured in Edge model twin for Edge module",
        "status": "Enabled"
      },
      {
        "recommendationType": "IoT_SharedCredentials",
        "name": "Same Authentication Credentials used by multiple devices",
        "status": "Disabled"
      },
      {
        "recommendationType": "IoT_VulnerableTLSCipherSuite",
        "name": "TLS cipher suite upgrade",
        "status": "Enabled"
      }
    ],
    "unmaskedIpLoggingStatus": "Enabled"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-27T21:53:29.0928001Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
  }
}

Definições

Nome Description
AdditionalWorkspaceDataType

Lista de tipos de dados enviados para o workspace
AdditionalWorkspacesProperties

Propriedades dos workspaces adicionais.
AdditionalWorkspaceType

Tipo de workspace.
CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody

O detalhe do erro.
createdByType

O tipo de identidade que criou o recurso.
DataSource

Fontes de dados desabilitadas. Desabilitar essas fontes de dados compromete o sistema.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ExportData

Lista de opções adicionais para exportação para dados do workspace.
IoTSecuritySolutionModel

Configuração da solução de Segurança IoT e informações de recursos.
RecommendationConfigStatus

Status da recomendação. Quando o status da recomendação é desabilitado, as recomendações não são geradas.
RecommendationConfigurationProperties

O tipo de recomendação de Segurança IoT.
RecommendationType

O tipo de recomendação de Segurança IoT.
SecuritySolutionStatus

Status da solução de Segurança IoT.
systemData

Metadados relativos à criação e última modificação do recurso.
UnmaskedIpLoggingStatus

Status do registro em log de endereço IP desmascarado
UpdateIotSecuritySolutionData
UserDefinedResourcesProperties

Propriedades dos recursos definidos pelo usuário da solução de Segurança IoT.

AdditionalWorkspaceDataType

Enumeração

Lista de tipos de dados enviados para o workspace

Valor Description
Alerts
RawEvents

AdditionalWorkspacesProperties

Objeto

Propriedades dos workspaces adicionais.

Nome Tipo Valor padrão Description
dataTypes

AdditionalWorkspaceDataType[]

Lista de tipos de dados enviados para o workspace
type

AdditionalWorkspaceType

Sentinel

Tipo de workspace.
workspace

string

ID do recurso do workspace

AdditionalWorkspaceType

Enumeração

Tipo de workspace.

Valor Description
Sentinel

CloudError

Objeto

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome Tipo Description
error.additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
error.code

string

O código de erro.
error.details

CloudErrorBody[]

Os detalhes do erro.
error.message

string

A mensagem de erro.
error.target

string

O destino do erro.

CloudErrorBody

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

CloudErrorBody[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

DataSource

Enumeração

Fontes de dados desabilitadas. Desabilitar essas fontes de dados compromete o sistema.

Valor Description
TwinData

Dados de dispositivos gêmeos

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ExportData

Enumeração

Lista de opções adicionais para exportação para dados do workspace.

Valor Description
RawEvents

Eventos brutos do agente

IoTSecuritySolutionModel

Objeto

Configuração da solução de Segurança IoT e informações de recursos.

Nome Tipo Valor padrão Description
id

string

ID do recurso
location

string

O local do recurso.
name

string

Nome do recurso
properties.additionalWorkspaces

AdditionalWorkspacesProperties[]

Lista de workspaces adicionais
properties.autoDiscoveredResources

string[]

Lista de recursos que foram descobertos automaticamente como relevantes para a solução de segurança.
properties.disabledDataSources

DataSource[]

Fontes de dados desabilitadas. Desabilitar essas fontes de dados compromete o sistema.
properties.displayName

string

Nome de exibição do recurso.
properties.export

ExportData[]

Lista de opções adicionais para exportação para dados do workspace.
properties.iotHubs

string[]

IDs de recursos do Hub IoT
properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

Lista do status de configuração para cada tipo de recomendação.
properties.status

SecuritySolutionStatus

Enabled

Status da solução de Segurança IoT.
properties.unmaskedIpLoggingStatus

UnmaskedIpLoggingStatus

Disabled

Status do registro em log de endereço IP desmascarado
properties.userDefinedResources

UserDefinedResourcesProperties

Propriedades dos recursos definidos pelo usuário da solução de Segurança IoT.
properties.workspace

string

ID do recurso do workspace
systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags

object

Marcas de recurso
type

string

Tipo de recurso

RecommendationConfigStatus

Enumeração

Status da recomendação. Quando o status da recomendação é desabilitado, as recomendações não são geradas.

Valor Description
Disabled
Enabled

RecommendationConfigurationProperties

Objeto

O tipo de recomendação de Segurança IoT.

Nome Tipo Valor padrão Description
name

string

recommendationType

RecommendationType

O tipo de recomendação de Segurança IoT.
status

RecommendationConfigStatus

Enabled

Status da recomendação. Quando o status da recomendação é desabilitado, as recomendações não são geradas.

RecommendationType

Enumeração

O tipo de recomendação de Segurança IoT.

Valor Description
IoT_ACRAuthentication

O esquema de autenticação usado para efetuar pull de um módulo de borda de um repositório do ACR não usa a Autenticação da Entidade de Serviço.
IoT_AgentSendsUnutilizedMessages

Atualmente, a capacidade de tamanho da mensagem do agente IoT está subutilizada, causando um aumento no número de mensagens enviadas. Ajuste os intervalos de mensagens para melhor utilização.
IoT_Baseline

Problemas de configuração do sistema relacionados à segurança identificados.
IoT_EdgeHubMemOptimize

Você pode otimizar o uso de memória do Hub de Borda desativando os cabeçalhos de protocolo para todos os protocolos não usados pelos módulos do Edge em sua solução.
IoT_EdgeLoggingOptions

O registro em log está desabilitado para este módulo de borda.
IoT_IPFilter_DenyAll

A Configuração de Filtro de IP deve ter regras definidas para tráfego permitido e deve negar todo o tráfego por padrão.
IoT_IPFilter_PermissiveRule

Um intervalo de IP de origem de regras permitir filtro IP é muito grande. Regras excessivamente permissivas podem expor seu hub IoT a intendentes mal-intencionados.
IoT_InconsistentModuleSettings

Uma minoria dentro de um grupo de segurança de dispositivo tem configurações inconsistentes do Módulo de Borda com o restante do grupo.
IoT_InstallAgent

Instale o Agente de Segurança das Coisas do Azure.
IoT_OpenPorts

Um ponto de extremidade de escuta foi encontrado no dispositivo.
IoT_PermissiveFirewallPolicy

Uma política de firewall permitida foi encontrada (INPUT/OUTPUT). A política deve negar todo o tráfego por padrão e definir regras para permitir a comunicação necessária de/para o dispositivo.
IoT_PermissiveInputFirewallRules

Foi encontrada uma regra no firewall que contém um padrão permissivo para uma ampla gama de endereços IP ou portas.
IoT_PermissiveOutputFirewallRules

Foi encontrada uma regra no firewall que contém um padrão permissivo para uma ampla gama de endereços IP ou portas.
IoT_PrivilegedDockerOptions

O módulo edge é configurado para ser executado no modo privilegiado, com funcionalidades extensas do Linux ou com acesso à rede no nível do host (enviar/receber dados para o computador host).
IoT_SharedCredentials

Mesmas credenciais de autenticação para o Hub IoT usado por vários dispositivos. Isso pode indicar um dispositivo ilegítimo representando um dispositivo legítimo. Ele também expõe o risco de representação de dispositivo por um invasor.
IoT_VulnerableTLSCipherSuite

Configurações de TLS inseguras detectadas. Atualização imediata recomendada.

SecuritySolutionStatus

Enumeração

Status da solução de Segurança IoT.

Valor Description
Disabled
Enabled

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UnmaskedIpLoggingStatus

Enumeração

Status do registro em log de endereço IP desmascarado

Valor Description
Disabled

O log de IP desmascarado está desabilitado
Enabled

O log de IP desmascarado está habilitado

UpdateIotSecuritySolutionData

Objeto
Nome Tipo Description
properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

Lista do status de configuração para cada tipo de recomendação.
properties.userDefinedResources

UserDefinedResourcesProperties

Propriedades dos recursos definidos pelo usuário da solução de Segurança IoT.
tags

object

Marcas de recurso

UserDefinedResourcesProperties

Objeto

Propriedades dos recursos definidos pelo usuário da solução de Segurança IoT.

Nome Tipo Description
query

string

Consulta do Azure Resource Graph que representa os recursos definidos pelo usuário da solução de segurança. Necessário para começar com "where type != "Microsoft.Devices/IotHubs""
querySubscriptions

string[]

pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

Lista de IDs de assinatura do Azure nas quais a consulta de recursos definidos pelo usuário deve ser executada.