Ledger interface
Interface representing a Ledger.
Methods
Method Details
beginCreate(string, string, ConfidentialLedger, LedgerCreateOptionalParams)
Creates a Confidential Ledger with the specified ledger parameters.
function beginCreate(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams): Promise<PollerLike<PollOperationState<ConfidentialLedger>, ConfidentialLedger>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- confidentialLedger
- ConfidentialLedger
Confidential Ledger Create Request Body
- options
- LedgerCreateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ConfidentialLedger>, ConfidentialLedger>>
beginCreateAndWait(string, string, ConfidentialLedger, LedgerCreateOptionalParams)
Creates a Confidential Ledger with the specified ledger parameters.
function beginCreateAndWait(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerCreateOptionalParams): Promise<ConfidentialLedger>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- confidentialLedger
- ConfidentialLedger
Confidential Ledger Create Request Body
- options
- LedgerCreateOptionalParams
The options parameters.
Returns
Promise<ConfidentialLedger>
beginDelete(string, string, LedgerDeleteOptionalParams)
Deletes an existing Confidential Ledger.
function beginDelete(resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- options
- LedgerDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, LedgerDeleteOptionalParams)
Deletes an existing Confidential Ledger.
function beginDeleteAndWait(resourceGroupName: string, ledgerName: string, options?: LedgerDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- options
- LedgerDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, ConfidentialLedger, LedgerUpdateOptionalParams)
Updates properties of Confidential Ledger
function beginUpdate(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams): Promise<PollerLike<PollOperationState<ConfidentialLedger>, ConfidentialLedger>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- confidentialLedger
- ConfidentialLedger
Confidential Ledger request body for Updating Ledger
- options
- LedgerUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ConfidentialLedger>, ConfidentialLedger>>
beginUpdateAndWait(string, string, ConfidentialLedger, LedgerUpdateOptionalParams)
Updates properties of Confidential Ledger
function beginUpdateAndWait(resourceGroupName: string, ledgerName: string, confidentialLedger: ConfidentialLedger, options?: LedgerUpdateOptionalParams): Promise<ConfidentialLedger>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- confidentialLedger
- ConfidentialLedger
Confidential Ledger request body for Updating Ledger
- options
- LedgerUpdateOptionalParams
The options parameters.
Returns
Promise<ConfidentialLedger>
get(string, string, LedgerGetOptionalParams)
Retrieves the properties of a Confidential Ledger.
function get(resourceGroupName: string, ledgerName: string, options?: LedgerGetOptionalParams): Promise<ConfidentialLedger>Parameters
- resourceGroupName
-
string
The name of the resource group.
- ledgerName
-
string
Name of the Confidential Ledger
- options
- LedgerGetOptionalParams
The options parameters.
Returns
Promise<ConfidentialLedger>
listByResourceGroup(string, LedgerListByResourceGroupOptionalParams)
Retrieves the properties of all Confidential Ledgers.
function listByResourceGroup(resourceGroupName: string, options?: LedgerListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ConfidentialLedger, ConfidentialLedger[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listBySubscription(LedgerListBySubscriptionOptionalParams)
Retrieves the properties of all Confidential Ledgers.
function listBySubscription(options?: LedgerListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ConfidentialLedger, ConfidentialLedger[], PageSettings>Parameters
The options parameters.