Device Security Groups - List
이 메서드를 사용하여 지정된 IoT Hub 리소스에 대한 디바이스 보안 그룹 목록을 가져옵니다.
GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups?api-version=2019-08-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
리소스의 식별자입니다. |
api-version
|
query | True |
string |
작업에 대한 API 버전 |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
그래 |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | 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
샘플 응답
{
"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": []
}
}
]
}
정의
Name | Description |
---|---|
Allowlist |
값(사용자 지정 경고 유형에 따라 다름)이 허용되는지 확인하는 사용자 지정 경고 규칙입니다. |
Cloud |
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다. |
Cloud |
오류 세부 정보입니다. |
Denylist |
값(사용자 지정 경고 유형에 따라 다름)이 거부되었는지 확인하는 사용자 지정 경고 규칙입니다. |
Device |
디바이스 보안 그룹 리소스 |
Device |
디바이스 보안 그룹 목록 |
Error |
리소스 관리 오류 추가 정보입니다. |
Threshold |
값(사용자 지정 경고 유형에 따라 다름)이 지정된 범위 내에 있는지 확인하는 사용자 지정 경고 규칙입니다. |
Time |
시간 창의 활동 수(사용자 지정 경고 유형에 따라 다름)가 지정된 범위 내에 있는지 확인하는 사용자 지정 경고 규칙입니다. |
value |
목록에 있는 항목의 값 형식입니다. |
AllowlistCustomAlertRule
값(사용자 지정 경고 유형에 따라 다름)이 허용되는지 확인하는 사용자 지정 경고 규칙입니다.
Name | 형식 | Description |
---|---|---|
allowlistValues |
string[] |
허용할 값입니다. 값의 형식은 규칙 형식에 따라 달라집니다. |
description |
string |
사용자 지정 경고에 대한 설명입니다. |
displayName |
string |
사용자 지정 경고의 표시 이름입니다. |
isEnabled |
boolean |
사용자 지정 경고의 상태입니다. |
ruleType |
string |
사용자 지정 경고 규칙의 형식입니다. |
valueType |
목록에 있는 항목의 값 형식입니다. |
CloudError
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.
Name | 형식 | Description |
---|---|---|
error.additionalInfo |
오류 추가 정보입니다. |
|
error.code |
string |
오류 코드입니다. |
error.details |
오류 세부 정보입니다. |
|
error.message |
string |
오류 메시지입니다. |
error.target |
string |
오류 대상입니다. |
CloudErrorBody
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
additionalInfo |
오류 추가 정보입니다. |
|
code |
string |
오류 코드입니다. |
details |
오류 세부 정보입니다. |
|
message |
string |
오류 메시지입니다. |
target |
string |
오류 대상입니다. |
DenylistCustomAlertRule
값(사용자 지정 경고 유형에 따라 다름)이 거부되었는지 확인하는 사용자 지정 경고 규칙입니다.
Name | 형식 | Description |
---|---|---|
denylistValues |
string[] |
거부할 값입니다. 값의 형식은 규칙 형식에 따라 달라집니다. |
description |
string |
사용자 지정 경고에 대한 설명입니다. |
displayName |
string |
사용자 지정 경고의 표시 이름입니다. |
isEnabled |
boolean |
사용자 지정 경고의 상태입니다. |
ruleType |
string |
사용자 지정 경고 규칙의 형식입니다. |
valueType |
목록에 있는 항목의 값 형식입니다. |
DeviceSecurityGroup
디바이스 보안 그룹 리소스
Name | 형식 | Description |
---|---|---|
id |
string |
리소스 ID |
name |
string |
리소스 이름 |
properties.allowlistRules |
허용 목록 사용자 지정 경고 규칙입니다. |
|
properties.denylistRules |
거부 목록 사용자 지정 경고 규칙입니다. |
|
properties.thresholdRules |
사용자 지정 경고 임계값 규칙 목록입니다. |
|
properties.timeWindowRules |
사용자 지정 경고 기간 규칙 목록입니다. |
|
type |
string |
리소스 종류 |
DeviceSecurityGroupList
디바이스 보안 그룹 목록
Name | 형식 | Description |
---|---|---|
nextLink |
string |
다음 페이지를 가져올 URI입니다. |
value |
디바이스 보안 그룹 개체 목록 |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
Name | 형식 | Description |
---|---|---|
info |
object |
추가 정보입니다. |
type |
string |
추가 정보 유형입니다. |
ThresholdCustomAlertRule
값(사용자 지정 경고 유형에 따라 다름)이 지정된 범위 내에 있는지 확인하는 사용자 지정 경고 규칙입니다.
Name | 형식 | Description |
---|---|---|
description |
string |
사용자 지정 경고에 대한 설명입니다. |
displayName |
string |
사용자 지정 경고의 표시 이름입니다. |
isEnabled |
boolean |
사용자 지정 경고의 상태입니다. |
maxThreshold |
integer |
최대 임계값입니다. |
minThreshold |
integer |
최소 임계값입니다. |
ruleType |
string |
사용자 지정 경고 규칙의 형식입니다. |
TimeWindowCustomAlertRule
시간 창의 활동 수(사용자 지정 경고 유형에 따라 다름)가 지정된 범위 내에 있는지 확인하는 사용자 지정 경고 규칙입니다.
Name | 형식 | Description |
---|---|---|
description |
string |
사용자 지정 경고에 대한 설명입니다. |
displayName |
string |
사용자 지정 경고의 표시 이름입니다. |
isEnabled |
boolean |
사용자 지정 경고의 상태입니다. |
maxThreshold |
integer |
최대 임계값입니다. |
minThreshold |
integer |
최소 임계값입니다. |
ruleType |
string |
사용자 지정 경고 규칙의 형식입니다. |
timeWindowSize |
string |
iso8601 형식의 시간 창 크기입니다. |
valueType
목록에 있는 항목의 값 형식입니다.
Name | 형식 | Description |
---|---|---|
IpCidr |
string |
CIDR 형식의 IP 범위(예: '192.168.0.1/8')입니다. |
String |
string |
모든 문자열 값입니다. |