New-AzConfidentialLedger
Creates a Confidential Ledger with the specified ledger parameters.
Syntax
Default (Default)
New-AzConfidentialLedger
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AadBasedSecurityPrincipal <IAadBasedSecurityPrincipal[]>]
[-CertBasedSecurityPrincipal <ICertBasedSecurityPrincipal[]>]
[-LedgerType <LedgerType>]
[-Location <String>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Creates a Confidential Ledger with the specified ledger parameters.
Examples
Example 1: Create a new Confidential Ledger
New-AzConfidentialLedger `
-Name test-ledger `
-ResourceGroupName rg-000 `
-SubscriptionId 00000000-0000-0000-0000-000000000000 `
-AadBasedSecurityPrincipal `
@{
LedgerRoleName="Administrator";
PrincipalId="00001111-aaaa-2222-bbbb-3333cccc4444";
TenantId="00001111-aaaa-2222-bbbb-3333cccc4444"
} `
-CertBasedSecurityPrincipal `
@{
Cert="-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----";
LedgerRoleName="Reader"
} `
-LedgerType Public `
-Location eastus `
-Tag @{Location="additional properties 0"}
Location Name
eastus test-ledger
Creates a new Confidential Ledger.
Example 2: Create Using Security Principal Objects
$aadSecurityPrincipal = New-AzConfidentialLedgerAADBasedSecurityPrincipalObject `
-LedgerRoleName "Administrator" `
-PrincipalId "00001111-aaaa-2222-bbbb-3333cccc4444" `
-TenantId "00001111-aaaa-2222-bbbb-3333cccc4444"
$certSecurityPrincipal = New-AzConfidentialLedgerCertBasedSecurityPrincipalObject `
-Cert "-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----" `
-LedgerRoleName "Reader"
New-AzConfidentialLedger `
-Name test-ledger `
-ResourceGroupName rg-000 `
-SubscriptionId 00000000-0000-0000-0000-000000000000 `
-AadBasedSecurityPrincipal $aadSecurityPrincipal `
-CertBasedSecurityPrincipal $certSecurityPrincipal `
-LedgerType Public `
-Location eastus `
-Tag @{Location="additional properties 0"}
Location Name
eastus test-ledger
Creates a new Confidential Ledger using objects for AadBasedSecurityPrincipal and CertBasedSecurityPrincipal.
Parameters
-AadBasedSecurityPrincipal
Array of all AAD based Security Principals.
To construct, see NOTES section for AADBASEDSECURITYPRINCIPAL properties and create a hash table.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CertBasedSecurityPrincipal
Array of all cert based Security Principals.
To construct, see NOTES section for CERTBASEDSECURITYPRINCIPAL properties and create a hash table.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LedgerType
Type of Confidential Ledger
Parameter properties
Type: LedgerType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The Azure location where the Confidential Ledger is running.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the Confidential Ledger
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: LedgerName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The Azure subscription ID.
This is a GUID-formatted string (e.g.
00000000-0000-0000-0000-000000000000)
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Additional tags for Confidential Ledger
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
