Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzConfidentialLedger
- Module:
- Az.ConfidentialLedger Module
Create a Confidential Ledger with the specified ledger parameters.
Syntax
Default (Default)
New-AzConfidentialLedger
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AadBasedSecurityPrincipal <IAadBasedSecurityPrincipal[]>]
[-CertBasedSecurityPrincipal <ICertBasedSecurityPrincipal[]>]
[-LedgerType <String>]
[-Location <String>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create 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.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AsJob
Run the command as a job
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CertBasedSecurityPrincipal
Array of all cert based Security Principals.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-LedgerType
Type of Confidential Ledger
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Location
The Azure location where the Confidential Ledger is running.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of the Confidential Ledger
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | LedgerName |
Parameter sets
-NoWait
Run the command asynchronously
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Tag
Additional tags for Confidential Ledger
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
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
IConfidentialLedger
Azure PowerShell
Feedback
Was this page helpful?