LedgerOperations interface

Package:

@azure/arm-confidentialledger

Interface representing a Ledger operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginFilesExport
beginFilesExportAndWait
beginUpdate
beginUpdateAndWait
create	Creates a Confidential Ledger with the specified ledger parameters.
delete	Deletes an existing Confidential Ledger.
filesExport	Copies the ledger files and the service certificate to a customer's storage account of choice.
get	Retrieves the properties of a Confidential Ledger.
listByResourceGroup	Retrieves the properties of all Confidential Ledgers.
listBySubscription	Retrieves the properties of all Confidential Ledgers.
update	Updates properties of Confidential Ledger

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams) => Promise<ConfidentialLedger>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams) => Promise<ConfidentialLedger>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams) => Promise<void>

beginFilesExport

Warning

This API is now deprecated.

use filesExport instead

beginFilesExport: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedgerFilesExport, options?: LedgerFilesExportOptionalParams) => Promise<SimplePollerLike<OperationState<ConfidentialLedgerFilesExportResponse>, ConfidentialLedgerFilesExportResponse>>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedgerFilesExport, options?: LedgerFilesExportOptionalParams) => Promise<SimplePollerLike<OperationState<ConfidentialLedgerFilesExportResponse>, ConfidentialLedgerFilesExportResponse>>

beginFilesExportAndWait

Warning

This API is now deprecated.

use filesExport instead

beginFilesExportAndWait: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedgerFilesExport, options?: LedgerFilesExportOptionalParams) => Promise<ConfidentialLedgerFilesExportResponse>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedgerFilesExport, options?: LedgerFilesExportOptionalParams) => Promise<ConfidentialLedgerFilesExportResponse>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams) => Promise<ConfidentialLedger>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams) => Promise<ConfidentialLedger>

create

Creates a Confidential Ledger with the specified ledger parameters.

create: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams) => PollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams) => PollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>

delete

Deletes an existing Confidential Ledger.

delete: (resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams) => PollerLike<OperationState<void>, void>

filesExport

Copies the ledger files and the service certificate to a customer's storage account of choice.

filesExport: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedgerFilesExport, options?: LedgerFilesExportOptionalParams) => PollerLike<OperationState<ConfidentialLedgerFilesExportResponse>, ConfidentialLedgerFilesExportResponse>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedgerFilesExport, options?: LedgerFilesExportOptionalParams) => PollerLike<OperationState<ConfidentialLedgerFilesExportResponse>, ConfidentialLedgerFilesExportResponse>

get

Retrieves the properties of a Confidential Ledger.

get: (resourceGroupName: string, ledgerName: string, options?: LedgerGetOptionalParams) => Promise<ConfidentialLedger>

Property Value

(resourceGroupName: string, ledgerName: string, options?: LedgerGetOptionalParams) => Promise<ConfidentialLedger>

listByResourceGroup

Retrieves the properties of all Confidential Ledgers.

listByResourceGroup: (resourceGroupName: string, options?: LedgerListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ConfidentialLedger, ConfidentialLedger[], PageSettings>

Property Value

(resourceGroupName: string, options?: LedgerListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ConfidentialLedger, ConfidentialLedger[], PageSettings>

listBySubscription

Retrieves the properties of all Confidential Ledgers.

listBySubscription: (options?: LedgerListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ConfidentialLedger, ConfidentialLedger[], PageSettings>

Property Value

(options?: LedgerListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ConfidentialLedger, ConfidentialLedger[], PageSettings>

update

Updates properties of Confidential Ledger

update: (resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams) => PollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>

Property Value

(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams) => PollerLike<OperationState<ConfidentialLedger>, ConfidentialLedger>