@azure-rest/core-client package
インターフェイス
| AddCredentialPipelinePolicyOptions |
パイプラインに資格情報ポリシーを追加するための省略可能なパラメーター。 |
| AdditionalPolicyConfig |
構築時にパイプラインに追加される追加のポリシーを構成するために使用されます。 |
| Client |
Rest Level Client のシェイプ |
| ErrorModel |
エラー オブジェクト。 |
| ErrorResponse |
エラーの詳細を含む応答。 |
| FullOperationResponse |
http 要求と応答のラッパー オブジェクト。 逆シリアル化されたオブジェクトは、応答本文が JSON で受信されるときに、 |
| InnerError |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
| OperationOptions |
すべての操作の基本オプションの種類。 |
| OperationRequestOptions |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| PathParameterWithOptions |
パス パラメーターとして渡すことができるオブジェクト。パラメーターのエンコード方法に関連する追加のオプションを設定できます。 |
| ResourceMethods |
リソースで呼び出すことができるメソッドを定義します |
型エイリアス
| ClientOptions |
Rest Level Client で使用できる一般的なオプション |
| HttpBrowserStreamResponse |
NodeJS ストリーム オブジェクトである本文の Http 応答 |
| HttpNodeStreamResponse |
NodeJS ストリーム オブジェクトである本文の Http 応答 |
| HttpResponse |
HttpResponse の図形を表します。 |
| PathParameters |
{} で囲まれたパス テンプレート テキスト内のパラメーターを検出するために使用されるヘルパー型は、パス パラメーターと見なされます |
| PathUnchecked |
pathUnchecked のシグネチャを定義します。 |
| PathUncheckedResponse |
pathUnchecked で使用する型。本文の種類を任意にオーバーライドして柔軟性を確保します |
| RawResponseCallback |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 このコールバックは、ヘッダーと応答本文を含む生の応答という 2 つのパラメーターで呼び出されます。要求の処理中にエラーがスローされた場合に提供されるエラー オブジェクト。
3 番目の __legacyError パラメーターは下位互換性のみを目的として提供され、 |
| RequestParameters |
既定の要求パラメーターの形状。これは、厳密な型を提供するために特定の要求の種類によってオーバーライドされる場合があります |
| StreamableMethod |
応答本文を生ストリームとして取得することをサポートするメソッドの型を定義します。 |
関数
| add |
資格情報が指定されている場合は、パイプラインに資格情報ポリシーを追加します。 何も指定されていない場合、ポリシーは追加されません。 |
| create |
PathUnchecked 応答から rest エラーを作成します |
| create |
エラー メッセージと PathUnchecked 応答から rest エラーを作成します。 |
| get |
既定のパイプラインを使用してクライアントを作成します |
| get |
既定のパイプラインを使用してクライアントを作成します |
| operation |
OperationOptions を RequestParameters に変換するヘルパー関数 |
関数の詳細
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
資格情報が指定されている場合は、パイプラインに資格情報ポリシーを追加します。 何も指定されていない場合、ポリシーは追加されません。
function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)パラメーター
- pipeline
- Pipeline
- endpoint
-
string
createRestError(PathUncheckedResponse)
PathUnchecked 応答から rest エラーを作成します
function createRestError(response: PathUncheckedResponse): RestErrorパラメーター
- response
- PathUncheckedResponse
戻り値
createRestError(string, PathUncheckedResponse)
エラー メッセージと PathUnchecked 応答から rest エラーを作成します。
function createRestError(message: string, response: PathUncheckedResponse): RestErrorパラメーター
- message
-
string
- response
- PathUncheckedResponse
戻り値
getClient(string, ClientOptions)
既定のパイプラインを使用してクライアントを作成します
function getClient(endpoint: string, options?: ClientOptions): Clientパラメーター
- endpoint
-
string
クライアントのベース エンドポイント
- options
- ClientOptions
クライアント オプション
戻り値
getClient(string, TokenCredential | KeyCredential, ClientOptions)
既定のパイプラインを使用してクライアントを作成します
function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Clientパラメーター
- endpoint
-
string
クライアントのベース エンドポイント
- credentials
要求を認証するための資格情報
- options
- ClientOptions
クライアント オプション
戻り値
operationOptionsToRequestParameters(OperationOptions)
OperationOptions を RequestParameters に変換するヘルパー関数
function operationOptionsToRequestParameters(options: OperationOptions): RequestParametersパラメーター
- options
- OperationOptions
Modular レイヤーが要求を送信するために使用するオプション
戻り値
RLC レイヤーの RequestParameters での変換の結果