ConfidentialLedgerClient class

  • Reference
Package:
@azure/arm-confidentialledger
Extends
ServiceClient

Constructors

ConfidentialLedgerClient(TokenCredential, string, ConfidentialLedgerClientOptionalParams)

Initializes a new instance of the ConfidentialLedgerClient class.

Properties

$host
apiVersion
ledger
operations
subscriptionId

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

checkNameAvailability(CheckNameAvailabilityRequest, CheckNameAvailabilityOptionalParams)

To check whether a resource name is available.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

ConfidentialLedgerClient(TokenCredential, string, ConfidentialLedgerClientOptionalParams)

Initializes a new instance of the ConfidentialLedgerClient class.

new ConfidentialLedgerClient(credentials: TokenCredential, subscriptionId: string, options?: ConfidentialLedgerClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

options
ConfidentialLedgerClientOptionalParams

The parameter options

Property Details

$host 

$host: string

Property Value

string

apiVersion 

apiVersion: string

Property Value

string

ledger 

ledger: Ledger

Property Value

Ledger

operations 

operations: Operations

Property Value

Operations

subscriptionId 

subscriptionId: string

Property Value

string

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

checkNameAvailability(CheckNameAvailabilityRequest, CheckNameAvailabilityOptionalParams)

To check whether a resource name is available.

function checkNameAvailability(nameAvailabilityRequest: CheckNameAvailabilityRequest, options?: CheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>

Parameters

nameAvailabilityRequest
CheckNameAvailabilityRequest

Name availability request payload.

options
CheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResponse>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest