Ledgers Interface

Package:

com.azure.resourcemanager.confidentialledger.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-confidentialledger:1.0.0-beta.5

public interface Ledgers

Resource collection API of Ledgers.

Method Summary

Modifier and Type	Method and Description
abstract ConfidentialLedgerBackupResponse	backup(String resourceGroupName, String ledgerName, ConfidentialLedgerBackup confidentialLedger) Performs the backup operation on a Confidential Ledger Resource.
abstract ConfidentialLedgerBackupResponse	backup(String resourceGroupName, String ledgerName, ConfidentialLedgerBackup confidentialLedger, Context context) Performs the backup operation on a Confidential Ledger Resource.
abstract Blank	define(String name) Begins definition for a new ConfidentialLedger resource.
abstract void	delete(String resourceGroupName, String ledgerName, Context context) Deletes a Confidential Ledger resource.
abstract void	deleteById(String id) Deletes a Confidential Ledger resource.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes a Confidential Ledger resource.
abstract void	deleteByResourceGroup(String resourceGroupName, String ledgerName) Deletes a Confidential Ledger resource.
abstract ConfidentialLedger	getById(String id) Retrieves information about a Confidential Ledger resource.
abstract Response<ConfidentialLedger>	getByIdWithResponse(String id, Context context) Retrieves information about a Confidential Ledger resource.
abstract ConfidentialLedger	getByResourceGroup(String resourceGroupName, String ledgerName) Retrieves information about a Confidential Ledger resource.
abstract Response<ConfidentialLedger>	getByResourceGroupWithResponse(String resourceGroupName, String ledgerName, Context context) Retrieves information about a Confidential Ledger resource.
abstract PagedIterable<ConfidentialLedger>	list() Retrieves information about all Confidential Ledger resources under the given subscription Retrieves the properties of all Confidential Ledgers.
abstract PagedIterable<ConfidentialLedger>	list(String filter, Context context) Retrieves information about all Confidential Ledger resources under the given subscription Retrieves the properties of all Confidential Ledgers.
abstract PagedIterable<ConfidentialLedger>	listByResourceGroup(String resourceGroupName) Retrieves information about all Confidential Ledger resources under the given subscription and resource group Retrieves the properties of all Confidential Ledgers.
abstract PagedIterable<ConfidentialLedger>	listByResourceGroup(String resourceGroupName, String filter, Context context) Retrieves information about all Confidential Ledger resources under the given subscription and resource group Retrieves the properties of all Confidential Ledgers.
abstract ConfidentialLedgerRestoreResponse	restore(String resourceGroupName, String ledgerName, ConfidentialLedgerRestore confidentialLedger) Performs the restore operation to spin up a newly restored Confidential Ledger Resource.
abstract ConfidentialLedgerRestoreResponse	restore(String resourceGroupName, String ledgerName, ConfidentialLedgerRestore confidentialLedger, Context context) Performs the restore operation to spin up a newly restored Confidential Ledger Resource.

Method Details

backup

public abstract ConfidentialLedgerBackupResponse backup(String resourceGroupName, String ledgerName, ConfidentialLedgerBackup confidentialLedger)

Performs the backup operation on a Confidential Ledger Resource. Backs up a Confidential Ledger Resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

confidentialLedger - Confidential Ledger Backup Request Body.

Returns:

object representing the backup response of a Confidential Ledger Resource.

backup

public abstract ConfidentialLedgerBackupResponse backup(String resourceGroupName, String ledgerName, ConfidentialLedgerBackup confidentialLedger, Context context)

Performs the backup operation on a Confidential Ledger Resource. Backs up a Confidential Ledger Resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

confidentialLedger - Confidential Ledger Backup Request Body.

context - The context to associate with this operation.

Returns:

object representing the backup response of a Confidential Ledger Resource.

define

public abstract ConfidentialLedger.DefinitionStages.Blank define(String name)

Begins definition for a new ConfidentialLedger resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ConfidentialLedger definition.

delete

public abstract void delete(String resourceGroupName, String ledgerName, Context context)

Deletes a Confidential Ledger resource. Deletes an existing Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a Confidential Ledger resource. Deletes an existing Confidential Ledger.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a Confidential Ledger resource. Deletes an existing Confidential Ledger.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String ledgerName)

Deletes a Confidential Ledger resource. Deletes an existing Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

getById

public abstract ConfidentialLedger getById(String id)

Retrieves information about a Confidential Ledger resource. Retrieves the properties of a Confidential Ledger.

Parameters:

id - the resource ID.

Returns:

confidential Ledger along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Retrieves information about a Confidential Ledger resource. Retrieves the properties of a Confidential Ledger.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

confidential Ledger along with Response<T>.

getByResourceGroup

public abstract ConfidentialLedger getByResourceGroup(String resourceGroupName, String ledgerName)

Retrieves information about a Confidential Ledger resource. Retrieves the properties of a Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

Returns:

confidential Ledger.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String ledgerName, Context context)

Retrieves information about a Confidential Ledger resource. Retrieves the properties of a Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

context - The context to associate with this operation.

Returns:

confidential Ledger along with Response<T>.

list

public abstract PagedIterable list()

Retrieves information about all Confidential Ledger resources under the given subscription Retrieves the properties of all Confidential Ledgers.

Returns:

object that includes an array of Confidential Ledgers and a possible link for next set as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String filter, Context context)

Retrieves information about all Confidential Ledger resources under the given subscription Retrieves the properties of all Confidential Ledgers.

Parameters:

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

context - The context to associate with this operation.

Returns:

object that includes an array of Confidential Ledgers and a possible link for next set as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

Retrieves information about all Confidential Ledger resources under the given subscription and resource group Retrieves the properties of all Confidential Ledgers.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

object that includes an array of Confidential Ledgers and a possible link for next set as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, String filter, Context context)

Retrieves information about all Confidential Ledger resources under the given subscription and resource group Retrieves the properties of all Confidential Ledgers.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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

context - The context to associate with this operation.

Returns:

object that includes an array of Confidential Ledgers and a possible link for next set as paginated response with PagedIterable<T>.

restore

public abstract ConfidentialLedgerRestoreResponse restore(String resourceGroupName, String ledgerName, ConfidentialLedgerRestore confidentialLedger)

Performs the restore operation to spin up a newly restored Confidential Ledger Resource. Restores a Confidential Ledger Resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

confidentialLedger - Confidential Ledger Restore Request Body.

Returns:

object representing the restore response of a Confidential Ledger Resource.

restore

public abstract ConfidentialLedgerRestoreResponse restore(String resourceGroupName, String ledgerName, ConfidentialLedgerRestore confidentialLedger, Context context)

Performs the restore operation to spin up a newly restored Confidential Ledger Resource. Restores a Confidential Ledger Resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

ledgerName - Name of the Confidential Ledger.

confidentialLedger - Confidential Ledger Restore Request Body.

context - The context to associate with this operation.

Returns:

object representing the restore response of a Confidential Ledger Resource.