Udostępnij za pośrednictwem


Iot Security Solution - Create Or Update

Użyj tej metody, aby utworzyć lub zaktualizować rozwiązanie IoT Security

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów w ramach subskrypcji użytkownika. Nazwa jest niewrażliwa na wielkość liter.

Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$

solutionName
path True

string

Nazwa rozwiązania IoT Security.

subscriptionId
path True

string

Identyfikator subskrypcji platformy Azure

Wzorzec wyrażenia regularnego: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

Wersja interfejsu API dla operacji

Treść żądania

Nazwa Wymagane Typ Opis
properties.displayName True

string

Nazwa wyświetlana zasobu.

properties.iotHubs True

string[]

Identyfikatory zasobów usługi IoT Hub

location

string

Lokalizacja zasobu.

properties.additionalWorkspaces

AdditionalWorkspacesProperties[]

Lista dodatkowych obszarów roboczych

properties.disabledDataSources

DataSource[]

Wyłączone źródła danych. Wyłączenie tych źródeł danych narusza bezpieczeństwo systemu.

properties.export

ExportData[]

Lista dodatkowych opcji eksportowania do danych obszaru roboczego.

properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

Lista stanu konfiguracji dla każdego typu zalecenia.

properties.status

SecuritySolutionStatus

Stan rozwiązania IoT Security.

properties.unmaskedIpLoggingStatus

UnmaskedIpLoggingStatus

Stan rejestrowania niezamaskowanego adresu IP

properties.userDefinedResources

UserDefinedResourcesProperties

Właściwości zasobów zdefiniowanych przez użytkownika rozwiązania IoT Security.

properties.workspace

string

Identyfikator zasobu obszaru roboczego

tags

object

Tagi zasobów

Odpowiedzi

Nazwa Typ Opis
200 OK

IoTSecuritySolutionModel

Aktualizowano

201 Created

IoTSecuritySolutionModel

Utworzono

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create or update a IoT security solution

Przykładowe żądanie

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"
  }
}

Przykładowa odpowiedź

{
  "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"
  }
}
{
  "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"
  }
}

Definicje

Nazwa Opis
AdditionalWorkspaceDataType

Lista typów danych wysyłanych do obszaru roboczego

AdditionalWorkspacesProperties

Właściwości dodatkowych obszarów roboczych.

AdditionalWorkspaceType

Typ obszaru roboczego.

CloudError

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

CloudErrorBody

Szczegóły błędu.

createdByType

Typ tożsamości, która utworzyła zasób.

DataSource

Wyłączone źródła danych. Wyłączenie tych źródeł danych narusza bezpieczeństwo systemu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ExportData

Lista dodatkowych opcji eksportowania do danych obszaru roboczego.

IoTSecuritySolutionModel

Informacje o konfiguracji i zasobach rozwiązania IoT Security.

RecommendationConfigStatus

Stan rekomendacji. Jeśli stan rekomendacji jest wyłączony, rekomendacje nie są generowane.

RecommendationConfigurationProperties

Typ zalecenia dotyczącego zabezpieczeń IoT.

RecommendationType

Typ zalecenia dotyczącego zabezpieczeń IoT.

SecuritySolutionStatus

Stan rozwiązania IoT Security.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UnmaskedIpLoggingStatus

Stan rejestrowania niezamaskowanego adresu IP

UserDefinedResourcesProperties

Właściwości zasobów zdefiniowanych przez użytkownika rozwiązania IoT Security.

AdditionalWorkspaceDataType

Lista typów danych wysyłanych do obszaru roboczego

Nazwa Typ Opis
Alerts

string

RawEvents

string

AdditionalWorkspacesProperties

Właściwości dodatkowych obszarów roboczych.

Nazwa Typ Domyślna wartość Opis
dataTypes

AdditionalWorkspaceDataType[]

Lista typów danych wysyłanych do obszaru roboczego

type

AdditionalWorkspaceType

Sentinel

Typ obszaru roboczego.

workspace

string

Identyfikator zasobu obszaru roboczego

AdditionalWorkspaceType

Typ obszaru roboczego.

Nazwa Typ Opis
Sentinel

string

CloudError

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa Typ Opis
error.additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

error.code

string

Kod błędu.

error.details

CloudErrorBody[]

Szczegóły błędu.

error.message

string

Komunikat o błędzie.

error.target

string

Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

CloudErrorBody[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DataSource

Wyłączone źródła danych. Wyłączenie tych źródeł danych narusza bezpieczeństwo systemu.

Nazwa Typ Opis
TwinData

string

Dane bliźniaczej reprezentacji urządzeń

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ExportData

Lista dodatkowych opcji eksportowania do danych obszaru roboczego.

Nazwa Typ Opis
RawEvents

string

Nieprzetworzone zdarzenia agenta

IoTSecuritySolutionModel

Informacje o konfiguracji i zasobach rozwiązania IoT Security.

Nazwa Typ Domyślna wartość Opis
id

string

Identyfikator zasobu

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu

properties.additionalWorkspaces

AdditionalWorkspacesProperties[]

Lista dodatkowych obszarów roboczych

properties.autoDiscoveredResources

string[]

Lista zasobów, które zostały automatycznie odnalezione jako istotne dla rozwiązania zabezpieczeń.

properties.disabledDataSources

DataSource[]

Wyłączone źródła danych. Wyłączenie tych źródeł danych narusza bezpieczeństwo systemu.

properties.displayName

string

Nazwa wyświetlana zasobu.

properties.export

ExportData[]

Lista dodatkowych opcji eksportowania do danych obszaru roboczego.

properties.iotHubs

string[]

Identyfikatory zasobów usługi IoT Hub

properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

Lista stanu konfiguracji dla każdego typu zalecenia.

properties.status

SecuritySolutionStatus

Enabled

Stan rozwiązania IoT Security.

properties.unmaskedIpLoggingStatus

UnmaskedIpLoggingStatus

Disabled

Stan rejestrowania niezamaskowanego adresu IP

properties.userDefinedResources

UserDefinedResourcesProperties

Właściwości zasobów zdefiniowanych przez użytkownika rozwiązania IoT Security.

properties.workspace

string

Identyfikator zasobu obszaru roboczego

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów

type

string

Typ zasobu

RecommendationConfigStatus

Stan rekomendacji. Jeśli stan rekomendacji jest wyłączony, rekomendacje nie są generowane.

Nazwa Typ Opis
Disabled

string

Enabled

string

RecommendationConfigurationProperties

Typ zalecenia dotyczącego zabezpieczeń IoT.

Nazwa Typ Domyślna wartość Opis
name

string

recommendationType

RecommendationType

Typ zalecenia dotyczącego zabezpieczeń IoT.

status

RecommendationConfigStatus

Enabled

Stan rekomendacji. Jeśli stan rekomendacji jest wyłączony, rekomendacje nie są generowane.

RecommendationType

Typ zalecenia dotyczącego zabezpieczeń IoT.

Nazwa Typ Opis
IoT_ACRAuthentication

string

Schemat uwierzytelniania używany do ściągania modułu brzegowego z repozytorium usługi ACR nie używa uwierzytelniania jednostki usługi.

IoT_AgentSendsUnutilizedMessages

string

Pojemność rozmiaru komunikatów agenta IoT jest obecnie niedostatecznie wykorzystywana, co powoduje wzrost liczby wysłanych komunikatów. Dostosuj interwały komunikatów w celu lepszego wykorzystania.

IoT_Baseline

string

Zidentyfikowano problemy z konfiguracją systemu związane z zabezpieczeniami.

IoT_EdgeHubMemOptimize

string

Użycie pamięci w usłudze Edge Hub można zoptymalizować, wyłączając głowice protokołów dla żadnych protokołów, które nie są używane przez moduły usługi Edge w rozwiązaniu.

IoT_EdgeLoggingOptions

string

Rejestrowanie jest wyłączone dla tego modułu brzegowego.

IoT_IPFilter_DenyAll

string

Konfiguracja filtru adresów IP powinna mieć reguły zdefiniowane dla dozwolonego ruchu i powinny domyślnie blokować cały inny ruch.

IoT_IPFilter_PermissiveRule

string

Zakres źródłowych adresów IP reguł filtrowania adresów IP dozwolonych jest zbyt duży. Nadmiernie permissive reguły mogą ujawnić centrum IoT do złośliwych intencji.

IoT_InconsistentModuleSettings

string

Mniejszość w grupie zabezpieczeń urządzeń ma niespójne ustawienia modułu usługi Edge z resztą grupy.

IoT_InstallAgent

string

Zainstaluj agenta zabezpieczeń rzeczy platformy Azure.

IoT_OpenPorts

string

Na urządzeniu znaleziono punkt końcowy nasłuchiwania.

IoT_PermissiveFirewallPolicy

string

Znaleziono dozwolone zasady zapory (DANE WEJŚCIOWE/WYJŚCIOWE). Zasady powinny domyślnie odrzucać cały ruch i definiować reguły zezwalania na niezbędną komunikację z/z urządzenia.

IoT_PermissiveInputFirewallRules

string

Znaleziono regułę w zaporze, która zawiera wzorzec permissywny dla szerokiego zakresu adresów IP lub portów.

IoT_PermissiveOutputFirewallRules

string

Znaleziono regułę w zaporze, która zawiera wzorzec permissywny dla szerokiego zakresu adresów IP lub portów.

IoT_PrivilegedDockerOptions

string

Moduł edge jest skonfigurowany do uruchamiania w trybie uprzywilejowanym z rozbudowanymi funkcjami systemu Linux lub dostępem do sieci na poziomie hosta (wysyłanie/odbieranie danych do maszyny hosta).

IoT_SharedCredentials

string

Te same poświadczenia uwierzytelniania do usługi IoT Hub używanej przez wiele urządzeń. Może to wskazywać na bezprawne personifikowanie wiarygodnego urządzenia. Naraża również ryzyko personifikacji urządzenia przez osobę atakującą.

IoT_VulnerableTLSCipherSuite

string

Wykryto niezabezpieczone konfiguracje protokołu TLS. Zalecane jest natychmiastowe uaktualnienie.

SecuritySolutionStatus

Stan rozwiązania IoT Security.

Nazwa Typ Opis
Disabled

string

Enabled

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UnmaskedIpLoggingStatus

Stan rejestrowania niezamaskowanego adresu IP

Nazwa Typ Opis
Disabled

string

Rejestrowanie niezamaskowanych adresów IP jest wyłączone

Enabled

string

Rejestrowanie niezamaskowanych adresów IP jest włączone

UserDefinedResourcesProperties

Właściwości zasobów zdefiniowanych przez użytkownika rozwiązania IoT Security.

Nazwa Typ Opis
query

string

Zapytanie usługi Azure Resource Graph reprezentujące zasoby zdefiniowane przez użytkownika rozwiązania zabezpieczeń. Wymagane do rozpoczęcia od ciągu "where != "Microsoft.Devices/IotHubs""

querySubscriptions

string[]

Lista identyfikatorów subskrypcji platformy Azure, dla których należy wykonać zapytanie dotyczące zasobów zdefiniowanych przez użytkownika.