-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added Nic entity type and IoT Device properties to EntityTypes.json #19391
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -291,7 +291,8 @@ | |
"Mailbox", | ||
"MailCluster", | ||
"MailMessage", | ||
"SubmissionMail" | ||
"SubmissionMail", | ||
"Nic" | ||
], | ||
"type": "string", | ||
"x-ms-enum": { | ||
|
@@ -381,6 +382,10 @@ | |
{ | ||
"description": "Entity represents submission mail in the system.", | ||
"value": "SubmissionMail" | ||
}, | ||
{ | ||
"description": "Entity represents network interface in the system.", | ||
"value": "Nic" | ||
} | ||
] | ||
} | ||
|
@@ -408,7 +413,8 @@ | |
"MailCluster", | ||
"MailMessage", | ||
"Mailbox", | ||
"SubmissionMail" | ||
"SubmissionMail", | ||
"Nic" | ||
], | ||
"type": "string", | ||
"x-ms-enum": { | ||
|
@@ -498,6 +504,10 @@ | |
{ | ||
"description": "Entity represents submission mail in the system.", | ||
"value": "SubmissionMail" | ||
}, | ||
{ | ||
"description": "Entity represents network interface in the system.", | ||
"value": "Nic" | ||
} | ||
] | ||
} | ||
|
@@ -1000,6 +1010,96 @@ | |
"readOnly": true, | ||
"type": "array", | ||
"x-ms-identifiers": [] | ||
}, | ||
"owners": { | ||
"description": "A list of owners of the IoTDevice entity.", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"readOnly": true, | ||
"type": "array", | ||
"x-ms-identifiers": [] | ||
}, | ||
"nicEntityIds": { | ||
"description": "A list of Nic entity ids of the IoTDevice entity.", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"readOnly": true, | ||
"type": "array", | ||
"x-ms-identifiers": [] | ||
}, | ||
"site": { | ||
"description": "The site of the device", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"zone": { | ||
"description": "The zone location of the device within a site", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"sensor": { | ||
"description": "The sensor the device is monitored by", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"deviceSubType": { | ||
"description": "The subType of the device ('PLC', 'HMI', 'EWS', etc.)", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"importance": { | ||
"description": "Device importance, determines if the device classified as 'crown jewel'", | ||
"enum": [ | ||
"Unknown", | ||
"Low", | ||
"Normal", | ||
"High" | ||
], | ||
"type": "string", | ||
"x-ms-enum": { | ||
"modelAsString": true, | ||
"name": "DeviceImportance", | ||
"values": [ | ||
{ | ||
"description": "Unknown - Default value", | ||
"value": "Unknown" | ||
}, | ||
{ | ||
"description": "Low", | ||
"value": "Low" | ||
}, | ||
{ | ||
"description": "Normal", | ||
"value": "Normal" | ||
}, | ||
{ | ||
"description": "High", | ||
"value": "High" | ||
} | ||
] | ||
} | ||
}, | ||
"purdueLayer": { | ||
"description": "The Purdue Layer of the device", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"isAuthorized": { | ||
"description": "Determines whether the device classified as authorized device", | ||
"readOnly": true, | ||
"type": "boolean" | ||
}, | ||
"isProgramming": { | ||
"description": "Determines whether the device classified as programming device", | ||
"readOnly": true, | ||
"type": "boolean" | ||
}, | ||
"isScanner": { | ||
"description": "Is the device classified as a scanner device", | ||
"readOnly": true, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. consider upgrading to enum as explained here : https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html#common-issues-found-in-review Replace boolean/switch properties with better enum |
||
"type": "boolean" | ||
} | ||
}, | ||
"type": "object" | ||
|
@@ -2399,6 +2499,53 @@ | |
} | ||
}, | ||
"type": "object" | ||
}, | ||
"NicEntity": { | ||
"allOf": [ | ||
{ | ||
"$ref": "#/definitions/Entity" | ||
} | ||
], | ||
"description": "Represents an network interface entity.", | ||
"properties": { | ||
"properties": { | ||
"$ref": "#/definitions/NicEntityProperties", | ||
"description": "Network interface entity properties", | ||
"x-ms-client-flatten": true | ||
} | ||
}, | ||
"type": "object", | ||
"x-ms-discriminator-value": "Nic" | ||
}, | ||
"NicEntityProperties": { | ||
"allOf": [ | ||
{ | ||
"$ref": "#/definitions/EntityCommonProperties" | ||
} | ||
], | ||
"description": "Nic entity property bag.", | ||
"properties": { | ||
"macAddress": { | ||
"description": "The MAC address of this network interface", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"ipAddressEntityId": { | ||
"description": "The IP entity id of this network interface", | ||
"readOnly": true, | ||
"type": "string" | ||
}, | ||
"vlans": { | ||
"description": "A list of VLANs of the network interface entity.", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"readOnly": true, | ||
"type": "array", | ||
"x-ms-identifiers": [] | ||
} | ||
}, | ||
"type": "object" | ||
} | ||
}, | ||
"parameters": {} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
consider using enum if applicable