Commit 679b073
Do not use armCommonDefinition for customer managed keys (#4627)
## Summary
Hides the \CustomerManagedKeyEncryption\, \KeyEncryptionKeyIdentity\,
and \KeyEncryptionKeyIdentityType\ common types by marking them
\internal\ in the TypeSpec language, preventing direct use in service
specifications outside the \Azure.ResourceManager\ namespace.
Adds public replacement types in \Azure.ResourceManager.Foundations\:
- \CustomerManagedKeyEncryptionV4\
- \KeyEncryptionKeyIdentityV4\
- \KeyEncryptionKeyIdentityTypeV4\
The \Encryption\ wrapper type remains public and continues to work as
before.
### Usage
\\\ sp
@armProviderNamespace
@service
namespace Microsoft.Contoso;
model EncryptionConfig {
customerManagedKey?:
Azure.ResourceManager.Foundations.CustomerManagedKeyEncryptionV4;
}
\\\
### Testing
- 5 new tests verifying the V4 types work and the internal types are
inaccessible from outside
- All 329 existing ARM package tests pass
- Docs regenerated (internal types no longer appear in reference docs)
Related to #4532 (alternative approach using \internal\ keyword instead
of decorator + linter rule)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>1 parent aa83552 commit 679b073
4 files changed
Lines changed: 126 additions & 45 deletions
File tree
- .chronus/changes
- packages
- samples/test/output/azure/resource-manager/resource-common-properties/encryption/@azure-tools/typespec-autorest/2023-03-01-preview
- typespec-azure-resource-manager/lib/common-types
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
Lines changed: 111 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
367 | 367 | | |
368 | 368 | | |
369 | 369 | | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
| 479 | + | |
370 | 480 | | |
371 | 481 | | |
372 | 482 | | |
| |||
452 | 562 | | |
453 | 563 | | |
454 | 564 | | |
455 | | - | |
| 565 | + | |
456 | 566 | | |
457 | 567 | | |
458 | 568 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
Lines changed: 0 additions & 43 deletions
This file was deleted.
0 commit comments