Sdílet prostřednictvím

Device Security Groups - Get

  • Reference
Služba:
Defender for Cloud
Verze rozhraní API:
2019-08-01

Pomocí této metody získáte skupinu zabezpečení zařízení pro zadaný prostředek IoT Hubu.

GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName}?api-version=2019-08-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
deviceSecurityGroupName
 path True

string

Název skupiny zabezpečení zařízení. Všimněte si, že název skupiny zabezpečení zařízení nerozlišuje velká a malá písmena.
resourceId
 path True

string

Identifikátor prostředku.
api-version
 query True

string

Verze rozhraní API pro operaci

Odpovědi

Name Typ Description
200 OK

DeviceSecurityGroup

Úspěšná žádost o získání skupiny zabezpečení zařízení
Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get a device security group for the specified IoT Hub resource

Ukázkový požadavek

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup?api-version=2019-08-01

Ukázková odpověď

Stavový kód:
200 
{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup",
  "name": "samplesecuritygroup",
  "type": "Microsoft.Security/deviceSecurityGroups",
  "properties": {
    "thresholdRules": [],
    "timeWindowRules": [
      {
        "ruleType": "ActiveConnectionsNotInAllowedRange",
        "displayName": "Number of active connections is not in allowed range",
        "description": "Get an alert when the number of active connections of a device in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "AmqpC2DMessagesNotInAllowedRange",
        "displayName": "Number of cloud to device messages (AMQP protocol) is not in allowed range",
        "description": "Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "MqttC2DMessagesNotInAllowedRange",
        "displayName": "Number of cloud to device messages (MQTT protocol) is not in allowed range",
        "description": "Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "HttpC2DMessagesNotInAllowedRange",
        "displayName": "Number of cloud to device messages (HTTP protocol) is not in allowed range",
        "description": "Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "AmqpC2DRejectedMessagesNotInAllowedRange",
        "displayName": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range",
        "description": "Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "MqttC2DRejectedMessagesNotInAllowedRange",
        "displayName": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range",
        "description": "Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "HttpC2DRejectedMessagesNotInAllowedRange",
        "displayName": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range",
        "description": "Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "AmqpD2CMessagesNotInAllowedRange",
        "displayName": "Number of device to cloud messages (AMQP protocol) is not in allowed range",
        "description": "Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "MqttD2CMessagesNotInAllowedRange",
        "displayName": "Number of device to cloud messages (MQTT protocol) is not in allowed range",
        "description": "Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "HttpD2CMessagesNotInAllowedRange",
        "displayName": "Number of device to cloud messages (HTTP protocol) is not in allowed range",
        "description": "Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "DirectMethodInvokesNotInAllowedRange",
        "displayName": "Number of direct method invokes is not in allowed range",
        "description": "Get an alert when the number of direct method invokes in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "FailedLocalLoginsNotInAllowedRange",
        "displayName": "Number of failed local logins is not in allowed range",
        "description": "Get an alert when the number of failed local logins on the device in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "FileUploadsNotInAllowedRange",
        "displayName": "Number of file uploads is not in allowed range",
        "description": "Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "QueuePurgesNotInAllowedRange",
        "displayName": "Number of device queue purges is not in allowed range",
        "description": "Get an alert when the number of device queue purges in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "TwinUpdatesNotInAllowedRange",
        "displayName": "Number of twin updates is not in allowed range",
        "description": "Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      },
      {
        "ruleType": "UnauthorizedOperationsNotInAllowedRange",
        "displayName": "Number of unauthorized operations is not in allowed range",
        "description": "Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error",
        "isEnabled": false,
        "minThreshold": 0,
        "maxThreshold": 0,
        "timeWindowSize": "PT15M"
      }
    ],
    "allowlistRules": [
      {
        "ruleType": "ConnectionToIpNotAllowed",
        "displayName": "Outbound connection to an ip that isn't allowed",
        "description": "Get an alert when an outbound connection is created between your device and an ip that isn't allowed",
        "isEnabled": false,
        "valueType": "IpCidr",
        "allowlistValues": []
      },
      {
        "ruleType": "LocalUserNotAllowed",
        "displayName": "Login by a local user that isn't allowed",
        "description": "Get an alert when a local user that isn't allowed logins to the device",
        "isEnabled": false,
        "valueType": "String",
        "allowlistValues": []
      },
      {
        "ruleType": "ProcessNotAllowed",
        "displayName": "Execution of a process that isn't allowed",
        "description": "Get an alert when a process that isn't allowed is executed",
        "isEnabled": false,
        "valueType": "String",
        "allowlistValues": []
      }
    ],
    "denylistRules": []
  }
}

Definice

Name Description
AllowlistCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je povolená hodnota (závisí na vlastním typu upozornění).
CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody

Podrobnosti o chybě.
DenylistCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je hodnota (závisí na typu vlastní výstrahy) odepřena.
DeviceSecurityGroup

Prostředek skupiny zabezpečení zařízení
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ThresholdCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je hodnota (závisí na typu vlastní výstrahy) v daném rozsahu.
TimeWindowCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je počet aktivit (závisí na vlastním typu upozornění) v časovém intervalu v daném rozsahu.
valueType

Typ hodnoty položek v seznamu.

AllowlistCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je povolená hodnota (závisí na vlastním typu upozornění).

Name Typ Description
allowlistValues

string[]

Hodnoty, které chcete povolit. Formát hodnot závisí na typu pravidla.
description

string

Popis vlastní výstrahy
displayName

string

Zobrazovaný název vlastní výstrahy
isEnabled

boolean

Stav vlastní výstrahy
ruleType

string

Typ vlastního pravidla upozornění.
valueType

valueType

Typ hodnoty položek v seznamu.

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name Typ Description
error.additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
error.code

string

Kód chyby.
error.details

CloudErrorBody[]

Podrobnosti o chybě.
error.message

string

Chybová zpráva.
error.target

string

Cíl chyby.

CloudErrorBody

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

CloudErrorBody[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

DenylistCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je hodnota (závisí na typu vlastní výstrahy) odepřena.

Name Typ Description
denylistValues

string[]

Hodnoty, které se mají odepřít. Formát hodnot závisí na typu pravidla.
description

string

Popis vlastní výstrahy
displayName

string

Zobrazovaný název vlastní výstrahy
isEnabled

boolean

Stav vlastní výstrahy
ruleType

string

Typ vlastního pravidla upozornění.
valueType

valueType

Typ hodnoty položek v seznamu.

DeviceSecurityGroup

Prostředek skupiny zabezpečení zařízení

Name Typ Description
id

string

ID prostředku
name

string

Název prostředku
properties.allowlistRules

AllowlistCustomAlertRule[]

Vlastní pravidla upozornění seznamu povolených položek.
properties.denylistRules

DenylistCustomAlertRule[]

Vlastní pravidla upozornění seznamu zamítnutí.
properties.thresholdRules

ThresholdCustomAlertRule[]

Seznam vlastních pravidel prahových hodnot upozornění
properties.timeWindowRules

TimeWindowCustomAlertRule[]

Seznam vlastních pravidel časových intervalů upozornění
type

string

Typ prostředku

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ThresholdCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je hodnota (závisí na typu vlastní výstrahy) v daném rozsahu.

Name Typ Description
description

string

Popis vlastní výstrahy
displayName

string

Zobrazovaný název vlastní výstrahy
isEnabled

boolean

Stav vlastní výstrahy
maxThreshold

integer

Maximální prahová hodnota.
minThreshold

integer

Minimální prahová hodnota.
ruleType

string

Typ vlastního pravidla upozornění.

TimeWindowCustomAlertRule

Vlastní pravidlo upozornění, které kontroluje, jestli je počet aktivit (závisí na vlastním typu upozornění) v časovém intervalu v daném rozsahu.

Name Typ Description
description

string

Popis vlastní výstrahy
displayName

string

Zobrazovaný název vlastní výstrahy
isEnabled

boolean

Stav vlastní výstrahy
maxThreshold

integer

Maximální prahová hodnota.
minThreshold

integer

Minimální prahová hodnota.
ruleType

string

Typ vlastního pravidla upozornění.
timeWindowSize

string

Velikost časového intervalu ve formátu iso8601.

valueType

Typ hodnoty položek v seznamu.

Name Typ Description
IpCidr

string

Rozsah IP adres ve formátu CIDR (např. 192.168.0.1/8).
String

string

Libovolná řetězcová hodnota