New-AzConfidentialLedger
Creates a Confidential Ledger with the specified ledger parameters.
Syntax
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-ledgerCreates 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-ledgerCreates 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.
| Type: | IAadBasedSecurityPrincipal[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CertBasedSecurityPrincipal
Array of all cert based Security Principals. To construct, see NOTES section for CERTBASEDSECURITYPRINCIPAL properties and create a hash table.
| Type: | ICertBasedSecurityPrincipal[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LedgerType
Type of Confidential Ledger
| Type: | LedgerType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The Azure location where the Confidential Ledger is running.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Name of the Confidential Ledger
| Type: | String |
| Aliases: | LedgerName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
Additional tags for Confidential Ledger
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |