Package com.azure.resourcemanager.confidentialledger.models

Interface Ledgers

public interface Ledgers

Resource collection API of Ledgers.

Method Summary

Modifier and Type	Method	Description
ConfidentialLedger.DefinitionStages.Blank	define(String name)	Begins definition for a new ConfidentialLedger resource.
void	delete(String resourceGroupName, String ledgerName, com.azure.core.util.Context context)	Deletes an existing Confidential Ledger.
void	deleteById(String id)	Deletes an existing Confidential Ledger.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes an existing Confidential Ledger.
void	deleteByResourceGroup(String resourceGroupName, String ledgerName)	Deletes an existing Confidential Ledger.
ConfidentialLedger	getById(String id)	Retrieves the properties of a Confidential Ledger.
com.azure.core.http.rest.Response<ConfidentialLedger>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Retrieves the properties of a Confidential Ledger.
ConfidentialLedger	getByResourceGroup(String resourceGroupName, String ledgerName)	Retrieves the properties of a Confidential Ledger.
com.azure.core.http.rest.Response<ConfidentialLedger>	getByResourceGroupWithResponse(String resourceGroupName, String ledgerName, com.azure.core.util.Context context)	Retrieves the properties of a Confidential Ledger.
com.azure.core.http.rest.PagedIterable<ConfidentialLedger>	list()	Retrieves the properties of all Confidential Ledgers.
com.azure.core.http.rest.PagedIterable<ConfidentialLedger>	list(String filter, com.azure.core.util.Context context)	Retrieves the properties of all Confidential Ledgers.
com.azure.core.http.rest.PagedIterable<ConfidentialLedger>	listByResourceGroup(String resourceGroupName)	Retrieves the properties of all Confidential Ledgers.
com.azure.core.http.rest.PagedIterable<ConfidentialLedger>	listByResourceGroup(String resourceGroupName, String filter, com.azure.core.util.Context context)	Retrieves the properties of all Confidential Ledgers.

Method Detail

getByResourceGroup

ConfidentialLedger getByResourceGroup(String resourceGroupName,
                                      String ledgerName)

Retrieves the properties of a Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group.

ledgerName - Name of the Confidential Ledger.

Returns:

confidential Ledger.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<ConfidentialLedger> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                     String ledgerName,
                                                                                     com.azure.core.util.Context context)

Retrieves the properties of a Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group.

ledgerName - Name of the Confidential Ledger.

context - The context to associate with this operation.

Returns:

confidential Ledger along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String ledgerName)

Deletes an existing Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group.

ledgerName - Name of the Confidential Ledger.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String ledgerName,
            com.azure.core.util.Context context)

Deletes an existing Confidential Ledger.

Parameters:

resourceGroupName - The name of the resource group.

ledgerName - Name of the Confidential Ledger.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ConfidentialLedger> listByResourceGroup(String resourceGroupName)

Retrieves the properties of all Confidential Ledgers.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ConfidentialLedger> listByResourceGroup(String resourceGroupName,
                                                                               String filter,
                                                                               com.azure.core.util.Context context)

Retrieves the properties of all Confidential Ledgers.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ConfidentialLedger> list()

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.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ConfidentialLedger> list(String filter,
                                                                com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

ConfidentialLedger getById(String id)

Retrieves the properties of a Confidential Ledger.

Parameters:

id - the resource ID.

Returns:

confidential Ledger along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<ConfidentialLedger> getByIdWithResponse(String id,
                                                                          com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Deletes an existing Confidential Ledger.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes an existing Confidential Ledger.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

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.