[keyvault] Output breaking change after bumping version

[evelyn-ys]

• Package Name: azure-keyvault-keys
• Package Version: 4.9.0b3 -> 4.11.0b1
• Operating System: Any
• Python Version: 3.12

Describe the bug
Azure CLI calls sdk model's as_dict() function to transform output.

In azure-keyvault-keys==4.9.0b3 (which is swagger generated), KeyAttributes.as_dict() returns {'expires': '2027-05-28T16:43:07+00:00', 'created': '2025-05-21T16:44:32+00:00', ......}

but after bumpping to azure-keyvault keys==4.11.0b1 (which is typespec generated):
KeyAttributes.as_dict() returns {'exp': 1811522587, 'created': 1747845872, ......}

The renameing and formatting seems to be totally ignored during dict transformation

azure-sdk-for-python/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/_generated/models/_models.py

Line 394 in 19bd600

expires: Optional[datetime.datetime] = rest_field(name="exp", format="unix-timestamp")

To Reproduce
Steps to reproduce the behavior:

1. Use azure-keyvault-keys==4.9.0b3, call client.get_key().as_dict()
2. Upgrade to azure-keyvault keys==4.11.0b1, call client.get_key().as_dict() again
3. check the expiration and creation time in result

Expected behavior
A clear and concise description of what you expected to happen.
There should not be such breaking change after swagger to typespec migration

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

[github-actions]

Hi @evelyn-ys, I'm an AI Support assistant here to help with your issue. While the Azure SDK team reviews your request, I wanted to provide some possible tips and documentation that might help you in the meantime.

• The change from swagger-generated (4.9.0b3) to typespec-generated (4.11.0b1) models has altered how properties are serialized in as_dict(), including renaming and timestamp conversion.
• Refer to the changelog for 4.11.0b1 for an overview of updates (see CHANGELOG). Although the output transformation isn’t explicitly detailed there, the shift in code generation is the likely cause.
• Please review your code’s dependency on specific formatting from as_dict() output. Adjusting to the new model shape—for example, handling numeric epoch times instead of ISO 8601 strings—may be necessary in your integration.
• For further context, see the generated model code here.

The Azure SDK team will respond to your issue shortly. I hope these suggestions are helpful in the meantime. If this comment helped you, please give it a 👍. If the suggestion was not helpful or incorrect, please give it a 👎. Your feedback helps us improve!

[lmazuel]

@evelyn-ys Can you share the code you're calling? I can't reproduce this with the current public surface API. Thanks.

[evelyn-ys]

@evelyn-ys Can you share the code you're calling? I can't reproduce this with the current public surface API. Thanks.

Use azure-keyvault-keys==4.9.0b3, call client.get_key().as_dict(), got {'expires': '2027-05-28T16:43:07+00:00', 'created': '2025-05-21T16:44:32+00:00', ......}

Upgrade to azure-keyvault keys==4.11.0b1, call client.get_key().as_dict(), got {'exp': 1811522587, 'created': 1747845872, ......}

[evelyn-ys]

Here's the related issue reported by CLI customers after upgrading azure-keyvault-keys dependency from 4.9.0b3 to 4.11.0b1:
Azure/azure-cli#31529

[lmazuel]

@evelyn-ys , I'm sorry, but the return type of get_key does not contain a as_dict

[evelyn-ys]

@lmazuel Sry for the ambiguity. client.get_key() returns a KeyVaultKey object. The error model actually is KeyAttributes.

You can verify by

key = client.get_key(key_name)
attributes = key.properties._attributes.as_dict()

[lmazuel]

@evelyn-ys There is no backward compatible contract once you start using private properties. No code base should ever rely on thing that starts with a _, and expect them to stay stable. The only commitment of Python code, is for public API surface.

As such, change in private properties are not considered a breaking change.

[github-actions]

Hi @evelyn-ys. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

[evelyn-ys]

@lmazuel CLI doesn't want to use private properties either. But SDK doesn't provide any func to format KeyProperties to dict. Previously, We didn't have to care what attributes in KeyProperties and we just transformed the whole KeyProperties to dict. But things changed now. We have to call key.properties.expires_on to get the expiration info and call key.properties.created_on to get creation info. We have to call it explicitly. And we can't even find any way to get all the attributes of KeyProperties so that we can call getattr(key.properties, attr_name) one by one. We can only find the key.properties._attributes stores most of the attributes we need. Can you help with this issue?