@azure/arm-confidentialledger package

Classes

ConfidentialLedgerClient

Interfaces

AADBasedSecurityPrincipal	AAD based security principal with associated Ledger RoleName
CertBasedSecurityPrincipal	Cert based security principal with Ledger RoleName
CheckNameAvailabilityOptionalParams	Optional parameters.
CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
ConfidentialLedger	Confidential Ledger. Contains the properties of Confidential Ledger Resource.
ConfidentialLedgerClientOptionalParams	Optional parameters.
ConfidentialLedgerList	Object that includes an array of Confidential Ledgers and a possible link for next set.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Ledger	Interface representing a Ledger.
LedgerCreateOptionalParams	Optional parameters.
LedgerDeleteOptionalParams	Optional parameters.
LedgerGetOptionalParams	Optional parameters.
LedgerListByResourceGroupNextOptionalParams	Optional parameters.
LedgerListByResourceGroupOptionalParams	Optional parameters.
LedgerListBySubscriptionNextOptionalParams	Optional parameters.
LedgerListBySubscriptionOptionalParams	Optional parameters.
LedgerProperties	Additional Confidential Ledger properties.
LedgerUpdateOptionalParams	Optional parameters.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
Resource	An Azure resource.
ResourceLocation	Location of the ARM Resource
ResourceProviderOperationDefinition	Describes the Resource Provider Operation.
ResourceProviderOperationDisplay	Describes the properties of the Operation.
ResourceProviderOperationList	List containing this Resource Provider's available operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
Tags	Tags for Confidential Ledger Resource

Type Aliases

CheckNameAvailabilityOperationResponse	Contains response data for the checkNameAvailability operation.
CheckNameAvailabilityReason	Defines values for CheckNameAvailabilityReason. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
LedgerCreateResponse	Contains response data for the create operation.
LedgerGetResponse	Contains response data for the get operation.
LedgerListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
LedgerListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
LedgerListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
LedgerListBySubscriptionResponse	Contains response data for the listBySubscription operation.
LedgerRoleName	Defines values for LedgerRoleName. KnownLedgerRoleName can be used interchangeably with LedgerRoleName, this enum contains the known values that the service supports. Known values supported by the service Reader Contributor Administrator
LedgerType	Defines values for LedgerType. KnownLedgerType can be used interchangeably with LedgerType, this enum contains the known values that the service supports. Known values supported by the service Unknown Public Private
LedgerUpdateResponse	Contains response data for the update operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Succeeded Failed Canceled Creating Deleting Updating

Enums

KnownCheckNameAvailabilityReason	Known values of CheckNameAvailabilityReason that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownLedgerRoleName	Known values of LedgerRoleName that the service accepts.
KnownLedgerType	Known values of LedgerType that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.