@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 for the client.
ConfidentialLedgerFilesExport	Object representing Files Export properties of a Confidential Ledger Resource.
ConfidentialLedgerFilesExportResponse	Object representing the files export response of a Confidential Ledger Resource.
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.
LedgerCreateOptionalParams	Optional parameters.
LedgerDeleteOptionalParams	Optional parameters.
LedgerFilesExportOptionalParams	Optional parameters.
LedgerGetOptionalParams	Optional parameters.
LedgerListByResourceGroupOptionalParams	Optional parameters.
LedgerListBySubscriptionOptionalParams	Optional parameters.
LedgerOperations	Interface representing a Ledger operations.
LedgerProperties	Additional Confidential Ledger properties.
LedgerUpdateOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceProviderOperationDefinition	Describes the Resource Provider Operation.
ResourceProviderOperationDisplay	Describes the properties of the Operation.
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ApplicationType	Object representing the application type of the Confidential Ledger. Defaults to ConfidentialLedger. KnownApplicationType can be used interchangeably with ApplicationType, this enum contains the known values that the service supports. Known values supported by the service ConfidentialLedger CodeTransparency
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CheckNameAvailabilityReason	Possible reasons for a name not being available. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid: Name is invalid. AlreadyExists: Name already exists.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
EnclavePlatform	Object representing the enclave platform for the Confidential Ledger application. Defaults to IntelSgx. KnownEnclavePlatform can be used interchangeably with EnclavePlatform, this enum contains the known values that the service supports. Known values supported by the service IntelSgx AmdSevSnp
LedgerRoleName	LedgerRole associated with the Security Principal of Ledger 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
LedgerSku	SKU associated with the ledger resource KnownLedgerSku can be used interchangeably with LedgerSku, this enum contains the known values that the service supports. Known values supported by the service Standard Basic Unknown
LedgerType	Type of the ledger. Private means transaction data is encrypted. 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
ProvisioningState	Object representing ProvisioningState for Confidential Ledger. 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
RunningState	Object representing RunningState for Confidential Ledger. KnownRunningState can be used interchangeably with RunningState, this enum contains the known values that the service supports. Known values supported by the service Active Paused Unknown Pausing Resuming

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownApplicationType	Object representing the application type of the Confidential Ledger. Defaults to ConfidentialLedger.
KnownCheckNameAvailabilityReason	Possible reasons for a name not being available.
KnownCreatedByType	The kind of entity that created the resource.
KnownEnclavePlatform	Object representing the enclave platform for the Confidential Ledger application. Defaults to IntelSgx.
KnownLedgerRoleName	LedgerRole associated with the Security Principal of Ledger
KnownLedgerSku	SKU associated with the ledger resource
KnownLedgerType	Type of the ledger. Private means transaction data is encrypted.
KnownProvisioningState	Object representing ProvisioningState for Confidential Ledger.
KnownRunningState	Object representing RunningState for Confidential Ledger.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ConfidentialLedgerClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ConfidentialLedgerClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ConfidentialLedgerClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ConfidentialLedgerClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor