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

Update default values and descriptions for Key Vault on API Version 2024-11-01 #31713

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Merge branch 'main' into release-keyvault-Microsoft.KeyVault-stable/2…

2908f1b
Select commit
Loading
Failed to load commit list.
Open

Update default values and descriptions for Key Vault on API Version 2024-11-01 #31713

Merge branch 'main' into release-keyvault-Microsoft.KeyVault-stable/2…
2908f1b
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Breaking Change(Cross-Version) completed Dec 6, 2024 in 3m 28s

Check `Breaking Change(Cross-Version)` detected problems

Detected: 3 Errors, 5 Warnings
The check status is neutral due to the check being suppressed by a label matching pattern BreakingChange-Approved-*.
View Azure DevOps build log for more details.

Important

To see the full list of breaking changes messages, with all the details available:
In the relevant ADO build (see the link above), find the job CrossVersionBreakingChange, then the task within, also called CrossVersionBreakingChange.
In the task's build log, search for Full list of messages.

Details

Compared specs (v0.10.13) new version base version
common.json 2024-11-01(2908f1b) 2023-07-01(main)
common.json 2024-11-01(2908f1b) 2024-04-01-preview(main)
keys.json 2024-11-01(2908f1b) 2023-07-01(main)
keys.json 2024-11-01(2908f1b) 2024-04-01-preview(main)
keysManagedHsm.json 2024-11-01(2908f1b) 2023-07-01(main)
keysManagedHsm.json 2024-11-01(2908f1b) 2024-04-01-preview(main)
keyvault.json 2024-11-01(2908f1b) 2023-07-01(main)
keyvault.json 2024-11-01(2908f1b) 2024-04-01-preview(main)
managedHsm.json 2024-11-01(2908f1b) 2023-07-01(main)
managedHsm.json 2024-11-01(2908f1b) 2024-04-01-preview(main)
providers.json 2024-11-01(2908f1b) 2023-07-01(main)
providers.json 2024-11-01(2908f1b) 2024-04-01-preview(main)
secrets.json 2024-11-01(2908f1b) 2023-07-01(main)
secrets.json 2024-11-01(2908f1b) 2024-04-01-preview(main)

The following breaking changes have been detected in comparison to the latest stable version

1027 - DefaultValueChanged

Displaying 3 out of 3 occurrences.

Index Description
1 The new version has a different default value than the previous one.
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L1244:9
definitions.VaultProperties.properties.enabledForDeployment
Old: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L1244:9
2 The new version has a different default value than the previous one.
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L1249:9
definitions.VaultProperties.properties.enabledForDiskEncryption
Old: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L1248:9
3 The new version has a different default value than the previous one.
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L1254:9
definitions.VaultProperties.properties.enabledForTemplateDeployment
Old: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L1252:9

💬 1020 - AddedEnumValue

Displaying 2 out of 2 occurrences.

Index Description
1 The new version is adding enum value(s) 'C' from the old version.
New: Microsoft.KeyVault/stable/2024-11-01/managedHsm.json#L897:9
definitions.ManagedHsmSku.properties.family
Old: Microsoft.KeyVault/stable/2023-07-01/managedHsm.json#L897:9
2 The new version is adding enum value(s) 'Custom_C42, Custom_C10' from the old version.
New: Microsoft.KeyVault/stable/2024-11-01/managedHsm.json#L910:9
definitions.ManagedHsmSku.properties.name
Old: Microsoft.KeyVault/stable/2023-07-01/managedHsm.json#L909:9

The following breaking changes have been detected in comparison to the latest preview version

⚠️ 1005 - RemovedPath

Displaying 2 out of 2 occurrences.

Index Description
1 The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/networkSecurityPerimeterConfigurations' removed or restructured?
Old: Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json#L1027:5
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/networkSecurityPerimeterConfigurations']
2 The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/networkSecurityPerimeterConfigurations/{associationProxyName}' removed or restructured?
Old: Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json#L1075:5
paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/networkSecurityPerimeterConfigurations/{associationProxyName}']

⚠️ 1027 - DefaultValueChanged

Displaying 3 out of 3 occurrences.

Index Description
1 The new version has a different default value than the previous one.
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L1244:9
definitions.VaultProperties.properties.enabledForDeployment
Old: Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json#L1340:9
2 The new version has a different default value than the previous one.
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L1249:9
definitions.VaultProperties.properties.enabledForDiskEncryption
Old: Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json#L1344:9
3 The new version has a different default value than the previous one.
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L1254:9
definitions.VaultProperties.properties.enabledForTemplateDeployment
Old: Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json#L1348:9

💬 1007 - RemovedClientParameter

Displaying 1 out of 1 occurrences.

Index Description
1 The new version is missing a client parameter that was found in the old version. Was 'AssociationProxyNameParameter' removed or renamed?
New: Microsoft.KeyVault/stable/2024-11-01/keyvault.json#L2032:3
parameters
Old: Microsoft.KeyVault/preview/2024-04-01-preview/keyvault.json#L2125:3

💬 1020 - AddedEnumValue

Displaying 2 out of 2 occurrences.

Index Description
1 The new version is adding enum value(s) 'C' from the old version.
New: Microsoft.KeyVault/stable/2024-11-01/managedHsm.json#L897:9
definitions.ManagedHsmSku.properties.family
Old: Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json#L897:9
2 The new version is adding enum value(s) 'Custom_C42, Custom_C10' from the old version.
New: Microsoft.KeyVault/stable/2024-11-01/managedHsm.json#L910:9
definitions.ManagedHsmSku.properties.name
Old: Microsoft.KeyVault/preview/2024-04-01-preview/managedHsm.json#L909:9