Skip to content

Conversation

@vasanthrajams
Copy link
Contributor

Introducing External Key manager functionality

@github-actions
Copy link

github-actions bot commented Oct 19, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named Swagger Avocado has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide


Comment generated by summarize-checks workflow run.

@github-actions
Copy link

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
TypeSpec KeyVault

/**
* The External Key Manager (EKM) Get operation returns EKM connection. This operation requires ekm/read permission.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Foundations.Operation is necessary for Key Vault"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For older endpoints, yes. Why can't you use them for new endpoints? While it's important to maintain consistency within a service, you weren't far off from what standard operation bases provide in terms of endpoint construction. Did you even try?

*/
model EkmProxyInfo {
/**
* The highest supported proxy interface api version supported by the EKM proxy.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicate word.. you can say "The highest version of proxy interface API supported by the EKM Proxy"

*/
model EkmConnection {
/**
* EKM proxy FQDM (Fully Qualified Domain Name). Only allowed characters are a-z, A-Z, 0-9, hyphen (-), dot (.), and colon (:).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FQDN

"host": "ekm-proxy.contoso.com",
"path_prefix": "/api/v1",
"server_ca_certificates": [
"MIIDXTCCAkWgAwIBAgIJAKJ5cT5dQnCuMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMjQwMTAxMDAwMDAwWhcNMjUwMTAxMDAwMDAwWjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these valid DER format strings?
I tried wrapping them in a PEM headers (BEGIN/END CERTIFICATE), but couldn't open the resulting cer file.

@@ -0,0 +1,19 @@
{
"parameters": {
"vaultBaseUrl": "https://myvault.vault.azure.net/",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use managed hsm base urls in these example files.

"responses": {
"200": {
"body": {
"host": "ekm-proxy.contoso.com:8443",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the port.. just to be consistent with the createekmconnection example.

Copy link
Member

@chandanrr chandanrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have left minor feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants