Error
Schema Definition
This is the schema definition for the Error resource.Properties
| Property | Type | Nullable | Required | Permission | Description |
|---|---|---|---|---|---|
| error { | Object | read-only | The object containing the error information. | ||
| @Message.ExtendedInfo [ { | Array[Object] | read-only | An array of message objects describing one or more error message(s). | ||
| Message | String | Yes | read-only | This is the human readable message, if provided. | |
| MessageArgs [ ] | Array[String] | read-only | This array of message arguments are substituted for the arguments in the message when looked up in the message registry. | ||
| MessageArgs@odata.count | Int32 | read-only | The number of items in a collection. | ||
| MessageId | String | GET | read-only | This is the key for this message which can be used to look up the message in a message registry. | |
| RelatedProperties [ ] | Array[String] | read-only | This is an array of properties described by the message. | ||
| RelatedProperties@odata.count | Int32 | read-only | The number of items in a collection. | ||
| Resolution | String | Yes | read-only | Used to provide suggestions on how to resolve the situation that caused the error. | |
| Severity | String | Yes | read-only | This is the severity of the errors. | |
| } ] | |||||
| @Message.ExtendedInfo@odata.count | Int32 | read-only | The number of items in a collection. | ||
| code | String | read-only | A string indicating a specific MessageId from the message registry. 'Base.1.0.GeneralError' should be used only if there is no better message. | ||
| message | String | read-only | A human readable error message corresponding to the message in the message registry. | ||
| } |
Response
{
"error": {
"@Message.ExtendedInfo": [{
"Message": "String",
"MessageArgs": [ "String" ],
"MessageArgs@odata.count": 1,
"MessageId": "String",
"RelatedProperties": [ "String" ],
"RelatedProperties@odata.count": 1,
"Resolution": "String",
"Severity": "String"
}]
"@Message.ExtendedInfo@odata.count": 1,
"code": "String",
"message": "String"
}
}
"error": {
"@Message.ExtendedInfo": [{
"Message": "String",
"MessageArgs": [ "String" ],
"MessageArgs@odata.count": 1,
"MessageId": "String",
"RelatedProperties": [ "String" ],
"RelatedProperties@odata.count": 1,
"Resolution": "String",
"Severity": "String"
}]
"@Message.ExtendedInfo@odata.count": 1,
"code": "String",
"message": "String"
}
}