Skip to content

[Az.ConfidentialLedger] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28277

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
// is regenerated.

using System;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - ConfidentialLedger")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.1.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("1.1.0")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]

16 changes: 16 additions & 0 deletions src/ConfidentialLedger/ConfidentialLedger.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,20 @@ directive:
- model-cmdlet: # Generate objects for common models.
- AADBasedSecurityPrincipal
- CertBasedSecurityPrincipal

- where:
verb: Get|New
subject: Ledger
set:
breaking-change:
deprecated-output-properties:
- AadBasedSecurityPrincipal
- CertBasedSecurityPrincipal
new-output-properties:
- AadBasedSecurityPrincipal
- CertBasedSecurityPrincipal
change-description: The type of property 'AadBasedSecurityPrincipal', 'CertBasedSecurityPrincipal' will be changed from single object to 'List'.
deprecated-by-version: 9.0.0
deprecated-by-azversion: 15.0.0
change-effective-date: 2025/11/03
```
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ https://learn.microsoft.com/powershell/module/az.confidentialledger/update-azcon
#>
function Update-AzConfidentialLedger {
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IConfidentialLedger])]
[Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IConfidentialLedger", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IConfidentialLedger", DeprecatedOutputProperties = ("AadBasedSecurityPrincipal Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IAadBasedSecurityPrincipal", "CertBasedSecurityPrincipal Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.ICertBasedSecurityPrincipal"), NewOutputProperties = ("AadBasedSecurityPrincipal System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IAadBasedSecurityPrincipal]", "CertBasedSecurityPrincipal System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.ICertBasedSecurityPrincipal]"))]
[CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]
param(
[Parameter(ParameterSetName='UpdateExpanded', Mandatory)]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Module Name: Az.ConfidentialLedger
Module Guid: c7eaa9c1-72c4-4251-9e7d-bf9b8e8fa71e
Module Guid: 2c3b46ee-4d07-486a-8677-2a7833ee933a
Download Help Link: https://learn.microsoft.com/powershell/module/az.confidentialledger
Help Version: 1.0.0.0
Locale: en-US
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ New-AzConfidentialLedger `
-AadBasedSecurityPrincipal `
@{
LedgerRoleName="Administrator";
PrincipalId="34621747-6fc8-4771-a2eb-72f31c461f2e";
TenantId="bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
PrincipalId="00001111-aaaa-2222-bbbb-3333cccc4444";
TenantId="00001111-aaaa-2222-bbbb-3333cccc4444"
} `
-CertBasedSecurityPrincipal `
@{
Expand All @@ -57,8 +57,8 @@ Creates a new Confidential Ledger.
```powershell
$aadSecurityPrincipal = New-AzConfidentialLedgerAADBasedSecurityPrincipalObject `
-LedgerRoleName "Administrator" `
-PrincipalId "34621747-6fc8-4771-a2eb-72f31c461f2e" `
-TenantId "bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
-PrincipalId "00001111-aaaa-2222-bbbb-3333cccc4444" `
-TenantId "00001111-aaaa-2222-bbbb-3333cccc4444"

$certSecurityPrincipal = New-AzConfidentialLedgerCertBasedSecurityPrincipalObject `
-Cert "-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----" `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ Create an in-memory object for AADBasedSecurityPrincipal.
```powershell
New-AzConfidentialLedgerAADBasedSecurityPrincipalObject `
-LedgerRoleName "Administrator" `
-PrincipalId "34621747-6fc8-4771-a2eb-72f31c461f2e" `
-TenantId "bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
-PrincipalId "00001111-aaaa-2222-bbbb-3333cccc4444" `
-TenantId "00001111-aaaa-2222-bbbb-3333cccc4444"
```

```output
LedgerRoleName PrincipalId TenantId
-------------- ----------- --------
Administrator 34621747-6fc8-4771-a2eb-72f31c461f2e bce123b9-2b7b-4975-8360-5ca0b9b1cd08
Administrator 00001111-aaaa-2222-bbbb-3333cccc4444 00001111-aaaa-2222-bbbb-3333cccc4444
```

Creates an AadBasedSecurityPrincipalObject that may be used for `Az.ConfidentialLedger` commands.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Update-AzConfidentialLedger `
-AadBasedSecurityPrincipal `
@{
LedgerRoleName="Administrator";
PrincipalId="34621747-6fc8-4771-a2eb-72f31c461f2e";
TenantId="bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
PrincipalId="00001111-aaaa-2222-bbbb-3333cccc4444";
TenantId="00001111-aaaa-2222-bbbb-3333cccc4444"
} `
-CertBasedSecurityPrincipal `
@{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ New-AzConfidentialLedger `
-AadBasedSecurityPrincipal `
@{
LedgerRoleName="Administrator";
PrincipalId="34621747-6fc8-4771-a2eb-72f31c461f2e";
TenantId="bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
PrincipalId="00001111-aaaa-2222-bbbb-3333cccc4444";
TenantId="00001111-aaaa-2222-bbbb-3333cccc4444"
} `
-CertBasedSecurityPrincipal `
@{
Expand All @@ -31,8 +31,8 @@ Creates a new Confidential Ledger.
```powershell
$aadSecurityPrincipal = New-AzConfidentialLedgerAADBasedSecurityPrincipalObject `
-LedgerRoleName "Administrator" `
-PrincipalId "34621747-6fc8-4771-a2eb-72f31c461f2e" `
-TenantId "bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
-PrincipalId "00001111-aaaa-2222-bbbb-3333cccc4444" `
-TenantId "00001111-aaaa-2222-bbbb-3333cccc4444"

$certSecurityPrincipal = New-AzConfidentialLedgerCertBasedSecurityPrincipalObject `
-Cert "-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----" `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
```powershell
New-AzConfidentialLedgerAADBasedSecurityPrincipalObject `
-LedgerRoleName "Administrator" `
-PrincipalId "34621747-6fc8-4771-a2eb-72f31c461f2e" `
-TenantId "bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
-PrincipalId "00001111-aaaa-2222-bbbb-3333cccc4444" `
-TenantId "00001111-aaaa-2222-bbbb-3333cccc4444"
```

```output
LedgerRoleName PrincipalId TenantId
-------------- ----------- --------
Administrator 34621747-6fc8-4771-a2eb-72f31c461f2e bce123b9-2b7b-4975-8360-5ca0b9b1cd08
Administrator 00001111-aaaa-2222-bbbb-3333cccc4444 00001111-aaaa-2222-bbbb-3333cccc4444
```

Creates an AadBasedSecurityPrincipalObject that may be used for `Az.ConfidentialLedger` commands.
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Update-AzConfidentialLedger `
-AadBasedSecurityPrincipal `
@{
LedgerRoleName="Administrator";
PrincipalId="34621747-6fc8-4771-a2eb-72f31c461f2e";
TenantId="bce123b9-2b7b-4975-8360-5ca0b9b1cd08"
PrincipalId="00001111-aaaa-2222-bbbb-3333cccc4444";
TenantId="00001111-aaaa-2222-bbbb-3333cccc4444"
} `
-CertBasedSecurityPrincipal `
@{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"generate_Id": "3b9ad9db-a65e-478f-a33d-c2d1b724f2ec"
"generate_Id": "5c0e647b-15ee-4e04-8d12-d71343b0026f"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Resources
This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder.

## Info
- Modifiable: yes
- Generated: no
- Committed: yes
- Packaged: no

## Purpose
Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact.
Loading