StoredProcedure class
ID による特定の既存のストアド プロシージャの読み取り、置換、削除、または実行のための操作。
ストアド プロシージャを作成、読み取り、またはクエリする操作の場合は、
プロパティ
| container | |
| id | |
| url | リソースへの参照 URL を返します。 [アクセス許可] のリンクに使用されます。 |
メソッド
| delete(Request |
指定した StoredProcedure を削除します。 |
| execute<T>(Partition |
指定した StoredProcedure を実行します。 指定した型 T は、クライアントによって適用されません。 ストアド プロシージャからの応答が、指定した型 T と一致することを確認してください。 |
| read(Request |
|
| replace(Stored |
指定した StoredProcedure を、指定した StoredProcedureDefinition に置き換えます。 |
プロパティの詳細
container
id
id: stringプロパティ値
string
url
リソースへの参照 URL を返します。 [アクセス許可] のリンクに使用されます。
string urlプロパティ値
string
メソッドの詳細
delete(RequestOptions)
指定した StoredProcedure を削除します。
function delete(options?: RequestOptions): Promise<StoredProcedureResponse>パラメーター
- options
- RequestOptions
戻り値
Promise<StoredProcedureResponse>
execute<T>(PartitionKey, any[], RequestOptions)
指定した StoredProcedure を実行します。
指定した型 T は、クライアントによって適用されません。 ストアド プロシージャからの応答が、指定した型 T と一致することを確認してください。
function execute<T>(partitionKey: PartitionKey, params?: any[], options?: RequestOptions): Promise<ResourceResponse<T>>パラメーター
- partitionKey
- PartitionKey
ストアド プロシージャの実行時に使用するパーティション キー
- params
-
any[]
指定 した StoredProcedure に引数として渡すパラメーターの配列。
- options
- RequestOptions
StoredProcedure を呼び出すパーティション キーなどの追加オプション。
戻り値
Promise<ResourceResponse<T>>
read(RequestOptions)
指定 された StoredProcedure の StoredProcedureDefinition を読み取 る。
function read(options?: RequestOptions): Promise<StoredProcedureResponse>パラメーター
- options
- RequestOptions
戻り値
Promise<StoredProcedureResponse>
replace(StoredProcedureDefinition, RequestOptions)
指定した StoredProcedure を、指定した StoredProcedureDefinition に置き換えます。
function replace(body: StoredProcedureDefinition, options?: RequestOptions): Promise<StoredProcedureResponse>パラメーター
既存の定義を置き換えるために指定 した StoredProcedureDefinition 。
- options
- RequestOptions
戻り値
Promise<StoredProcedureResponse>