Get-AzConfidentialLedger

Reference

Module:: Az.ConfidentialLedger

Retrieves the properties of a Confidential Ledger.

Syntax

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

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

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

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.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IConfidentialLedgerIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-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

Inputs

IConfidentialLedgerIdentity

Outputs

IConfidentialLedger

Share via