@azure/ms-rest-js package
クラス
| ApiKeyCredentials |
API キーを使用してサービスに対して認証します。 |
| AzureIdentityCredentialAdapter |
このクラスは、認証のために ServiceClientCredentials ファミリの資格情報を受け入れる従来の Azure SDK で使用するために、ライブラリから |
| BaseRequestPolicy | |
| BasicAuthenticationCredentials | |
| DefaultHttpClient | |
| DomainCredentials |
API キーを使用してサービスに対して認証します。 |
| HttpHeaders |
HTTP ヘッダーのキーと値のペアのコレクション。 |
| RequestPolicyOptions |
RequestPolicy の作成時に使用できる省略可能なプロパティ。 |
| RestError | |
| Serializer | |
| ServiceClient | |
| TokenCredentials |
トークン文字列と作成者設定スキームを使用して認証する資格情報オブジェクト。 |
| TopicCredentials |
API キーを使用してサービスに対して認証します。 |
| URLBuilder |
URL の作成、変更、解析を処理するクラス。 |
| URLQuery |
URLBuilder のクエリ部分を処理するクラス。 |
| WebResource |
新しい WebResource オブジェクトを作成します。 このクラスは、ライブラリ/実装に依存せず、要求を開始するために必要なプロパティをラップすることで、REST 呼び出しに対する抽象化を提供します。 |
インターフェイス
| AbortSignalLike |
"abort" イベントの発生時に要求を中止できるようにします。 ブラウザーに組み込まれている AbortSignal および一般的なポリフィルと互換性があります。 |
| AgentSettings |
HTTP エージェントと HTTPS エージェント (Node.jsのみ) |
| ApiKeyCredentialOptions | |
| BaseMapper | |
| CompositeMapper | |
| CompositeMapperType | |
| DeserializationContentTypes |
操作応答を特定の方法で逆シリアル化する必要があることを示すコンテンツ タイプ。 |
| DictionaryMapper | |
| DictionaryMapperType | |
| EnumMapper | |
| EnumMapperType | |
| HttpClient |
HttpRequests を送信し、約束された HttpResponses を受信できるインターフェイス。 |
| HttpHeader |
HttpHeaders コレクション内の個々のヘッダー。 |
| HttpHeadersLike |
HTTP ヘッダーのキーと値のペアのコレクション。 |
| HttpOperationResponse |
http 要求と応答のラッパー オブジェクト。 逆シリアル化されたオブジェクトは、応答本文が JSON または XML で受信されるときに、 プロパティに格納されます |
| HttpPipelineLogger |
HttpPipeline に追加できるロガー。 これにより、各 RequestPolicy は、デバッグ目的で使用できるメッセージをログに記録できます。 |
| HttpResponse |
常に存在する HTTP 応答のプロパティ。 |
| MapperConstraints | |
| OperationArguments |
操作の 1 回の呼び出しに適用されるプロパティのコレクション。 |
| OperationParameter |
すべての Operation パラメーターが拡張する共通インターフェイス。 |
| OperationQueryParameter |
操作の HTTP 要求にクエリ パラメーターとして追加される操作のパラメーター。 |
| OperationResponse |
1 つの状態コードの操作要求から返すことができる OperationResponse。 |
| OperationSpec |
操作を定義する仕様。 |
| OperationURLParameter |
操作の要求 URL に置き換えられる操作のパラメーター。 |
| ParameterValue |
RequestPrepareOptions のパスまたはクエリ パラメーターに指定された Parameter 値 |
| PolymorphicDiscriminator | |
| ProxySettings |
HTTP プロキシ設定 (Node.jsのみ) |
| RedirectOptions |
リダイレクト応答の処理方法のオプション。 |
| RequestOptionsBase |
すべての操作で使用される options オブジェクトの基本構造について説明します。 |
| RequestPolicy | |
| RequestPolicyOptionsLike |
RequestPolicy の作成時に使用できる省略可能なプロパティ。 |
| RequestPrepareOptions | |
| RestResponse |
REST 呼び出しに対するフラット化された応答。 基になる HttpOperationResponse と、parsedBody、parsedHeaders などのマージされたプロパティが含まれます。 |
| SequenceMapper | |
| SequenceMapperType | |
| ServiceCallback | |
| ServiceClientCredentials | |
| ServiceClientOptions |
クライアントの作成時に指定するオプション。 |
| SimpleMapperType | |
| TokenResponse |
TokenResponse は で |
| UrlParameterValue | |
| WebResourceLike |
REST 呼び出しに対する抽象化。 |
型エイリアス
| Authenticator | |
| CommonRequestInfo | |
| CommonRequestInit | |
| CommonResponse | |
| HttpMethods | |
| HttpRequestBody | |
| Mapper | |
| MapperType | |
| ParameterPath | |
| RawHttpHeaders |
単純な JSON オブジェクトとして表される HttpHeaders コレクション。 |
| RequestPolicyFactory |
指定された nextPolicy を使用する要求ごとに新しい RequestPolicy を作成します。 |
| TelemetryInfo | |
| TransferProgressEvent |
アップロードまたはダウンロードの進行状況に応じて発生します。 |
列挙型
| HttpPipelineLogLevel |
HttpPipelineLogger で使用できるさまざまなレベルのログ。 |
| QueryCollectionFormat |
クエリ パラメーター値の値の配列を結合するために使用される形式。 |
機能
関数の詳細
agentPolicy(AgentSettings)
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactoryパラメーター
- agentSettings
- AgentSettings
戻り値
applyMixins(any, any[])
sourceCtors のプロトタイプのプロパティを targetCtor のプロトタイプに適用します
function applyMixins(targetCtor: any, sourceCtors: any[])パラメーター
- targetCtor
-
any
プロパティを適用する必要があるターゲット オブジェクト。
- sourceCtors
-
any[]
プロパティを取得する必要があるソース オブジェクトの配列。
delay<T>(number, T)
t ミリ秒後に promise を解決する setTimeout のラッパー。
function delay<T>(t: number, value?: T): Promise<T>パラメーター
- t
-
number
遅延するミリ秒数。
- value
-
T
タイムアウトの t ミリ秒後に解決される値。
戻り値
Promise<T>
解決済みの Promise
deserializationPolicy(DeserializationContentTypes)
HTTP パイプラインを通過する際に HTTP 要求本文をシリアル化する新しいシリアル化 RequestPolicyCreator を作成します。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactoryパラメーター
- deserializationContentTypes
- DeserializationContentTypes
戻り値
deserializeResponseBody(string[], string[], HttpOperationResponse)
function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse): Promise<HttpOperationResponse>パラメーター
- jsonContentTypes
-
string[]
- xmlContentTypes
-
string[]
- response
- HttpOperationResponse
戻り値
Promise<HttpOperationResponse>
encodeUri(string)
URI をエンコードします。
function encodeUri(uri: string): stringパラメーター
- uri
-
string
エンコードする URI。
戻り値
string
エンコードされた URI。
executePromisesSequentially(any[], any)
Promise の配列を順番に実行します。 この方法のインスピレーションはここにあります: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. 約束に関する素晴らしいブログ!
function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>パラメーター
- promiseFactories
-
any[]
promise ファクトリの配列 (promise を返す関数)
- kickstart
-
any
Promise チェーンを開始するために使用される最初の Promise への入力。 指定しない場合、promise チェーンは undefined で始まります。
戻り値
Promise<any>
解決または拒否された約束のチェーン
exponentialRetryPolicy(number, number, number, number)
function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactoryパラメーター
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
戻り値
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponseパラメーター
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
戻り値
generateClientRequestIdPolicy(string)
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactoryパラメーター
- requestIdHeaderName
-
string
戻り値
generateUuid()
生成された UUID
function generateUuid(): string戻り値
string
RFC4122 v4 UUID。
getDefaultProxySettings(string)
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefinedパラメーター
- proxyUrl
-
string
戻り値
ProxySettings | undefined
getDefaultUserAgentValue()
function getDefaultUserAgentValue(): string戻り値
string
isDuration(string)
指定された文字列が ISO 8601 形式であるかどうかを示します。
function isDuration(value: string): booleanパラメーター
- value
-
string
ISO 8601 期間形式で検証される値。
戻り値
boolean
true 有効な場合は 。 false それ以外の場合は 。
isValidUuid(string)
指定された uuid を文字列として検証します
function isValidUuid(uuid: string): booleanパラメーター
- uuid
-
string
検証する必要がある文字列としての uuid
戻り値
boolean
Uuid が有効な場合は True。それ以外の場合は false。
logPolicy(any)
promiseToCallback(Promise<any>)
警告
この API は非推奨になりました。
generated code should instead depend on responseToBody
Promise をコールバックに変換します。
function promiseToCallback(promise: Promise<any>): Functionパラメーター
- promise
-
Promise<any>
コールバックに変換される Promise
戻り値
Function
コールバックを受け取る関数 (cb: Function): void
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)
Promise をサービス コールバックに変換します。
function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Functionパラメーター
- promise
-
Promise<HttpOperationResponse>
サービス コールバックに変換される HttpOperationResponse の Promise
戻り値
Function
サービス コールバックを受け取る関数 (cb: ServiceCallback): void
proxyPolicy(ProxySettings)
function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactoryパラメーター
- proxySettings
- ProxySettings
戻り値
redirectPolicy(number)
function redirectPolicy(maximumRetries?: number): RequestPolicyFactoryパラメーター
- maximumRetries
-
number
戻り値
serializeObject(any)
function serializeObject(toSerialize: any): anyパラメーター
- toSerialize
-
any
戻り値
any
signingPolicy(ServiceClientCredentials)
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactoryパラメーター
- authenticationProvider
- ServiceClientCredentials
戻り値
stripRequest(WebResourceLike)
Authorization ヘッダーを含まない Http 要求の削除されたバージョンを返します。
function stripRequest(request: WebResourceLike): WebResourceLikeパラメーター
- request
- WebResourceLike
Http Request オブジェクト
戻り値
削除された Http 要求のバージョン。
stripResponse(HttpOperationResponse)
本文、ヘッダー、および状態のみを含む Http 応答の削除されたバージョンを返します。
function stripResponse(response: HttpOperationResponse): anyパラメーター
- response
- HttpOperationResponse
Http 応答
戻り値
any
削除された Http 応答のバージョン。
systemErrorRetryPolicy(number, number, number, number)
function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactoryパラメーター
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
戻り値
throttlingRetryPolicy(number)
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactoryパラメーター
- maxRetries
-
number
戻り値
userAgentPolicy(TelemetryInfo)
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactoryパラメーター
- userAgentData
- TelemetryInfo