Get User Defined Endpoints Module - Get User Defined Endpoints Module

Service:

Azure confidential ledger

API Version:

2024-12-09-preview

Module for user defined endpoints.
It gets the module for the user defined endpoint.

GET {ledgerEndpoint}/app/userDefinedEndpoints/modules?api-version=2024-12-09-preview&module_name={module_name}

URI Parameters

Name	In	Required	Type	Description
ledgerEndpoint	path	True	string (uri)	The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com.
api-version	query	True	string minLength: 1	The API version to use for this operation.
module_name	query	True	string	module name of the user defined endpoint

Responses

Name	Type	Description
200 OK	ModuleDef	The request has succeeded.
Other Status Codes	ConfidentialLedgerCommon.ConfidentialLedgerError	An unexpected error response.

Examples

Get User Defined Endpoints Module

Sample request

HTTP

GET {ledgerEndpoint}/app/userDefinedEndpoints/modules?api-version=2024-12-09-preview&module_name=TESTJS

Sample response

Status code:

200

{
  "name": "test.js",
  "module": "TESTJS"
}

Definitions

Name	Description
ConfidentialLedgerCommon.ConfidentialLedgerError	An error response from Confidential Ledger.
ConfidentialLedgerCommon.ConfidentialLedgerErrorBody	An error response from Confidential Ledger.
ModuleDef	Module definition

ConfidentialLedgerCommon.ConfidentialLedgerError

Object

An error response from Confidential Ledger.

Name	Type	Description
error	ConfidentialLedgerCommon.ConfidentialLedgerErrorBody	An error response from Confidential Ledger.

ConfidentialLedgerCommon.ConfidentialLedgerErrorBody

Object

An error response from Confidential Ledger.

Name	Type	Description
code	string	The error code.
message	string	The error message.

ModuleDef

Object

Module definition

Name	Type	Description
module	string	Module
name	string	Name