{Keyvault} az keyvault security-domain: Migrate security domain to use track2 SDK
#30252
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evelyn-ys
requested review from
jiasli,
calvinhzy,
jsntcy,
kairu-ms,
zhoxing-ms,
necusjz and
bebound
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @evelyn-ys, |
️✔️AzureCLI-BreakingChangeTest
|
|
Migrate security domain to use track2 SDK |
bebound
approved these changes
Nov 8, 2024
jiasli
reviewed
Nov 8, 2024
| @@ -299,7 +300,6 @@ def default_api_version(self): | |||
| ResourceType.DATA_KEYVAULT_CERTIFICATES: None, | |||
| ResourceType.DATA_KEYVAULT_KEYS: None, | |||
| ResourceType.DATA_KEYVAULT_SECRETS: None, | |||
| ResourceType.DATA_KEYVAULT: '2016-10-01', | |||
There was a problem hiding this comment.
security-domain is never supported in Azure Stack. But key/secret/certificate are supported so we have DATA_KEYVAULT_KEYS/DATA_KEYVAULT_SECRETS/DATA_KEYVAULT_CERTIFICATES definition in azure stack
jiasli
reviewed
Nov 8, 2024
Comment on lines
+482
to
+485
| ret = { | ||
| 'status': getattr(result, 'status', None), | ||
| 'statusDetails': getattr(result, 'status_details', None) | ||
| } |
There was a problem hiding this comment.
Why not rely on knack's serialization?
There was a problem hiding this comment.
Because SDK use a strange ModelBase which can't be serialized by knack
jiasli
reviewed
Nov 8, 2024
| @@ -202,8 +182,10 @@ def data_plane_azure_keyvault_administration_access_control_client(cli_ctx, comm | |||
|
|
|||
| vault_url, credential, version = _prepare_data_plane_azure_keyvault_client( | |||
| cli_ctx, command_args, ResourceType.DATA_KEYVAULT_ADMINISTRATION_ACCESS_CONTROL) | |||
| client_kwargs = prepare_client_kwargs_track2(cli_ctx) | |||
| client_kwargs.pop('http_logging_policy') | |||
There was a problem hiding this comment.
Is this because this SDK doesn't support http_logging_policy?
There was a problem hiding this comment.
Keyvault data plane SDKs have fixed http_logging_policy and don't accept customization
jiasli
reviewed
Nov 8, 2024
Comment on lines
+569
to
+570
| c.extra('hsm_name', hsm_url_type, required=False, | ||
| help='Name of the HSM. Can be omitted if --id is specified.') |
There was a problem hiding this comment.
If hsm_name is now an "extra" argument, how can it be used to create the SDK client?
There was a problem hiding this comment.
It's now accepted when creating client in client_factory.py instead of calling sdk in custom.py
jiasli
reviewed
Nov 8, 2024
Comment on lines
+2386
to
+2389
| sd_jwk['x5c'] = [Utils.security_domain_b64_url_encode_for_x5c(public_bytes)] # only one cert, not a chain | ||
| sd_jwk['x5t'] = Utils.security_domain_b64_url_encode(hashlib.sha1(public_bytes).digest()) | ||
| sd_jwk['x5t#S256'] = Utils.security_domain_b64_url_encode(hashlib.sha256(public_bytes).digest()) | ||
| sd_jwk['key_ops'] = ['verify', 'encrypt', 'wrapKey'] |
There was a problem hiding this comment.
Does Track 2 SDK now require dict instead of an SDK object?
There was a problem hiding this comment.
Track2 SDK can accept both model object and dict. I don't want to import many models from SDK so here use simple dict
calvinhzy
approved these changes
Nov 8, 2024
jiasli
approved these changes
Nov 11, 2024
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
az keyvault security-domainDescription
Pending SDK release Azure/azure-sdk-for-python#37929
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.