Review request v3 for Microsoft.Portal to onboard to TypeSpec #29796
Check `Breaking Change(Cross-Version)` succeeded
CrossVersionBreakingChange
View Azure DevOps build log for more details.
Important
To see the full list of breaking changes messages, with all the details available:
In the relevant ADO build (see the link above), find the job CrossVersionBreakingChange
, then the task within, also called CrossVersionBreakingChange
.
In the task's build log, search for Full list of messages
.
Details
Compared specs (v0.10.12) | new version | base version |
---|---|---|
portal.json | 2022-12-01-preview(c0a799d) | 2020-09-01-preview(main) |
The following breaking changes have been detected in comparison to the latest stable version
No breaking changes detected in this comparison.
The following breaking changes have been detected in comparison to the latest preview version
⚠️ 1009 - RemovedRequiredParameter
Displaying 2 out of 2 occurrences.
Index | Description |
---|---|
1 | The required parameter 'dashboard' was removed in the new version. Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L101:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].put.parameters[4] |
2 | The required parameter 'dashboard' was removed in the new version. Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L257:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].patch.parameters[4] |
⚠️ 1010 - AddingRequiredParameter
Displaying 2 out of 2 occurrences.
Index | Description |
---|---|
1 | The required parameter 'properties' was added in the new version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L515:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].patch.parameters[4] |
2 | The required parameter 'resource' was added in the new version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L453:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].put.parameters[4] |
⚠️ 1017 - ReferenceRedirection
Displaying 11 out of 11 occurrences.
Index | Description |
---|---|
1 | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L282:11 definitions.ErrorDetail.properties.details.items Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L733:11 |
2 | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L307:9 definitions.ErrorResponse.properties.error Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L709:9 |
3 | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L404:11 definitions.OperationListResult.properties.value.items Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L655:11 |
4 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L107:13 paths['/providers/Microsoft.Portal/operations'].get.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L63:13 |
5 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L630:9 definitions.Dashboard.properties.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L591:9 |
6 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L694:9 definitions.DashboardPartMetadata.properties.type Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L465:9 |
7 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L694:9 definitions.MarkdownPartMetadata.properties.type Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L465:9 |
8 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L725:9 definitions.DashboardParts.properties.position Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L411:9 |
9 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L827:9 definitions.MarkdownPartMetadata.properties.settings Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L490:9 |
10 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L843:9 definitions.MarkdownPartMetadataSettings.properties.content Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L494:13 |
11 | The '$ref' property points to different models in the old and new versions. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L853:9 definitions.MarkdownPartMetadataSettingsContent.properties.settings Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L498:17 |
⚠️ 1022 - RemovedAdditionalProperties
Displaying 6 out of 6 occurrences.
Index | Description |
---|---|
1 | The new version removes the 'additionalProperties' element. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L659:9 definitions.DashboardLens.properties.metadata Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L552:9 |
2 | The new version removes the 'additionalProperties' element. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L690:5 definitions.DashboardPartMetadata Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L457:5 |
3 | The new version removes the 'additionalProperties' element. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L729:9 definitions.DashboardParts.properties.metadata Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L450:9 |
4 | The new version removes the 'additionalProperties' element. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L762:9 definitions.DashboardPartsPosition.properties.metadata Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L441:13 |
5 | The new version removes the 'additionalProperties' element. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L786:9 definitions.DashboardProperties.properties.metadata Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L573:9 |
6 | The new version removes the 'additionalProperties' element. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L804:9 definitions.DashboardPropertiesWithProvisioningState.properties.metadata Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L573:9 |
⚠️ 1023 - TypeFormatChanged
Displaying 11 out of 11 occurrences.
Index | Description |
---|---|
1 | The new version has a different format '' than the previous one 'int32'. New: common-types/resource-management/v5/types.json#L264:9 definitions.ErrorDetail.properties.code Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L719:9 |
2 | The new version has a different format 'arm-id' than the previous one ''. New: common-types/resource-management/v5/types.json#L14:9 definitions.Dashboard.properties.id Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L596:9 |
3 | The new version has a different format 'uri' than the previous one ''. New: common-types/resource-management/v5/types.json#L413:9 definitions.OperationListResult.properties.nextLink Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L663:9 |
4 | The new version has a different format 'uri' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L680:9 definitions.DashboardListResult.properties.nextLink Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L397:9 |
5 | The new version has a different format 'uuid' than the previous one ''. New: common-types/resource-management/v5/types.json#L632:5 parameters.SubscriptionIdParameter Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L745:5 |
6 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L305:9 paths['/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards'].get.parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L355:9 |
7 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L344:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards'].get.parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L307:9 |
8 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L386:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].get.parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L195:9 |
9 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L433:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].put.parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L88:9 |
10 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L495:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].patch.parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L244:9 |
11 | The new version has a different format 'uuid' than the previous one ''. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L551:9 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].delete.parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L149:9 |
⚠️ 1025 - RequiredStatusChange
Displaying 1 out of 1 occurrences.
Index | Description |
---|---|
1 | The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L672:7 definitions.DashboardListResult.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L389:7 |
⚠️ 1026 - TypeChanged
Displaying 3 out of 3 occurrences.
Index | Description |
---|---|
1 | The new version has a different type 'boolean' than the previous one 'string'. New: common-types/resource-management/v5/types.json#L339:9 definitions.Operation.properties.isDataAction Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L678:9 |
2 | The new version has a different type 'object' than the previous one ''. New: common-types/resource-management/v5/types.json#L344:9 definitions.Operation.properties.display Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L682:9 |
3 | The new version has a different type 'string' than the previous one 'integer'. New: common-types/resource-management/v5/types.json#L264:9 definitions.ErrorDetail.properties.code Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L719:9 |
⚠️ 1029 - ReadonlyPropertyChanged
Displaying 10 out of 10 occurrences.
Index | Description |
---|---|
1 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L334:9 definitions.Operation.properties.name Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L674:9 |
2 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L339:9 definitions.Operation.properties.isDataAction Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L678:9 |
3 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L348:13 definitions.Operation.properties.display.properties.provider Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L685:13 |
4 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L353:13 definitions.Operation.properties.display.properties.resource Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L689:13 |
5 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L358:13 definitions.Operation.properties.display.properties.operation Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L693:13 |
6 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L363:13 definitions.Operation.properties.display.properties.description Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L697:13 |
7 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L402:9 definitions.OperationListResult.properties.value Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L653:9 |
8 | The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L413:9 definitions.OperationListResult.properties.nextLink Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L663:9 |
9 | The read only property has changed from 'true' to 'false'. New: common-types/resource-management/v5/types.json#L404:11 definitions.OperationListResult.properties.value.items Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L655:11 |
10 | The read only property has changed from 'true' to 'false'. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L107:13 paths['/providers/Microsoft.Portal/operations'].get.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L63:13 |
⚠️ 1032 - DifferentAllOf
Displaying 6 out of 6 occurrences.
Index | Description |
---|---|
1 | The new version has a different 'allOf' property than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L410:13 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].get.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L212:13 |
2 | The new version has a different 'allOf' property than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L466:13 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].put.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L120:13 |
3 | The new version has a different 'allOf' property than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L472:13 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].put.responses.201.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L114:13 |
4 | The new version has a different 'allOf' property than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L528:13 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].patch.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L270:13 |
5 | The new version has a different 'allOf' property than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L626:5 definitions.Dashboard Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L582:5 |
6 | The new version has a different 'allOf' property than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L676:11 definitions.DashboardListResult.properties.value.items Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L392:11 |
⚠️ 1034 - AddedRequiredProperty
Displaying 3 out of 3 occurrences.
Index | Description |
---|---|
1 | The new version lists new non-read-only properties as required: 'value'. These properties were not listed as required in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L316:13 paths['/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards'].get.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L366:13 |
2 | The new version lists new non-read-only properties as required: 'value'. These properties were not listed as required in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L358:13 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards'].get.responses.200.schema Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L321:13 |
3 | The new version lists new non-read-only properties as required: 'value'. These properties were not listed as required in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L669:5 definitions.DashboardListResult Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L387:5 |
⚠️ 1036 - ConstraintChanged
Displaying 4 out of 4 occurrences.
Index | Description |
---|---|
1 | The new version has a different 'pattern' value than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L396:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].get.parameters[3] Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L195:9 |
2 | The new version has a different 'pattern' value than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L443:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].put.parameters[3] Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L88:9 |
3 | The new version has a different 'pattern' value than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L505:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].patch.parameters[3] Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L244:9 |
4 | The new version has a different 'pattern' value than the previous one. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L561:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].delete.parameters[3] Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L149:9 |
⚠️ 1038 - AddedPath
Displaying 3 out of 3 occurrences.
Index | Description |
---|---|
1 | The new version is adding a path that was not found in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L128:5 paths['/providers/Microsoft.Portal/tenantConfigurations'] |
2 | The new version is adding a path that was not found in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L164:5 paths['/providers/Microsoft.Portal/tenantConfigurations/{configurationName}'] |
3 | The new version is adding a path that was not found in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L56:5 paths['/providers/Microsoft.Portal/listTenantConfigurationViolations'] |
⚠️ 1040 - AddedReadOnlyPropertyInResponse
Displaying 6 out of 6 occurrences.
Index | Description |
---|---|
1 | The new version has a new read-only property 'actionType' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L333:7 definitions.Operation.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L673:7 |
2 | The new version has a new read-only property 'additionalInfo' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L263:7 definitions.ErrorDetail.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L718:7 |
3 | The new version has a new read-only property 'origin' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L333:7 definitions.Operation.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L673:7 |
4 | The new version has a new read-only property 'provisioningState' in response that was not found in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L795:7 definitions.DashboardPropertiesWithProvisioningState.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L564:7 |
5 | The new version has a new read-only property 'systemData' in response that was not found in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L629:7 definitions.Dashboard.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L590:7 |
6 | The new version has a new read-only property 'target' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L263:7 definitions.ErrorDetail.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L718:7 |
⚠️ 1048 - AddedXmsEnum
Displaying 2 out of 2 occurrences.
Index | Description |
---|---|
1 | The new version adds a x-ms-enum extension. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L694:9 definitions.DashboardPartMetadata.properties.type Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L465:9 |
2 | The new version adds a x-ms-enum extension. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L694:9 definitions.MarkdownPartMetadata.properties.type Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L465:9 |
💬 1007 - RemovedClientParameter
Displaying 1 out of 1 occurrences.
Index | Description |
---|---|
1 | The new version is missing a client parameter that was found in the old version. Was 'DashboardNameParameter' removed or renamed? New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L998:3 parameters Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L744:3 |
💬 1012 - RemovedResponseCode
Displaying 2 out of 2 occurrences.
Index | Description |
---|---|
1 | The new version removes the response code '404' Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L216:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].get.responses.404 |
2 | The new version removes the response code '404' Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L274:11 paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}'].patch.responses.404 |
💬 1045 - AddedOptionalProperty
Displaying 1 out of 1 occurrences.
Index | Description |
---|---|
1 | The new version has a new optional property 'systemData' that was not found in the old version. New: Microsoft.Portal/preview/2022-12-01-preview/portal.json#L629:7 definitions.Dashboard.properties Old: Microsoft.Portal/preview/2020-09-01-preview/portal.json#L590:7 |