SystemDataDefinitionsCommonTypes

Category

ARM Error

Applies to

ARM OpenAPI(swagger) specs

Related ARM guideline code

• RPC-SystemData-V1-01
• RPC-SystemData-V1-02

Description

System data references must utilize common types.

How to fix the violation

Ensure that references to system data use the common types definition for system data. Common-types system data is defined in types.json here.

Invalid example

"Resource": {
  "properties": {
    "systemData": {
      "$ref": "../not/common/types",
    },
  }
}

Valid example

"Resource": {
  "properties": {
    "systemData": {
      "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
    },
  }
}