Skip to content

Commit ea20c46

Browse files
melissamservCopilot
melissamserv
and
Copilot
authored
Key Vault 2026-03-01-preview API version (#42905)
* Add 2026-03-01-preview API version to all KeyVault data-plane services Add new preview API version 2026-03-01-preview to Certificates, Keys, Secrets, SecurityDomain, and Administration services. This includes: - Version enum entries in all main.tsp files - Updated readme.md default tags and new tag sections - Example files copied from 2026-01-01-preview with updated api-version - Generated OpenAPI specs via tsp compile Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add PlatformManaged property to CertificatePolicy for 2026-03-01-preview Add new PlatformManaged model and property to CertificatePolicy, version-gated with @added for 2026-03-01-preview. This feature is currently intended for internal use only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Format keyvault data-plane files with prettier Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove encodedName from PlatformManaged properties to use camel case Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update PlatformManaged model: improve comments and change metadata type to Record Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix markdown formatting in Administration readme.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 1e08765 commit ea20c46

268 files changed

Lines changed: 16190 additions & 535 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎specification/keyvault/data-plane/Administration/BackupRestore/main.tsp‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,9 @@ enum Versions {
7272
* The 2026-01-01-preview API version.
7373
*/
7474
v2026_01_01_preview: "2026-01-01-preview",
75+
76+
/**
77+
* The 2026-03-01-preview API version.
78+
*/
79+
v2026_03_01_preview: "2026-03-01-preview",
7580
}

‎specification/keyvault/data-plane/Administration/EKM/main.tsp‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,9 @@ enum Versions {
4747
* The 2026-01-01-preview API version.
4848
*/
4949
v2026_01_01_preview: "2026-01-01-preview",
50+
51+
/**
52+
* The 2026-03-01-preview API version.
53+
*/
54+
v2026_03_01_preview: "2026-03-01-preview",
5055
}

‎specification/keyvault/data-plane/Administration/RBAC/main.tsp‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,9 @@ enum Versions {
7272
* The 2026-01-01-preview API version.
7373
*/
7474
v2026_01_01_preview: "2026-01-01-preview",
75+
76+
/**
77+
* The 2026-03-01-preview API version.
78+
*/
79+
v2026_03_01_preview: "2026-03-01-preview",
7580
}

‎specification/keyvault/data-plane/Administration/Settings/main.tsp‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,9 @@ enum Versions {
7272
* The 2026-01-01-preview API version.
7373
*/
7474
v2026_01_01_preview: "2026-01-01-preview",
75+
76+
/**
77+
* The 2026-03-01-preview API version.
78+
*/
79+
v2026_03_01_preview: "2026-03-01-preview",
7580
}

‎specification/keyvault/data-plane/Administration/examples/2026-03-01-preview/CheckEkmConnection-example.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"parameters": {
3+
"vaultBaseUrl": "https://myhsm.managedhsm.azure.net",
4+
"api-version": "2026-03-01-preview"
5+
},
6+
"responses": {
7+
"200": {
8+
"body": {
9+
"api_version": "1.0.0",
10+
"proxy_vendor": "Contoso Technologies",
11+
"proxy_name": "Contoso EKM Proxy v2.5.1",
12+
"ekm_vendor": "Contoso HSM Solutions",
13+
"ekm_product": "Contoso Enterprise HSM v3.2.0"
14+
}
15+
}
16+
},
17+
"operationId": "CheckEkmConnection",
18+
"title": "Check EKM connection"
19+
}

‎specification/keyvault/data-plane/Administration/examples/2026-03-01-preview/CreateEkmConnection-example.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"parameters": {
3+
"vaultBaseUrl": "https://myhsm.managedhsm.azure.net",
4+
"api-version": "2026-03-01-preview",
5+
"ekmConnection": {
6+
"host": "ekm-proxy.contoso.com",
7+
"path_prefix": "/api/v1",
8+
"server_ca_certificates": [
9+
"MIIDqzCCApOgAwIBAgIUfSB4+gRfa1ngCW2wDhgweSni3TUwDQYJKoZIhvcNAQELBQAwZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlVTMRAwDgYDVQQHDAdSZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC2NvbnRvc28uY29tMB4XDTI1MTExODAwNTE0OFoXDTI2MDExNzAwNTE0OFowZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlVTMRAwDgYDVQQHDAdSZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC2NvbnRvc28uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtd/dBXc3iwA8ScsZJkCugNoW5W7bog6EQ6mO6AyQat/ifl3snGFTW5r/pA0aXLXcG5XwpgRl6DHQv7mt2ZxvxEizBbG3MFK6yppd3pCc9wJQ2I5NphtX1cmSeBAiTp7vFHgUaArjxRbwjijzU2G0LhR/ld4PQ9ElorQHHn0sdw+gOPJiabHN6/QKufqy2ZrNngJi2tqVbsxmqaslGcAVA8eNbHjgzCiLDIXD/YJMUUOVIRNGn50k7QxqJJWSrewQBwFDCaOJ8eEBxraidpNP9NvXhNFBoNiSB/ZdCvtYvqN5hkXEth7Nmcl/7claYEmc+YvHY4YwcVYtBpHJD9JYdQIDAQABo1MwUTAdBgNVHQ4EFgQU1T75G9kJNDBoxR7VYtJYY0KurQEwHwYDVR0jBBgwFoAU1T75G9kJNDBoxR7VYtJYY0KurQEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAMF3bKNC6DyJTJ4Jp9O/ANyydoKjkNLzHscYoYwetEC5Zccj9JxyzBoQ2TBZLyTNeXiDZ6ZMFzfyz7X8Fi4cFMBhAISEjuiR+O6IDZfBnQYPzZnulSoxqQrqzOCACqcWzAu/Y9WXC32cays8uEhMYxinKHkDDOKRsCA55MONG6FZCSWCiPXd7ym6lsoJ7T7ysbeuWanKClOIVReS9l2sqt6IYCUrvd0Eireue70wyykk4Y+JHqBp3klCpLLyKMKjH/79/xZvYC5HJeckeCHXFP3YwagGlEOERmR6CqpO6npSAU5bsJoeWRB9Y5yCkILdKNHKfprKlIqzO23nYYWq7gw=="
10+
]
11+
}
12+
},
13+
"responses": {
14+
"200": {
15+
"body": {
16+
"host": "ekm-proxy.contoso.com",
17+
"path_prefix": "/api/v1",
18+
"server_ca_certificates": [
19+
"MIIDqzCCApOgAwIBAgIUfSB4+gRfa1ngCW2wDhgweSni3TUwDQYJKoZIhvcNAQELBQAwZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlVTMRAwDgYDVQQHDAdSZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC2NvbnRvc28uY29tMB4XDTI1MTExODAwNTE0OFoXDTI2MDExNzAwNTE0OFowZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlVTMRAwDgYDVQQHDAdSZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC2NvbnRvc28uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtd/dBXc3iwA8ScsZJkCugNoW5W7bog6EQ6mO6AyQat/ifl3snGFTW5r/pA0aXLXcG5XwpgRl6DHQv7mt2ZxvxEizBbG3MFK6yppd3pCc9wJQ2I5NphtX1cmSeBAiTp7vFHgUaArjxRbwjijzU2G0LhR/ld4PQ9ElorQHHn0sdw+gOPJiabHN6/QKufqy2ZrNngJi2tqVbsxmqaslGcAVA8eNbHjgzCiLDIXD/YJMUUOVIRNGn50k7QxqJJWSrewQBwFDCaOJ8eEBxraidpNP9NvXhNFBoNiSB/ZdCvtYvqN5hkXEth7Nmcl/7claYEmc+YvHY4YwcVYtBpHJD9JYdQIDAQABo1MwUTAdBgNVHQ4EFgQU1T75G9kJNDBoxR7VYtJYY0KurQEwHwYDVR0jBBgwFoAU1T75G9kJNDBoxR7VYtJYY0KurQEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAMF3bKNC6DyJTJ4Jp9O/ANyydoKjkNLzHscYoYwetEC5Zccj9JxyzBoQ2TBZLyTNeXiDZ6ZMFzfyz7X8Fi4cFMBhAISEjuiR+O6IDZfBnQYPzZnulSoxqQrqzOCACqcWzAu/Y9WXC32cays8uEhMYxinKHkDDOKRsCA55MONG6FZCSWCiPXd7ym6lsoJ7T7ysbeuWanKClOIVReS9l2sqt6IYCUrvd0Eireue70wyykk4Y+JHqBp3klCpLLyKMKjH/79/xZvYC5HJeckeCHXFP3YwagGlEOERmR6CqpO6npSAU5bsJoeWRB9Y5yCkILdKNHKfprKlIqzO23nYYWq7gw=="
20+
]
21+
}
22+
}
23+
},
24+
"operationId": "CreateEkmConnection",
25+
"title": "Create EKM connection"
26+
}

‎specification/keyvault/data-plane/Administration/examples/2026-03-01-preview/DeleteEkmConnection-example.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"parameters": {
3+
"vaultBaseUrl": "https://myhsm.managedhsm.azure.net",
4+
"api-version": "2026-03-01-preview"
5+
},
6+
"responses": {
7+
"200": {
8+
"body": {
9+
"host": "ekm-proxy.contoso.com",
10+
"path_prefix": "/api/v1",
11+
"server_ca_certificates": [
12+
"MIIDqzCCApOgAwIBAgIUfSB4+gRfa1ngCW2wDhgweSni3TUwDQYJKoZIhvcNAQELBQAwZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlVTMRAwDgYDVQQHDAdSZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC2NvbnRvc28uY29tMB4XDTI1MTExODAwNTE0OFoXDTI2MDExNzAwNTE0OFowZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAlVTMRAwDgYDVQQHDAdSZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMMC2NvbnRvc28uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtd/dBXc3iwA8ScsZJkCugNoW5W7bog6EQ6mO6AyQat/ifl3snGFTW5r/pA0aXLXcG5XwpgRl6DHQv7mt2ZxvxEizBbG3MFK6yppd3pCc9wJQ2I5NphtX1cmSeBAiTp7vFHgUaArjxRbwjijzU2G0LhR/ld4PQ9ElorQHHn0sdw+gOPJiabHN6/QKufqy2ZrNngJi2tqVbsxmqaslGcAVA8eNbHjgzCiLDIXD/YJMUUOVIRNGn50k7QxqJJWSrewQBwFDCaOJ8eEBxraidpNP9NvXhNFBoNiSB/ZdCvtYvqN5hkXEth7Nmcl/7claYEmc+YvHY4YwcVYtBpHJD9JYdQIDAQABo1MwUTAdBgNVHQ4EFgQU1T75G9kJNDBoxR7VYtJYY0KurQEwHwYDVR0jBBgwFoAU1T75G9kJNDBoxR7VYtJYY0KurQEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAMF3bKNC6DyJTJ4Jp9O/ANyydoKjkNLzHscYoYwetEC5Zccj9JxyzBoQ2TBZLyTNeXiDZ6ZMFzfyz7X8Fi4cFMBhAISEjuiR+O6IDZfBnQYPzZnulSoxqQrqzOCACqcWzAu/Y9WXC32cays8uEhMYxinKHkDDOKRsCA55MONG6FZCSWCiPXd7ym6lsoJ7T7ysbeuWanKClOIVReS9l2sqt6IYCUrvd0Eireue70wyykk4Y+JHqBp3klCpLLyKMKjH/79/xZvYC5HJeckeCHXFP3YwagGlEOERmR6CqpO6npSAU5bsJoeWRB9Y5yCkILdKNHKfprKlIqzO23nYYWq7gw=="
13+
]
14+
}
15+
}
16+
},
17+
"operationId": "DeleteEkmConnection",
18+
"title": "Delete EKM connection"
19+
}

‎specification/keyvault/data-plane/Administration/examples/2026-03-01-preview/DeleteRoleAssignments-example.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"operationId": "RoleAssignments_Delete",
3+
"title": "Delete a role assignment",
4+
"parameters": {
5+
"vaultBaseUrl": "https://myvault.vault.azure.net/",
6+
"scope": "keys",
7+
"roleAssignmentName": "roleAssignmentName",
8+
"api-version": "2026-03-01-preview"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"properties": {
14+
"roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
15+
"principalId": "principalId",
16+
"scope": "/keys"
17+
},
18+
"id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId",
19+
"type": "Microsoft.Authorization/roleAssignments",
20+
"name": "roleAssignmentId"
21+
}
22+
}
23+
}
24+
}

‎specification/keyvault/data-plane/Administration/examples/2026-03-01-preview/DeleteRoleDefinition-example.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"operationId": "RoleDefinitions_Delete",
3+
"title": "Delete a custom role definition",
4+
"parameters": {
5+
"vaultBaseUrl": "https://myvault.vault.azure.net/",
6+
"scope": "keys",
7+
"roleDefinitionName": "00000000-0000-0000-0000-000000000000",
8+
"api-version": "2026-03-01-preview"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"properties": {
14+
"roleName": "My custom role",
15+
"type": "CustomRole",
16+
"description": "Role description",
17+
"assignableScopes": [
18+
"/"
19+
],
20+
"permissions": [
21+
{
22+
"dataActions": [
23+
"Microsoft.KeyVault/managedHsm/keys/sign/action"
24+
]
25+
}
26+
]
27+
},
28+
"id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000",
29+
"type": "Microsoft.Authorization/roleDefinitions",
30+
"name": "00000000-0000-0000-0000-000000000000"
31+
}
32+
}
33+
}
34+
}

‎specification/keyvault/data-plane/Administration/examples/2026-03-01-preview/FullBackup-example.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"operationId": "FullBackup",
3+
"title": "Create a full backup",
4+
"parameters": {
5+
"vaultBaseUrl": "https://myvault.vault.azure.net/",
6+
"azureStorageBlobContainerUri": {
7+
"storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer",
8+
"token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED"
9+
},
10+
"api-version": "2026-03-01-preview"
11+
},
12+
"responses": {
13+
"202": {
14+
"headers": {
15+
"Retry-After": 5,
16+
"Azure-AsyncOperation": "https://myvault.vault.azure.net/backup/45aacd568ab049a2803861e8dd3ae21f/pending"
17+
},
18+
"body": {
19+
"status": "InProgress",
20+
"statusDetails": "Full backup is in progress",
21+
"azureStorageBlobContainerUri": "https://myaccount.blob.core.windows.net/sascontainer/fullbackup-pool-61e8dd3ae21f-1579243113",
22+
"jobId": "45aacd568ab049a2803861e8dd3ae21f",
23+
"startTime": 1490790000,
24+
"endTime": 0
25+
}
26+
}
27+
}
28+
}

0 commit comments

Comments
 (0)