search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.61k stars 5.03k forks source link

`Microsoft.ContainerService/managedClusters@2022-09-02-preview` - `ROUNDTRIP_INCONSISTENT_PROPERTY ` #21872

Open ms-henglu opened 1 year ago

ms-henglu commented 1 year ago

Microsoft.ContainerService/managedClusters@2022-09-02-preview - ROUNDTRIP_INCONSISTENT_PROPERTY

Description

I found differences between PUT request body and GET response:

{
    "properties": {
        "agentPoolProfiles": [
            {
                "count": 1,
                "mode": "System",
                "name": "default",
                "vmSize": "Standard_D2_v2"
            }
        ],
        "dnsPrefix": "henglu1123aks",
        "kubernetesVersion": "1.24.3",
        "networkProfile": {
            "loadBalancerProfile": {
                "backendPoolType": Got "nodeIP" in response, expect "NodeIP"
            },
            "loadBalancerSku": "Standard",
            "networkPlugin": "azure"
        }
    }
}

Details

  1. ARM Fully-Qualified Resource Type

    Microsoft.ContainerService/managedClusters

  2. API Version

    2022-09-02-preview

  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/{subscription_id}/resourceGroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks?api-version=2022-09-02-preview
Accept: application/json
Authorization: REDACTED
Content-Length: 350
Content-Type: application/json
User-Agent: HashiCorp Terraform/1.2.8 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/v1.1.0 pid-222c6c49-1b0a-5959-a213-6608f9eb8820
X-Ms-Correlation-Request-Id: REDACTED
--------------------------------------------------------------------------------
{"identity":{"type":"SystemAssigned"},"location":"westeurope","properties":{"agentPoolProfiles":[{"count":1,"mode":"System","name":"default","vmSize":"Standard_D2_v2"}],"dnsPrefix":"henglu1123aks","kubernetesVersion":"1.24.3","networkProfile":{"loadBalancerProfile":{"backendPoolType":"NodeIP"},"loadBalancerSku":"Standard","networkPlugin":"azure"}}}
--------------------------------------------------------------------------------

RESPONSE Status: 200 OK Azure-Asyncoperation: REDACTED Cache-Control: no-cache Content-Type: application/json Date: Tue, 13 Dec 2022 08:09:32 GMT Expires: -1 Pragma: no-cache Server: nginx Strict-Transport-Security: REDACTED Vary: REDACTED X-Content-Type-Options: REDACTED X-Ms-Correlation-Request-Id: REDACTED X-Ms-Ratelimit-Remaining-Subscription-Writes: REDACTED X-Ms-Request-Id: f940fa52-3d5e-409d-b3b1-a1cea098f3ea X-Ms-Routing-Request-Id: REDACTED

{ "id": "/subscriptions/{subscription_id}/resourcegroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks", "location": "westeurope", "name": "henglu1123aks", "type": "Microsoft.ContainerService/ManagedClusters", "properties": { "provisioningState": "Updating", "powerState": { "code": "Running" }, "kubernetesVersion": "1.24.3", "currentKubernetesVersion": "1.24.3", "dnsPrefix": "henglu1123aks", "fqdn": "henglu1123aks-18b25a44.hcp.westeurope.azmk8s.io", "azurePortalFQDN": "henglu1123aks-18b25a44.portal.hcp.westeurope.azmk8s.io", "agentPoolProfiles": [ { "name": "default", "count": 1, "vmSize": "Standard_D2_v2", "osDiskSizeGB": 128, "osDiskType": "Managed", "kubeletDiskType": "OS", "maxPods": 30, "type": "VirtualMachineScaleSets", "provisioningState": "Updating", "powerState": { "code": "Running" }, "orchestratorVersion": "1.23.12", "currentOrchestratorVersion": "1.23.12", "enableCustomCATrust": false, "mode": "System", "osType": "Linux", "osSKU": "Ubuntu", "nodeImageVersion": "AKSUbuntu-1804containerd-2022.12.01", "enableFIPS": false } ], "windowsProfile": { "adminUsername": "azureuser", "enableCSIProxy": true }, "servicePrincipalProfile": { "clientId": "msi" }, "nodeResourceGroup": "MC_henglu1123aks_henglu1123aks_westeurope", "enableRBAC": true, "networkProfile": { "networkPlugin": "azure", "loadBalancerSku": "Standard", "loadBalancerProfile": { "backendPoolType": "nodeIP" }, "natGatewayProfile": { "managedOutboundIPProfile": { "count": 1 }, "effectiveOutboundIPs": [ { "id": "/subscriptions/{subscription_id}/resourceGroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.Network/publicIPAddresses/5ca65bc8-a489-4d5a-bde2-3483566c5a3d" } ], "idleTimeoutInMinutes": 4 }, "serviceCidr": "10.0.0.0/16", "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "outboundType": "managedNATGateway", "serviceCidrs": [ "10.0.0.0/16" ], "ipFamilies": [ "IPv4" ] }, "maxAgentPools": 100, "identityProfile": { "kubeletidentity": { "resourceId": "/subscriptions/{subscription_id}/resourcegroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.ManagedIdentity/userAssignedIdentities/henglu1123aks-agentpool", "clientId": "e659eade-9456-4273-9c4a-45a39a780f85", "objectId": "d48ee8a3-bc3e-4758-a010-beb4869f47a3" } }, "securityProfile": {}, "storageProfile": { "diskCSIDriver": { "enabled": true, "version": "v1" }, "fileCSIDriver": { "enabled": true }, "snapshotController": { "enabled": true } }, "oidcIssuerProfile": { "enabled": false }, "workloadAutoScalerProfile": {} }, "identity": { "type": "SystemAssigned", "principalId": "0b2196af-f1a2-45c3-b08c-0ff2f0b9b811", "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" }, "sku": { "name": "Basic", "tier": "Free" } }

GET https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks?api-version=2022-09-02-preview Accept: application/json Authorization: REDACTED User-Agent: HashiCorp Terraform/1.2.8 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/v1.1.0 pid-222c6c49-1b0a-5959-a213-6608f9eb8820 X-Ms-Correlation-Request-Id: REDACTED

RESPONSE Status: 200 OK Cache-Control: no-cache Content-Type: application/json Date: Tue, 13 Dec 2022 08:11:17 GMT Expires: -1 Pragma: no-cache Server: nginx Strict-Transport-Security: REDACTED Vary: REDACTED X-Content-Type-Options: REDACTED X-Ms-Correlation-Request-Id: REDACTED X-Ms-Ratelimit-Remaining-Subscription-Reads: REDACTED X-Ms-Request-Id: 30832ec8-ddc5-419e-b5f6-a387f86bbb3a X-Ms-Routing-Request-Id: REDACTED

{ "id": "/subscriptions/{subscription_id}/resourcegroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks", "location": "westeurope", "name": "henglu1123aks", "type": "Microsoft.ContainerService/ManagedClusters", "properties": { "provisioningState": "Succeeded", "powerState": { "code": "Running" }, "kubernetesVersion": "1.24.3", "currentKubernetesVersion": "1.24.3", "dnsPrefix": "henglu1123aks", "fqdn": "henglu1123aks-18b25a44.hcp.westeurope.azmk8s.io", "azurePortalFQDN": "henglu1123aks-18b25a44.portal.hcp.westeurope.azmk8s.io", "agentPoolProfiles": [ { "name": "default", "count": 1, "vmSize": "Standard_D2_v2", "osDiskSizeGB": 128, "osDiskType": "Managed", "kubeletDiskType": "OS", "maxPods": 30, "type": "VirtualMachineScaleSets", "provisioningState": "Succeeded", "powerState": { "code": "Running" }, "orchestratorVersion": "1.23.12", "currentOrchestratorVersion": "1.23.12", "enableCustomCATrust": false, "mode": "System", "osType": "Linux", "osSKU": "Ubuntu", "nodeImageVersion": "AKSUbuntu-1804containerd-2022.12.01", "enableFIPS": false } ], "windowsProfile": { "adminUsername": "azureuser", "enableCSIProxy": true }, "servicePrincipalProfile": { "clientId": "msi" }, "nodeResourceGroup": "MC_henglu1123aks_henglu1123aks_westeurope", "enableRBAC": true, "networkProfile": { "networkPlugin": "azure", "loadBalancerSku": "Standard", "loadBalancerProfile": { "backendPoolType": "nodeIP" }, "natGatewayProfile": { "managedOutboundIPProfile": { "count": 1 }, "effectiveOutboundIPs": [ { "id": "/subscriptions/{subscription_id}/resourceGroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.Network/publicIPAddresses/5ca65bc8-a489-4d5a-bde2-3483566c5a3d" } ], "idleTimeoutInMinutes": 4 }, "serviceCidr": "10.0.0.0/16", "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "outboundType": "managedNATGateway", "serviceCidrs": [ "10.0.0.0/16" ], "ipFamilies": [ "IPv4" ] }, "maxAgentPools": 100, "identityProfile": { "kubeletidentity": { "resourceId": "/subscriptions/{subscription_id}/resourcegroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.ManagedIdentity/userAssignedIdentities/henglu1123aks-agentpool", "clientId": "e659eade-9456-4273-9c4a-45a39a780f85", "objectId": "d48ee8a3-bc3e-4758-a010-beb4869f47a3" } }, "securityProfile": {}, "storageProfile": { "diskCSIDriver": { "enabled": true, "version": "v1" }, "fileCSIDriver": { "enabled": true }, "snapshotController": { "enabled": true } }, "oidcIssuerProfile": { "enabled": false }, "workloadAutoScalerProfile": {} }, "identity": { "type": "SystemAssigned", "principalId": "0b2196af-f1a2-45c3-b08c-0ff2f0b9b811", "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" }, "sku": { "name": "Basic", "tier": "Free" } }



### 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)
ghost commented 1 year ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @qike-ms, @jwilder, @thomas1206, @seanmck.

Issue Details
## Microsoft.ContainerService/managedClusters@2022-09-02-preview - ROUNDTRIP_INCONSISTENT_PROPERTY ### Description I found differences between PUT request body and GET response: - .properties.networkProfile.loadBalancerProfile.backendPoolType: expect NodeIP, but got nodeIP ```json { "properties": { "agentPoolProfiles": [ { "count": 1, "mode": "System", "name": "default", "vmSize": "Standard_D2_v2" } ], "dnsPrefix": "henglu1123aks", "kubernetesVersion": "1.24.3", "networkProfile": { "loadBalancerProfile": { "backendPoolType": Got "nodeIP" in response, expect "NodeIP" }, "loadBalancerSku": "Standard", "networkPlugin": "azure" } } } ``` ### Details 1. ARM Fully-Qualified Resource Type ``` Microsoft.ContainerService/managedClusters ``` 2. API Version ``` 2022-09-02-preview ``` 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/{subscription_id}/resourceGroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks?api-version=2022-09-02-preview Accept: application/json Authorization: REDACTED Content-Length: 350 Content-Type: application/json User-Agent: HashiCorp Terraform/1.2.8 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/v1.1.0 pid-222c6c49-1b0a-5959-a213-6608f9eb8820 X-Ms-Correlation-Request-Id: REDACTED -------------------------------------------------------------------------------- {"identity":{"type":"SystemAssigned"},"location":"westeurope","properties":{"agentPoolProfiles":[{"count":1,"mode":"System","name":"default","vmSize":"Standard_D2_v2"}],"dnsPrefix":"henglu1123aks","kubernetesVersion":"1.24.3","networkProfile":{"loadBalancerProfile":{"backendPoolType":"NodeIP"},"loadBalancerSku":"Standard","networkPlugin":"azure"}}} -------------------------------------------------------------------------------- RESPONSE Status: 200 OK Azure-Asyncoperation: REDACTED Cache-Control: no-cache Content-Type: application/json Date: Tue, 13 Dec 2022 08:09:32 GMT Expires: -1 Pragma: no-cache Server: nginx Strict-Transport-Security: REDACTED Vary: REDACTED X-Content-Type-Options: REDACTED X-Ms-Correlation-Request-Id: REDACTED X-Ms-Ratelimit-Remaining-Subscription-Writes: REDACTED X-Ms-Request-Id: f940fa52-3d5e-409d-b3b1-a1cea098f3ea X-Ms-Routing-Request-Id: REDACTED -------------------------------------------------------------------------------- { "id": "/subscriptions/{subscription_id}/resourcegroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks", "location": "westeurope", "name": "henglu1123aks", "type": "Microsoft.ContainerService/ManagedClusters", "properties": { "provisioningState": "Updating", "powerState": { "code": "Running" }, "kubernetesVersion": "1.24.3", "currentKubernetesVersion": "1.24.3", "dnsPrefix": "henglu1123aks", "fqdn": "henglu1123aks-18b25a44.hcp.westeurope.azmk8s.io", "azurePortalFQDN": "henglu1123aks-18b25a44.portal.hcp.westeurope.azmk8s.io", "agentPoolProfiles": [ { "name": "default", "count": 1, "vmSize": "Standard_D2_v2", "osDiskSizeGB": 128, "osDiskType": "Managed", "kubeletDiskType": "OS", "maxPods": 30, "type": "VirtualMachineScaleSets", "provisioningState": "Updating", "powerState": { "code": "Running" }, "orchestratorVersion": "1.23.12", "currentOrchestratorVersion": "1.23.12", "enableCustomCATrust": false, "mode": "System", "osType": "Linux", "osSKU": "Ubuntu", "nodeImageVersion": "AKSUbuntu-1804containerd-2022.12.01", "enableFIPS": false } ], "windowsProfile": { "adminUsername": "azureuser", "enableCSIProxy": true }, "servicePrincipalProfile": { "clientId": "msi" }, "nodeResourceGroup": "MC_henglu1123aks_henglu1123aks_westeurope", "enableRBAC": true, "networkProfile": { "networkPlugin": "azure", "loadBalancerSku": "Standard", "loadBalancerProfile": { "backendPoolType": "nodeIP" }, "natGatewayProfile": { "managedOutboundIPProfile": { "count": 1 }, "effectiveOutboundIPs": [ { "id": "/subscriptions/{subscription_id}/resourceGroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.Network/publicIPAddresses/5ca65bc8-a489-4d5a-bde2-3483566c5a3d" } ], "idleTimeoutInMinutes": 4 }, "serviceCidr": "10.0.0.0/16", "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "outboundType": "managedNATGateway", "serviceCidrs": [ "10.0.0.0/16" ], "ipFamilies": [ "IPv4" ] }, "maxAgentPools": 100, "identityProfile": { "kubeletidentity": { "resourceId": "/subscriptions/{subscription_id}/resourcegroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.ManagedIdentity/userAssignedIdentities/henglu1123aks-agentpool", "clientId": "e659eade-9456-4273-9c4a-45a39a780f85", "objectId": "d48ee8a3-bc3e-4758-a010-beb4869f47a3" } }, "securityProfile": {}, "storageProfile": { "diskCSIDriver": { "enabled": true, "version": "v1" }, "fileCSIDriver": { "enabled": true }, "snapshotController": { "enabled": true } }, "oidcIssuerProfile": { "enabled": false }, "workloadAutoScalerProfile": {} }, "identity": { "type": "SystemAssigned", "principalId": "0b2196af-f1a2-45c3-b08c-0ff2f0b9b811", "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" }, "sku": { "name": "Basic", "tier": "Free" } } -------------------------------------------------------------------------------- GET https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks?api-version=2022-09-02-preview Accept: application/json Authorization: REDACTED User-Agent: HashiCorp Terraform/1.2.8 (+https://www.terraform.io) Terraform Plugin SDK/2.8.0 terraform-provider-azapi/v1.1.0 pid-222c6c49-1b0a-5959-a213-6608f9eb8820 X-Ms-Correlation-Request-Id: REDACTED -------------------------------------------------------------------------------- RESPONSE Status: 200 OK Cache-Control: no-cache Content-Type: application/json Date: Tue, 13 Dec 2022 08:11:17 GMT Expires: -1 Pragma: no-cache Server: nginx Strict-Transport-Security: REDACTED Vary: REDACTED X-Content-Type-Options: REDACTED X-Ms-Correlation-Request-Id: REDACTED X-Ms-Ratelimit-Remaining-Subscription-Reads: REDACTED X-Ms-Request-Id: 30832ec8-ddc5-419e-b5f6-a387f86bbb3a X-Ms-Routing-Request-Id: REDACTED -------------------------------------------------------------------------------- { "id": "/subscriptions/{subscription_id}/resourcegroups/henglu1123aks/providers/Microsoft.ContainerService/managedClusters/henglu1123aks", "location": "westeurope", "name": "henglu1123aks", "type": "Microsoft.ContainerService/ManagedClusters", "properties": { "provisioningState": "Succeeded", "powerState": { "code": "Running" }, "kubernetesVersion": "1.24.3", "currentKubernetesVersion": "1.24.3", "dnsPrefix": "henglu1123aks", "fqdn": "henglu1123aks-18b25a44.hcp.westeurope.azmk8s.io", "azurePortalFQDN": "henglu1123aks-18b25a44.portal.hcp.westeurope.azmk8s.io", "agentPoolProfiles": [ { "name": "default", "count": 1, "vmSize": "Standard_D2_v2", "osDiskSizeGB": 128, "osDiskType": "Managed", "kubeletDiskType": "OS", "maxPods": 30, "type": "VirtualMachineScaleSets", "provisioningState": "Succeeded", "powerState": { "code": "Running" }, "orchestratorVersion": "1.23.12", "currentOrchestratorVersion": "1.23.12", "enableCustomCATrust": false, "mode": "System", "osType": "Linux", "osSKU": "Ubuntu", "nodeImageVersion": "AKSUbuntu-1804containerd-2022.12.01", "enableFIPS": false } ], "windowsProfile": { "adminUsername": "azureuser", "enableCSIProxy": true }, "servicePrincipalProfile": { "clientId": "msi" }, "nodeResourceGroup": "MC_henglu1123aks_henglu1123aks_westeurope", "enableRBAC": true, "networkProfile": { "networkPlugin": "azure", "loadBalancerSku": "Standard", "loadBalancerProfile": { "backendPoolType": "nodeIP" }, "natGatewayProfile": { "managedOutboundIPProfile": { "count": 1 }, "effectiveOutboundIPs": [ { "id": "/subscriptions/{subscription_id}/resourceGroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.Network/publicIPAddresses/5ca65bc8-a489-4d5a-bde2-3483566c5a3d" } ], "idleTimeoutInMinutes": 4 }, "serviceCidr": "10.0.0.0/16", "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "outboundType": "managedNATGateway", "serviceCidrs": [ "10.0.0.0/16" ], "ipFamilies": [ "IPv4" ] }, "maxAgentPools": 100, "identityProfile": { "kubeletidentity": { "resourceId": "/subscriptions/{subscription_id}/resourcegroups/MC_henglu1123aks_henglu1123aks_westeurope/providers/Microsoft.ManagedIdentity/userAssignedIdentities/henglu1123aks-agentpool", "clientId": "e659eade-9456-4273-9c4a-45a39a780f85", "objectId": "d48ee8a3-bc3e-4758-a010-beb4869f47a3" } }, "securityProfile": {}, "storageProfile": { "diskCSIDriver": { "enabled": true, "version": "v1" }, "fileCSIDriver": { "enabled": true }, "snapshotController": { "enabled": true } }, "oidcIssuerProfile": { "enabled": false }, "workloadAutoScalerProfile": {} }, "identity": { "type": "SystemAssigned", "principalId": "0b2196af-f1a2-45c3-b08c-0ff2f0b9b811", "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" }, "sku": { "name": "Basic", "tier": "Free" } } -------------------------------------------------------------------------------- ``` ### 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)
Author: ms-henglu
Assignees: -
Labels: `Service Attention`, `needs-triage`, `Container Service`
Milestone: -