Iot Security Solution - Get

Använd den här metoden för att få information om en specifik IoT-säkerhetslösning baserat på lösningens namn

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.

Regex pattern: ^[-\w\._\(\)]+$

solutionName
path True

string

Namnet på IoT-säkerhetslösningen.

subscriptionId
path True

string

Azure-prenumerations-ID

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

api-version
query True

string

API-version för åtgärden

Svar

Name Typ Description
200 OK

IoTSecuritySolutionModel

OK

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Get a IoT security solution

Sample Request

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

Sample Response

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/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"
  }
}

Definitioner

Name Description
AdditionalWorkspaceDataType

Lista över datatyper som skickas till arbetsytan

AdditionalWorkspacesProperties

Egenskaper för de ytterligare arbetsytorna.

AdditionalWorkspaceType

Typ av arbetsyta.

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

CloudErrorBody

Felinformationen.

createdByType

Den typ av identitet som skapade resursen.

DataSource

Inaktiverade datakällor. Om du inaktiverar dessa datakällor komprometteras systemet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ExportData

Lista över ytterligare alternativ för att exportera till arbetsytedata.

IoTSecuritySolutionModel

Konfiguration av IoT-säkerhetslösning och resursinformation.

RecommendationConfigStatus

Rekommendationsstatus. När rekommendationens status är inaktiverad genereras inte rekommendationer.

RecommendationConfigurationProperties

Typ av rekommendation för IoT-säkerhet.

RecommendationType

Typ av rekommendation för IoT-säkerhet.

SecuritySolutionStatus

Status för IoT-säkerhetslösningen.

systemData

Metadata som rör skapande och senaste ändring av resursen.

UnmaskedIpLoggingStatus

Avmaskerad ip-adressloggningsstatus

UserDefinedResourcesProperties

Egenskaper för IoT-säkerhetslösningens användardefinierade resurser.

AdditionalWorkspaceDataType

Lista över datatyper som skickas till arbetsytan

Name Typ Description
Alerts

string

RawEvents

string

AdditionalWorkspacesProperties

Egenskaper för de ytterligare arbetsytorna.

Name Typ Standardvärde Description
dataTypes

AdditionalWorkspaceDataType[]

Lista över datatyper som skickas till arbetsytan

type

AdditionalWorkspaceType

Sentinel

Typ av arbetsyta.

workspace

string

Resurs-ID för arbetsyta

AdditionalWorkspaceType

Typ av arbetsyta.

Name Typ Description
Sentinel

string

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

Name Typ Description
error.additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

error.code

string

Felkoden.

error.details

CloudErrorBody[]

Felinformationen.

error.message

string

Felmeddelandet.

error.target

string

Felmålet.

CloudErrorBody

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

CloudErrorBody[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataSource

Inaktiverade datakällor. Om du inaktiverar dessa datakällor komprometteras systemet.

Name Typ Description
TwinData

string

Enhetstvillingdata

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ExportData

Lista över ytterligare alternativ för att exportera till arbetsytedata.

Name Typ Description
RawEvents

string

Rådatahändelser för agent

IoTSecuritySolutionModel

Konfiguration av IoT-säkerhetslösning och resursinformation.

Name Typ Standardvärde Description
id

string

Resurs-ID

location

string

Resursplatsen.

name

string

Resursnamn

properties.additionalWorkspaces

AdditionalWorkspacesProperties[]

Lista över ytterligare arbetsytor

properties.autoDiscoveredResources

string[]

Lista över resurser som automatiskt identifierades som relevanta för säkerhetslösningen.

properties.disabledDataSources

DataSource[]

Inaktiverade datakällor. Om du inaktiverar dessa datakällor komprometteras systemet.

properties.displayName

string

Resursens visningsnamn.

properties.export

ExportData[]

Lista över ytterligare alternativ för att exportera till arbetsytedata.

properties.iotHubs

string[]

IoT Hub resurs-ID:t

properties.recommendationsConfiguration

RecommendationConfigurationProperties[]

Lista över konfigurationsstatus för varje rekommendationstyp.

properties.status

SecuritySolutionStatus

Enabled

Status för IoT-säkerhetslösningen.

properties.unmaskedIpLoggingStatus

UnmaskedIpLoggingStatus

Disabled

Avmaskerad ip-adressloggningsstatus

properties.userDefinedResources

UserDefinedResourcesProperties

Egenskaper för IoT-säkerhetslösningens användardefinierade resurser.

properties.workspace

string

Resurs-ID för arbetsyta

systemData

systemData

Azure Resource Manager metadata som innehåller createdBy och modifiedBy-information.

tags

object

Resurstaggar

type

string

Resurstyp

RecommendationConfigStatus

Rekommendationsstatus. När rekommendationens status är inaktiverad genereras inte rekommendationer.

Name Typ Description
Disabled

string

Enabled

string

RecommendationConfigurationProperties

Typ av rekommendation för IoT-säkerhet.

Name Typ Standardvärde Description
name

string

recommendationType

RecommendationType

Typ av rekommendation för IoT-säkerhet.

status

RecommendationConfigStatus

Enabled

Rekommendationsstatus. När rekommendationens status är inaktiverad genereras inte rekommendationer.

RecommendationType

Typ av rekommendation för IoT-säkerhet.

Name Typ Description
IoT_ACRAuthentication

string

Autentiseringsschemat som används för att hämta en edge-modul från en ACR-lagringsplats använder inte autentisering med tjänstens huvudnamn.

IoT_AgentSendsUnutilizedMessages

string

IoT-agentens meddelandestorlekskapacitet är för närvarande underutnyttad, vilket orsakar en ökning av antalet skickade meddelanden. Justera meddelandeintervallen för bättre användning.

IoT_Baseline

string

Identifierade säkerhetsrelaterade systemkonfigurationsproblem.

IoT_EdgeHubMemOptimize

string

Du kan optimera minnesanvändningen i Edge Hub genom att stänga av protokollhuvuden för protokoll som inte används av Edge-moduler i din lösning.

IoT_EdgeLoggingOptions

string

Loggning är inaktiverat för den här edge-modulen.

IoT_IPFilter_DenyAll

string

IP-filterkonfigurationen bör ha regler som definierats för tillåten trafik och ska neka all annan trafik som standard.

IoT_IPFilter_PermissiveRule

string

Källans IP-intervall för tillåtna IP-filterregler är för stort. Alltför tillåtande regler kan göra din IoT-hubb tillgänglig för illvilliga användare.

IoT_InconsistentModuleSettings

string

En minoritet i en enhetssäkerhetsgrupp har inkonsekventa Edge-modulinställningar med resten av gruppen.

IoT_InstallAgent

string

Installera Azure Security of Things-agenten.

IoT_OpenPorts

string

En lyssnande slutpunkt hittades på enheten.

IoT_PermissiveFirewallPolicy

string

En tillåten brandväggsprincip hittades (INPUT/OUTPUT). Principen ska neka all trafik som standard och definiera regler för att tillåta nödvändig kommunikation till och från enheten.

IoT_PermissiveInputFirewallRules

string

En regel i brandväggen har hittats som innehåller ett tillåtande mönster för ett brett spektrum av IP-adresser eller portar.

IoT_PermissiveOutputFirewallRules

string

En regel i brandväggen har hittats som innehåller ett tillåtande mönster för ett brett spektrum av IP-adresser eller portar.

IoT_PrivilegedDockerOptions

string

Edge-modulen är konfigurerad för att köras i privilegierat läge, med omfattande Linux-funktioner eller med nätverksåtkomst på värdnivå (skicka/ta emot data till värddatorn).

IoT_SharedCredentials

string

Samma autentiseringsuppgifter för IoT Hub som används av flera enheter. Detta kan tyda på att en illegitim enhet utger sig för att vara en legitim enhet. Den exponerar också risken för enhetspersonifiering av en angripare.

IoT_VulnerableTLSCipherSuite

string

Osäkra TLS-konfigurationer har identifierats. Omedelbar uppgradering rekommenderas.

SecuritySolutionStatus

Status för IoT-säkerhetslösningen.

Name Typ Description
Disabled

string

Enabled

string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UnmaskedIpLoggingStatus

Avmaskerad ip-adressloggningsstatus

Name Typ Description
Disabled

string

Omaskerad IP-loggning är inaktiverad

Enabled

string

Omaskerad IP-loggning är aktiverad

UserDefinedResourcesProperties

Egenskaper för IoT-säkerhetslösningens användardefinierade resurser.

Name Typ Description
query

string

Azure Resource Graph fråga som representerar säkerhetslösningens användardefinierade resurser. Krävs för att börja med "where type != "Microsoft.Devices/IotHubs""

querySubscriptions

string[]

Lista över Azure-prenumerations-ID:t som frågan om användardefinierade resurser ska köras på.