Class StoredProcedure

Readonlycontainer

Readonlyid

url

• get url(): string

• Returns a reference URL to the resource. Used for linking in Permissions.

  Returns string

delete

• delete(options?): Promise<StoredProcedureResponse>

• Delete the given StoredProcedure.

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<StoredProcedureResponse>

execute

• execute<T>(partitionKey, params?, options?): Promise<ResourceResponse<T>>

• Execute the given StoredProcedure.

  The specified type, T, is not enforced by the client. Be sure to validate the response from the stored procedure matches the type, T, you provide.

  Type Parameters

  • T = any

  Parameters

  • partitionKey: PartitionKey

    The partition key to use when executing the stored procedure
  • Optionalparams: any[]

    Array of parameters to pass as arguments to the given StoredProcedure.
  • Optionaloptions: RequestOptions

    Additional options, such as the partition key to invoke the StoredProcedure on.

  Returns Promise<ResourceResponse<T>>

read

• read(options?): Promise<StoredProcedureResponse>

• Read the StoredProcedureDefinition for the given StoredProcedure.

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<StoredProcedureResponse>

replace

• replace(body, options?): Promise<StoredProcedureResponse>

• Replace the given StoredProcedure with the specified StoredProcedureDefinition.

  Parameters

  • body: StoredProcedureDefinition

    The specified StoredProcedureDefinition to replace the existing definition.
  • Optionaloptions: RequestOptions

  Returns Promise<StoredProcedureResponse>