Partilhar via

Iot Security Solution - Create Or Update

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

Use este método para criar ou atualizar sua solução de Segurança IoT

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.

Padrão Regex: ^[-\w\._\(\)]+$
solutionName
 path True

string

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

string

ID de assinatura do Azure

Padrão Regex: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version
 query True

string

Versão da API para a operação

Corpo do Pedido

Name Necessário Tipo Description
properties.displayName True

string

Nome para exibição do recurso.
properties.iotHubs True

string[]

IDs de recursos do Hub IoT
location

string

A localização do recurso.
properties.additionalWorkspaces

AdditionalWorkspacesProperties[]

Lista de espaços de trabalho adicionais
properties.disabledDataSources

DataSource[]

Fontes de dados desativadas. A desativação dessas fontes de dados compromete o sistema.
properties.export

ExportData[]

Lista de opções adicionais para exportar para dados do espaço de trabalho.
properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

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

SecuritySolutionStatus

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

UnmaskedIpLoggingStatus

Estado de registo do 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 espaço de trabalho
tags

object

Tags de recursos

Respostas

Name Tipo Description
200 OK

IoTSecuritySolutionModel

Atualizado
201 Created

IoTSecuritySolutionModel

Criado
Other Status Codes

CloudError

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Create or update a IoT security solution

Pedido de amostra

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

{
  "tags": {},
  "location": "East Us",
  "properties": {
    "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1",
    "status": "Enabled",
    "export": [],
    "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 \"iot\"",
      "querySubscriptions": [
        "075423e9-7d33-4166-8bdf-3920b04e3735"
      ]
    },
    "recommendationsConfiguration": [
      {
        "recommendationType": "IoT_OpenPorts",
        "status": "Disabled"
      },
      {
        "recommendationType": "IoT_SharedCredentials",
        "status": "Disabled"
      }
    ],
    "unmaskedIpLoggingStatus": "Enabled"
  }
}

Resposta da amostra

Código de estado:
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": {},
  "properties": {
    "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1",
    "status": "Enabled",
    "export": [],
    "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 \"iot\"",
      "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"
  }
}
Código de estado:
201 
{
  "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": {},
  "properties": {
    "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1",
    "status": "Enabled",
    "export": [],
    "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 \"iot\"",
      "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

Name Description
AdditionalWorkspaceDataType

Lista de tipos de dados enviados para o espaço de trabalho
AdditionalWorkspacesProperties

Propriedades dos espaços de trabalho adicionais.
AdditionalWorkspaceType

Tipo de espaço de trabalho.
CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 desativadas. A desativação dessas fontes de dados compromete o sistema.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ExportData

Lista de opções adicionais para exportar para dados do espaço de trabalho.
IoTSecuritySolutionModel

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

Status da recomendação. Quando o status de recomendação é desativado, 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 referentes à criação e última modificação do recurso.
UnmaskedIpLoggingStatus

Estado de registo do endereço IP desmascarado
UserDefinedResourcesProperties

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

AdditionalWorkspaceDataType

Lista de tipos de dados enviados para o espaço de trabalho

Name Tipo Description
Alerts

string

RawEvents

string

AdditionalWorkspacesProperties

Propriedades dos espaços de trabalho adicionais.

Name Tipo Default value Description
dataTypes

AdditionalWorkspaceDataType[]

Lista de tipos de dados enviados para o espaço de trabalho
type

AdditionalWorkspaceType

Sentinel

Tipo de espaço de trabalho.
workspace

string

ID do recurso do espaço de trabalho

AdditionalWorkspaceType

Tipo de espaço de trabalho.

Name Tipo Description
Sentinel

string

CloudError

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

Name Tipo Description
error.additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataSource

Fontes de dados desativadas. A desativação dessas fontes de dados compromete o sistema.

Name Tipo Description
TwinData

string

Dados gêmeos de dispositivos

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ExportData

Lista de opções adicionais para exportar para dados do espaço de trabalho.

Name Tipo Description
RawEvents

string

Eventos brutos do agente

IoTSecuritySolutionModel

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

Name Tipo Default value Description
id

string

ID do recurso
location

string

A localização do recurso.
name

string

Nome do recurso
properties.additionalWorkspaces

AdditionalWorkspacesProperties[]

Lista de espaços de trabalho 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 desativadas. A desativação dessas fontes de dados compromete o sistema.
properties.displayName

string

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

ExportData[]

Lista de opções adicionais para exportar para dados do espaço de trabalho.
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

Estado de registo do 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 espaço de trabalho
systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags

object

Tags de recursos
type

string

Tipo de recurso

RecommendationConfigStatus

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

Name Tipo Description
Disabled

string

Enabled

string

RecommendationConfigurationProperties

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

Name Tipo Default value Description
name

string

recommendationType

RecommendationType

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

RecommendationConfigStatus

Enabled

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

RecommendationType

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

Name Tipo Description
IoT_ACRAuthentication

string

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

string

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

string

Identificados problemas de configuração do sistema relacionados à segurança.
IoT_EdgeHubMemOptimize

string

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

string

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

string

A Configuração do Filtro IP deve ter regras definidas para o tráfego permitido e deve negar todos os outros tráfegos por padrão.
IoT_IPFilter_PermissiveRule

string

Um intervalo de IP de origem de regras de Filtro IP Permitido é muito grande. Regras excessivamente permissivas podem expor seu hub IoT a intenders mal-intencionados.
IoT_InconsistentModuleSettings

string

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

string

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

string

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

string

Foi encontrada uma política de firewall permitida (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

string

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

string

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

string

O módulo de borda é configurado para ser executado no modo privilegiado, com amplos recursos Linux ou com acesso à rede no nível do host (enviar/receber dados para a máquina host).
IoT_SharedCredentials

string

As mesmas credenciais de autenticação para o Hub IoT usadas por vários dispositivos. Isso pode indicar um dispositivo ilegítimo se passando por um dispositivo legítimo. Também expõe o risco de falsificação de identidade do dispositivo por parte de um atacante.
IoT_VulnerableTLSCipherSuite

string

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

SecuritySolutionStatus

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

Name Tipo Description
Disabled

string

Enabled

string

systemData

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

Name Tipo Description
createdAt

string

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

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

Estado de registo do endereço IP desmascarado

Name Tipo Description
Disabled

string

O registo de IP desmascarado está desativado
Enabled

string

O registo de IP não mascarado está ativado

UserDefinedResourcesProperties

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

Name 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[]

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