ServiceFabricClientResolveServiceOptionalParams interface

パッケージ:

@azure/servicefabric

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

partitionKeyType	パーティションのキーの種類。 このパラメーターは、サービスのパーティション構成が Int64Range または Named の場合に必要です。 指定できる値は次のとおりです。 なし (1) - PartitionKeyValue パラメーターが指定されていないことを示します。 これは、パーティション構成がシングルトンであるパーティションに対して有効です。 これが既定値です。 値は 1 です。 Int64Range (2) - PartitionKeyValue パラメーターが int64 パーティション キーであることを示します。 これは、パーティション構成が Int64Range のパーティションに対して有効です。 値は 2 です。 名前付き (3) - PartitionKeyValue パラメーターがパーティションの名前であることを示します。 これは、パーティション構成が [名前付き] のパーティションに対して有効です。 値は 3 です。
partitionKeyValue	パーティション キー。 これは、サービスのパーティション構成が Int64Range または Named の場合に必要です。 これはパーティション ID ではなく、整数キー値またはパーティション ID の名前です。 たとえば、サービスで 0 から 10 までの範囲のパーティションを使用している場合、PartitionKeyValue はその範囲内の整数になります。 サービスの説明を照会して、範囲または名前を表示します。
previousRspVersion	以前に受信した応答の [バージョン] フィールドの値。 これは、以前に取得された結果が古くなっていることをユーザーが認識している場合に必要です。
timeoutParameter	操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

partitionKeyType

パーティションのキーの種類。 このパラメーターは、サービスのパーティション構成が Int64Range または Named の場合に必要です。 指定できる値は次のとおりです。

• なし (1) - PartitionKeyValue パラメーターが指定されていないことを示します。 これは、パーティション構成がシングルトンであるパーティションに対して有効です。 これが既定値です。 値は 1 です。
• Int64Range (2) - PartitionKeyValue パラメーターが int64 パーティション キーであることを示します。 これは、パーティション構成が Int64Range のパーティションに対して有効です。 値は 2 です。
• 名前付き (3) - PartitionKeyValue パラメーターがパーティションの名前であることを示します。 これは、パーティション構成が [名前付き] のパーティションに対して有効です。 値は 3 です。

partitionKeyType?: number

プロパティ値

number

partitionKeyValue

パーティション キー。 これは、サービスのパーティション構成が Int64Range または Named の場合に必要です。 これはパーティション ID ではなく、整数キー値またはパーティション ID の名前です。 たとえば、サービスで 0 から 10 までの範囲のパーティションを使用している場合、PartitionKeyValue はその範囲内の整数になります。 サービスの説明を照会して、範囲または名前を表示します。

partitionKeyValue?: string

プロパティ値

string

previousRspVersion

以前に受信した応答の [バージョン] フィールドの値。 これは、以前に取得された結果が古くなっていることをユーザーが認識している場合に必要です。

previousRspVersion?: string

プロパティ値

string

timeoutParameter

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

timeoutParameter?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

msRest.RequestOptionsBase.abortSignal から継承された

customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

msRest.RequestOptionsBase.customHeaders から継承された

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onDownloadProgress から継承された

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

msRest.RequestOptionsBase.timeout から継承された