Create User Defined Endpoint - Create User Defined Endpoint

Servizio:

Azure confidential ledger

Versione API:

2024-12-09-preview

Crea un endpoint definito dall'utente.
Crea l'endpoint definito dall'utente nell'istanza ACL

PUT {ledgerEndpoint}/app/userDefinedEndpoints?api-version=2024-12-09-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
ledgerEndpoint	path	True	string (url)	URL libro mastro riservato, ad esempio https://contoso.confidentialledger.azure.com
api-version	query	True	string	Versione dell'API da usare con la richiesta HTTP.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
metadata	True	Metadata
modules	True	ModuleDef[]

Risposte

Nome	Tipo	Descrizione
201 Created		Viene creato l'endpoint definito dall'utente.
Other Status Codes	ConfidentialLedgerError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

CreateUserDefinedEndpoint

Esempio di richiesta

HTTP

PUT {ledgerEndpoint}/app/userDefinedEndpoints?api-version=2024-12-09-preview

{
  "metadata": {
    "endpoints": {
      "/content": {
        "get": {
          "forwarding_required": "always",
          "authn_policies": [
            {}
          ]
        }
      }
    }
  },
  "modules": {
    "name": "test.js",
    "module": "TESTJS"
  }
}

Risposta di esempio

Codice di stato:

201

Definizioni

Nome	Descrizione
Bundle	bundle per gli endpoint definiti dall'utente
ConfidentialLedgerError	Risposta di errore da Confidential Ledger.
ConfidentialLedgerErrorBody	Risposta di errore da Confidential Ledger.
EndpointProperties
ForwardingRequired
InterpreterReusePolicy
Metadata
method_to_EndpointProperties
Mode
ModuleDef
RedirectionStrategy

Bundle

Object

bundle per gli endpoint definiti dall'utente

Nome	Tipo	Descrizione
metadata	Metadata
modules	ModuleDef[]

ConfidentialLedgerError

Object

Risposta di errore da Confidential Ledger.

Nome	Tipo	Descrizione
error	ConfidentialLedgerErrorBody	Risposta di errore da Confidential Ledger.

ConfidentialLedgerErrorBody

Object

Risposta di errore da Confidential Ledger.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.

EndpointProperties

Object

Nome	Tipo	Descrizione
authn_policies	json[]
forwarding_required	ForwardingRequired
interpreter_reuse	InterpreterReusePolicy
js_function	string
js_module	string
mode	Mode
openapi	json
openapi_hidden	boolean
redirection_strategy	RedirectionStrategy

ForwardingRequired

Enumerazione

Valore	Descrizione
always
never
sometimes

InterpreterReusePolicy

Object

Nome	Tipo	Descrizione
key	string

Metadata

Object

Nome	Tipo	Descrizione
endpoints	<string,  method_to_EndpointProperties>	Mappa del percorso agli endpoint del metodo per il percorso

method_to_EndpointProperties

Object

Nome	Tipo	Descrizione
delete	EndpointProperties
get	EndpointProperties
patch	EndpointProperties
put	EndpointProperties

Mode

Enumerazione

Valore	Descrizione
historical
readonly
readwrite

ModuleDef

Object

Nome	Tipo	Descrizione
module	string
name	string

RedirectionStrategy

Enumerazione

Valore	Descrizione
none
to_backup
to_primary