Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzConfidentialLedger

Retrieves the properties of a Confidential Ledger.

Syntax

List1 (Default) 

Get-AzConfidentialLedger
 [-SubscriptionId <String[]>]
 [-Filter <String>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Get 

Get-AzConfidentialLedger
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

List 

Get-AzConfidentialLedger
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-Filter <String>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentity 

Get-AzConfidentialLedger
 -InputObject <IConfidentialLedgerIdentity>
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Description

Retrieves the properties of a Confidential Ledger.

Examples

Example 1: List Confidential Ledgers

Get-AzConfidentialLedger `
 -SubscriptionId 00000000-0000-0000-0000-000000000000

Location Name
eastus testledger0
eastus testledger1
eastus testledger2

Lists all the Confidential Ledgers under a subscription.

Example 2: Get a Confidential Ledger

Get-AzConfidentialLedger `
 -Name test-ledger `
 -ResourceGroupName test-rg

Location Name
eastus test-ledger

Lists all the Confidential Ledgers under a resource group.

Parameters

-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

-Filter

The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-InputObject

Identity Parameter

Parameter properties

Type:IConfidentialLedgerIdentity
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

-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

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.

Inputs

IConfidentialLedgerIdentity

Outputs

IConfidentialLedger

Feedback

Was this page helpful?