Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AKS will start rejecting requests with unknown fields in the 2024-01-01 API version #4060

Closed
matthchr opened this issue Jan 11, 2024 · 10 comments
Labels
announcement API/Swagger Anything related to the open AKS API/Swagger stale Stale issue

Comments

@matthchr
Copy link
Member

All current AKS API versions silently ignore unknown fields. An unknown field is a field that is not part of the AKS API. Starting in AKS API version 2024-01-01 and 2024-01-02-preview this behavior is changing. Unknown fields in a request will result in the request being rejected with an error stating that we don't understand the unknown field. This change only impacts new API versions and will not impact you unless you update to use an API version 2024-01-01 or later. Existing API calls (via ARM templates or otherwise) will continue to function as-is.

There are a few common possible reasons this happens:

  1. Using ARM templates/BICEP, you included a valid field in the right spot, but the template API version was too old and doesn't support that field.
  2. Using ARM templates/BICEP, you included a valid named field in the wrong spot in the resource hierarchy (for example, what should have been $.name was instead $.properties.name)
  3. Using ARM templates/BICEP, you included an invalid field. There might be a typo in your template (for example, what should have been aadProfile was instead addProfile).
  4. You are using a deprecated (and/or very out of date) SDK.
@matthchr matthchr added the API/Swagger Anything related to the open AKS API/Swagger label Jan 11, 2024
@matthchr matthchr pinned this issue Jan 11, 2024
@matthchr
Copy link
Member Author

matthchr commented Jan 19, 2024

We recently realized that some customers got a notice for the field storageProfile, or the field mode with userAgent ARM template/BICEP, which was confusing as they didn't use/send that field via any ARM templates they could find. Upon further investigation we realized that the Azure Portal is sending these two unknown fields (storageProfile and mode) field via the ARM templates it uses under the hood. This is a bug in the portal which we're fixing.

If you got a notification about unknown fields for storageProfile or mode and you've used the Azure Portal to create or update a cluster recently, you can ignore the notification. If the notification includes any unknown fields other than storageProfile or mode, you should still look into it and check your ARM/BICEP templates for those non-storageProfile fields and make sure they're in the right location, spelled correctly, and that the templates have specified the correct API version.

Copy link
Contributor

Action required from @Azure/aks-pm

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs Attention 👋 Issues needs attention/assignee/owner label Feb 21, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot removed action-required Needs Attention 👋 Issues needs attention/assignee/owner labels Feb 21, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the stale Stale issue label Apr 22, 2024
Copy link
Contributor

This issue has been automatically marked as stale because it has not had any activity for 60 days. It will be closed if no further activity occurs within 15 days of this comment.

Copy link
Contributor

This issue will now be closed because it hasn't had any activity for 7 days after stale. matthchr feel free to comment again on the next 7 days to reopen or open a new issue after that time if you still have a question/issue or suggestion.

@matthchr matthchr reopened this Apr 29, 2024
@matthchr matthchr removed the stale Stale issue label Apr 29, 2024
@matthchr
Copy link
Member Author

Reopening this as it may still be relevant for some users who are just migrating to the 2024 APIs now.

Copy link
Contributor

This issue has been automatically marked as stale because it has not had any activity for 21 days. It will be closed if no further activity occurs within 7 days of this comment.

Copy link
Contributor

This issue will now be closed because it hasn't had any activity for 7 days after stale. matthchr feel free to comment again on the next 7 days to reopen or open a new issue after that time if you still have a question/issue or suggestion.

@matthchr
Copy link
Member Author

Reopening once more, will let it be closed after this.

@matthchr matthchr reopened this May 31, 2024
@matthchr matthchr removed the stale Stale issue label May 31, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the stale Stale issue label Jun 23, 2024
Copy link
Contributor

This issue has been automatically marked as stale because it has not had any activity for 21 days. It will be closed if no further activity occurs within 7 days of this comment.

Copy link
Contributor

This issue will now be closed because it hasn't had any activity for 7 days after stale. matthchr feel free to comment again on the next 7 days to reopen or open a new issue after that time if you still have a question/issue or suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
announcement API/Swagger Anything related to the open AKS API/Swagger stale Stale issue
Projects
None yet
Development

No branches or pull requests

2 participants