Azure / Azure/azure-rest-api-specs

Microsoft.MachineLearningServices/workspaces/computes@2021-04-01 - ROUNDTRIP_INCONSISTENT_PROPERTY

Open
#20,336 0 comments 0 reactions 0 assignees View on GitHub
MachineLearningServices Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

## Microsoft.MachineLearningServices/workspaces/computes@2021-04-01 - ROUNDTRIP_INCONSISTENT_PROPERTY

### Description

I found differences between PUT request body and GET response:

- .properties.properties.vmSize: expect STANDARD_DS2_V2, but got Standard_DS2_V2

```json
{
"properties": {
"computeLocation": "westus",
"computeType": "AmlCompute",
"disableLocalAuth": true,
"properties": {
"scaleSettings": {
"maxNodeCount": 1,
"minNodeCount": 0,
"nodeIdleTimeBeforeScaleDown": "PT30S"
},
"vmPriority": "LowPriority",
"vmSize": Got "STANDARD_DS2_V2" in response, expect "Standard_DS2_V2"
}
}
}
```

### Details

1. ARM Fully-Qualified Resource Type
```
Microsoft.MachineLearningServices/workspaces/computes
```

2. API Version
```
2021-04-01
```

3. Swagger issue type
```
Swagger Correctness
```

4. OperationId
```
TODO
e.g., VirtualMachines_Get
```

5. Swagger GitHub permalink
```
TODO,
e.g., https://github.com/Azure/azure-rest-api-specs/blob/60723d13309c8f8060d020a7f3dd9d6e380f0bbd
/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json#L9065-L9101
```

6. Error code
```
ROUNDTRIP_INCONSISTENT_PROPERTY
```

7. Request traces
```
PUT https://management.azure.com/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/henglu823ml/providers/Microsoft.MachineLearningServices/workspaces/henglu823ml/computes/henglu823ml?api-version=2021-04-01
Accept: application/json
Authorization: REDACTED
Content-Length: 310
Content-Type: application/json
User-Agent: HashiCorp Terraform/1.2.0 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/dev pid-222c6c49-1b0a-5959-a213-6608f9eb8820
X-Ms-Correlation-Request-Id: REDACTED
--------------------------------------------------------------------------------
{"identity":{"type":"SystemAssigned"},"location":"westus","properties":{"computeLocation":"westus","computeType":"AmlCompute","disableLocalAuth":true,"properties":{"scaleSettings":{"maxNodeCount":1,"minNodeCount":0,"nodeIdleTimeBeforeScaleDown":"PT30S"},"vmPriority":"LowPriority","vmSize":"Standard_DS2_V2"}}}
--------------------------------------------------------------------------------

RESPONSE Status: 201 Created
Azure-Asyncoperation: REDACTED
Cache-Control: no-cache
Content-Length: 1321
Content-Type: application/json; charset=utf-8
Date: Tue, 23 Aug 2022 09:04:57 GMT
Expires: -1
Pragma: no-cache
Request-Context: REDACTED
Server-Timing: REDACTED
Strict-Transport-Security: REDACTED
X-Aml-Cluster: REDACTED
X-Content-Type-Options: REDACTED
X-Ms-Correlation-Request-Id: REDACTED
X-Ms-Ratelimit-Remaining-Subscription-Writes: REDACTED
X-Ms-Request-Id: 30132e0c-5d95-41c9-9923-0d0fecc41e3d
X-Ms-Response-Type: REDACTED
X-Ms-Routing-Request-Id: REDACTED
X-Request-Time: REDACTED
--------------------------------------------------------------------------------
{
"id": "/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/henglu823ml/providers/Microsoft.MachineLearningServices/workspaces/henglu823ml/computes/henglu823ml",
"name": "henglu823ml",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"location": "westus",
"tags": null,
"identity": {
"type": "SystemAssigned",
"principalId": "5b1f92bb-6bca-435b-b77a-a3879d5abe1a",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
},
"properties": {
"createdOn": "2022-08-23T09:04:58.4496391+00:00",
"modifiedOn": "2022-08-23T09:04:58.4496391+00:00",
"disableLocalAuth": true,
"description": null,
"resourceId": null,
"computeType": "AmlCompute",
"computeLocation": "westus",
"provisioningState": "Creating",
"provisioningErrors": null,
"isAttachedCompute": false,
"properties": {
"vmSize": "STANDARD_DS2_V2",
"vmPriority": "LowPriority",
"scaleSettings": {
"maxNodeCount": 1,
"minNodeCount": 0,
"nodeIdleTimeBeforeScaleDown": "PT30S"
},
"subnet": null,
"currentNodeCount": null,
"targetNodeCount": null,
"nodeStateCounts": null,
"allocationState": null,
"errors": null,
"virtualMachineImage": null,
"isolatedNetwork": false
}
}
}
--------------------------------------------------------------------------------

GET https://management.azure.com/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/henglu823ml/providers/Microsoft.MachineLearningServices/workspaces/henglu823ml/computes/henglu823ml?api-version=2021-04-01
Accept: application/json
Authorization: REDACTED
User-Agent: HashiCorp Terraform/1.2.0 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/dev pid-222c6c49-1b0a-5959-a213-6608f9eb8820
X-Ms-Correlation-Request-Id: REDACTED
--------------------------------------------------------------------------------
RESPONSE Status: 200 OK
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Tue, 23 Aug 2022 09:06:16 GMT
Expires: -1
Pragma: no-cache
Request-Context: REDACTED
Server-Timing: REDACTED
Strict-Transport-Security: REDACTED
Vary: REDACTED
X-Aml-Cluster: REDACTED
X-Content-Type-Options: REDACTED
X-Ms-Correlation-Request-Id: REDACTED
X-Ms-Ratelimit-Remaining-Subscription-Reads: REDACTED
X-Ms-Request-Id: 78de3f8b-211b-495b-9f3b-44cd67d01733
X-Ms-Response-Type: REDACTED
X-Ms-Routing-Request-Id: REDACTED
X-Request-Time: REDACTED
--------------------------------------------------------------------------------
{
"id": "/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/henglu823ml/providers/Microsoft.MachineLearningServices/workspaces/henglu823ml/computes/henglu823ml",
"name": "henglu823ml",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"location": "westus",
"tags": {},
"identity": {
"type": "SystemAssigned",
"principalId": "5b1f92bb-6bca-435b-b77a-a3879d5abe1a",
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
},
"properties": {
"createdOn": "2022-08-23T09:04:58.4496391+00:00",
"modifiedOn": "2022-08-23T09:05:35.0947806+00:00",
"disableLocalAuth": true,
"description": null,
"resourceId": null,
"computeType": "AmlCompute",
"computeLocation": "westus",
"provisioningState": "Succeeded",
"provisioningErrors": null,
"isAttachedCompute": false,
"properties": {
"vmSize": "STANDARD_DS2_V2",
"vmPriority": "LowPriority",
"scaleSettings": {
"maxNodeCount": 1,
"minNodeCount": 0,
"nodeIdleTimeBeforeScaleDown": "PT30S"
},
"subnet": null,
"currentNodeCount": 0,
"targetNodeCount": 0,
"nodeStateCounts": {
"preparingNodeCount": 0,
"runningNodeCount": 0,
"idleNodeCount": 0,
"unusableNodeCount": 0,
"leavingNodeCount": 0,
"preemptedNodeCount": 0
},
"allocationState": "Resizing",
"allocationStateTransitionTime": "2022-08-23T09:04:58.877+00:00",
"errors": null,
"remoteLoginPortPublicAccess": "Enabled",
"osType": "Linux",
"virtualMachineImage": null,
"isolatedNetwork": false,
"propertyBag": {}
}
}
}
--------------------------------------------------------------------------------
```

### Links
1. [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/Semantic-and-Model-Violations-Reference.md)
2. [S360 action item generator for Swagger issues](https://aka.ms/swaggers360)

Contributor guide

Open the contributing guide

Research direction

No source file, operation ID, or test is identified. Locate the Microsoft.MachineLearningServices/workspaces/computes specification for API version 2021-04-01, then compare the vmSize request and response definitions. Done means the specification represents the observed casing consistently and its relevant validation checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, backend-api-design
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.