`Microsoft.ContainerService/fleets/updateStrategies@2023-10-15` - UpdateStage.Groups is optional in swagger but required in API

[ms-henglu]

Microsoft.ContainerService/fleets/updateStrategies@2023-10-15 - Error

Description

I found an error when creating this resource:

 "Resource: (ResourceId \"/subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129\" / Api Version \"2023-10-15\")": PUT https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129
--------------------------------------------------------------------------------
RESPONSE 400: 400 Bad Request
ERROR CODE: RequiredPropertyMissing
--------------------------------------------------------------------------------
{
  "error": {
    "code": "RequiredPropertyMissing",
    "message": "A required property UpdateStage.Groups is missing. Please specify a value for this property and retry this operation. Resource ID: \"/subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129\". Correlation ID: \"f2bf5476-2e7f-0171-aaf9-101f706cd9ae\". Operation ID: \"6ae18797-2c19-4779-adbf-fda4d9077eeb\""
  }
}
--------------------------------------------------------------------------

Details

1. ARM Fully-Qualified Resource Type

Microsoft.ContainerService/fleets/updateStrategies

2. API Version

2023-10-15

3. Swagger issue type

Other

4. OperationId

FleetUpdateStrategies_CreateOrUpdate

5. Swagger GitHub permalink

https://github.com/Azure/azure-rest-api-specs/blob/8f889f0967e411fc1042aed0a097868b360f525a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json#L2479

6. Error code

Optional field in swagger is required in API

7. Request traces

GET /subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129?api-version=2023-10-15
Status Code: 404
------------ Request ------------
Accept: application/json
Authorization: REDACTED
User-Agent: HashiCorp Terraform/1.6.4 (+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: f2bf5476-2e7f-0171-aaf9-101f706cd9ae

---


------------ Response ------------
Content-Length: 376
Content-Type: application/json; charset=utf-8
Date: Wed, 29 Nov 2023 07:23:32 GMT
Expires: -1
Pragma: no-cache
Server: nginx
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
X-Ms-Correlation-Request-Id: f2bf5476-2e7f-0171-aaf9-101f706cd9ae
X-Ms-Ratelimit-Remaining-Subscription-Reads: 11997
X-Ms-Request-Id: 95055efd-4baa-4c04-9e27-46491701278b
Cache-Control: no-cache
X-Ms-Routing-Request-Id: SOUTHEASTASIA:20231129T072333Z:95055efd-4baa-4c04-9e27-46491701278b
------
{
  "error": {
    "code": "ResourceNotFound",
    "message": "Could not find the given resource. Resource ID: \"/subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129\". Correlation ID: \"f2bf5476-2e7f-0171-aaf9-101f706cd9ae\". Operation ID: \"9ef12a88-e22f-4031-9eb0-353b7e42a4e7\""
  }
}




PUT /subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129?api-version=2023-10-15
Status Code: 400
------------ Request ------------
Accept: application/json
Authorization: REDACTED
Content-Length: 62
Content-Type: application/json
User-Agent: HashiCorp Terraform/1.6.4 (+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: f2bf5476-2e7f-0171-aaf9-101f706cd9ae

---
{
  "properties": {
    "strategy": {
      "stages": [
        {
          "name": "henglu1129"
        }
      ]
    }
  }
}

------------ Response ------------
Content-Type: application/json; charset=utf-8
X-Ms-Routing-Request-Id: SOUTHEASTASIA:20231129T072332Z:ac852681-58c2-4b54-8502-7118fd666753
Expires: -1
Pragma: no-cache
Server: nginx
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Cache-Control: no-cache
Content-Length: 466
Date: Wed, 29 Nov 2023 07:23:31 GMT
X-Ms-Correlation-Request-Id: f2bf5476-2e7f-0171-aaf9-101f706cd9ae
X-Ms-Ratelimit-Remaining-Subscription-Writes: 1199
X-Ms-Request-Id: ac852681-58c2-4b54-8502-7118fd666753
------
{
  "error": {
    "code": "RequiredPropertyMissing",
    "message": "A required property UpdateStage.Groups is missing. Please specify a value for this property and retry this operation. Resource ID: \"/subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129\". Correlation ID: \"f2bf5476-2e7f-0171-aaf9-101f706cd9ae\". Operation ID: \"6ae18797-2c19-4779-adbf-fda4d9077eeb\""
  }
}




GET /subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129?api-version=2023-10-15
Status Code: 404
------------ Request ------------
Authorization: REDACTED
User-Agent: HashiCorp Terraform/1.6.4 (+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: f2bf5476-2e7f-0171-aaf9-101f706cd9ae
Accept: application/json

---


------------ Response ------------
X-Ms-Ratelimit-Remaining-Subscription-Reads: 11998
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
X-Ms-Correlation-Request-Id: f2bf5476-2e7f-0171-aaf9-101f706cd9ae
Pragma: no-cache
Server: nginx
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
X-Ms-Request-Id: fd1e61ad-0ac5-4a18-9997-d27d56853959
Content-Length: 376
Date: Wed, 29 Nov 2023 07:23:30 GMT
Expires: -1
X-Ms-Routing-Request-Id: SOUTHEASTASIA:20231129T072331Z:fd1e61ad-0ac5-4a18-9997-d27d56853959
------
{
  "error": {
    "code": "ResourceNotFound",
    "message": "Could not find the given resource. Resource ID: \"/subscriptions/{subscription_id}/resourceGroups/henglu1129/providers/Microsoft.ContainerService/fleets/henglu1129/updateStrategies/henglu1129\". Correlation ID: \"f2bf5476-2e7f-0171-aaf9-101f706cd9ae\". Operation ID: \"6ba93ecf-9b1a-46a1-9d6c-e35ab79d16b3\""
  }
}

Links

1. Semantic and Model Violations Reference
2. S360 action item generator for Swagger issues

[serbrech]

Thanks for reporting this @ms-henglu

This is a swagger mistake. the field is required as per the api error message.
Functionnaly, having a stage with no groups at all is a no-op, so it does not make sense for a user to do this anyways.

We will fix the definition in next api-versions.
We'll see if we should fix it in the swagger definition of 10-15 and 08-15-preview as their SDKs have been published already.