共用方式為

Device Security Groups - List

  • 參考
服務:
Defender for Cloud
API 版本:
2019-08-01

使用此方法可取得指定IoT中樞資源的裝置安全組清單。

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

URI 參數

名稱 位於 必要 類型 Description
resourceId
 path True

string

資源的標識碼。
api-version
 query True

string

作業的 API 版本

回應

名稱 類型 Description
200 OK

DeviceSecurityGroupList

還行
Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

List all device security groups for the specified IoT Hub resource

範例要求

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

範例回覆

狀態碼:
200 
{
  "value": [
    {
      "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": []
      }
    }
  ]
}

定義

名稱 Description
AllowlistCustomAlertRule

自定義警示規則，會檢查是否允許值 （取決於自定義警示類型）。
CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。
CloudErrorBody

錯誤詳細數據。
DenylistCustomAlertRule

自定義警示規則，會檢查值是否遭到拒絕（取決於自定義警示類型）。
DeviceSecurityGroup

裝置安全組資源
DeviceSecurityGroupList

裝置安全組清單
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ThresholdCustomAlertRule

自定義警示規則，會檢查值 （取決於自定義警示類型） 是否在指定的範圍內。
TimeWindowCustomAlertRule

自定義警示規則，會檢查時間範圍內的活動數目（取決於自定義警示類型）。
valueType

清單中的項目實值型別。

AllowlistCustomAlertRule

自定義警示規則，會檢查是否允許值 （取決於自定義警示類型）。

名稱 類型 Description
allowlistValues

string[]

要允許的值。 值的格式取決於規則類型。
description

string

自訂警示的描述。
displayName

string

自訂警示的顯示名稱。
isEnabled

boolean

自訂警示的狀態。
ruleType

string

自訂警示規則的類型。
valueType

valueType

清單中的項目實值型別。

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。

名稱 類型 Description
error.additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
error.code

string

錯誤碼。
error.details

CloudErrorBody[]

錯誤詳細數據。
error.message

string

錯誤訊息。
error.target

string

錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

CloudErrorBody[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

DenylistCustomAlertRule

自定義警示規則，會檢查值是否遭到拒絕（取決於自定義警示類型）。

名稱 類型 Description
denylistValues

string[]

要拒絕的值。 值的格式取決於規則類型。
description

string

自訂警示的描述。
displayName

string

自訂警示的顯示名稱。
isEnabled

boolean

自訂警示的狀態。
ruleType

string

自訂警示規則的類型。
valueType

valueType

清單中的項目實值型別。

DeviceSecurityGroup

裝置安全組資源

名稱 類型 Description
id

string

資源標識碼
name

string

資源名稱
properties.allowlistRules

AllowlistCustomAlertRule[]

允許清單自定義警示規則。
properties.denylistRules

DenylistCustomAlertRule[]

拒絕清單自定義警示規則。
properties.thresholdRules

ThresholdCustomAlertRule[]

自訂警示閾值規則的清單。
properties.timeWindowRules

TimeWindowCustomAlertRule[]

自訂警示時間範圍規則的清單。
type

string

資源類型

DeviceSecurityGroupList

裝置安全組清單

名稱 類型 Description
nextLink

string

要擷取下一頁的 URI。
value

DeviceSecurityGroup[]

裝置安全組物件清單

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ThresholdCustomAlertRule

自定義警示規則，會檢查值 （取決於自定義警示類型） 是否在指定的範圍內。

名稱 類型 Description
description

string

自訂警示的描述。
displayName

string

自訂警示的顯示名稱。
isEnabled

boolean

自訂警示的狀態。
maxThreshold

integer

最大臨界值。
minThreshold

integer

最小臨界值。
ruleType

string

自訂警示規則的類型。

TimeWindowCustomAlertRule

自定義警示規則，會檢查時間範圍內的活動數目（取決於自定義警示類型）。

名稱 類型 Description
description

string

自訂警示的描述。
displayName

string

自訂警示的顯示名稱。
isEnabled

boolean

自訂警示的狀態。
maxThreshold

integer

最大臨界值。
minThreshold

integer

最小臨界值。
ruleType

string

自訂警示規則的類型。
timeWindowSize

string

iso8601 格式的時間範圍大小。

valueType

清單中的項目實值型別。

名稱 類型 Description
IpCidr

string

CIDR 格式的IP範圍（例如 '192.168.0.1/8'）。
String

string

任何字串值。