ServiceFabricClientGetApplicationInfoListOptionalParams interface

パッケージ:

@azure/servicefabric

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

Extends

RequestOptionsBase

プロパティ

applicationDefinitionKindFilter	ApplicationDefinitionKind でフィルター処理するために使用されます。これは、Service Fabric アプリケーションを定義するために使用されるメカニズムです。 既定値 - 既定値。"すべて" を選択した場合と同じ機能を実行します。 値は次の値です。 All - 任意の ApplicationDefinitionKind 値を持つ入力と一致するフィルター。 値は次の値です。 ServiceFabricApplicationDescription - ApplicationDefinitionKind 値 ServiceFabricApplicationDescription との入力と一致するフィルター。 値は 1 です。 Compose - ApplicationDefinitionKind 値 Compose の入力と一致するフィルター。 値は 2 です。 既定値: 0。
applicationTypeName	クエリ対象のアプリケーションをフィルター処理するために使用するアプリケーションの種類の名前。 この値には、アプリケーションの種類のバージョンを含めてはなりません。
continuationToken	継続トークン パラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合、空でない値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API は次の結果セットを返します。 それ以上の結果がない場合、継続トークンには値が含まれません。 このパラメーターの値は URL エンコードしないでください。
excludeApplicationParameters	アプリケーション パラメーターを結果から除外するかどうかを指定するフラグ。 既定値: false。
maxResults	ページングされたクエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数の上限を定義します。 返される結果は、構成で定義されている最大メッセージ サイズ制限に従ってメッセージに収まらない場合、指定された最大結果より小さくすることができます。 このパラメーターが 0 または指定されていない場合、ページングされたクエリには、返されるメッセージに収まるできるだけ多くの結果が含まれます。 既定値: 0。
timeoutParameter	操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

継承されたプロパティ

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

プロパティの詳細

applicationDefinitionKindFilter

ApplicationDefinitionKind でフィルター処理するために使用されます。これは、Service Fabric アプリケーションを定義するために使用されるメカニズムです。

• 既定値 - 既定値。"すべて" を選択した場合と同じ機能を実行します。 値は次の値です。

• All - 任意の ApplicationDefinitionKind 値を持つ入力と一致するフィルター。 値は次の値です。

• ServiceFabricApplicationDescription - ApplicationDefinitionKind 値 ServiceFabricApplicationDescription との入力と一致するフィルター。 値は 1 です。
• Compose - ApplicationDefinitionKind 値 Compose の入力と一致するフィルター。 値は 2 です。 既定値: 0。

applicationDefinitionKindFilter?: number

プロパティ値

number

applicationTypeName

クエリ対象のアプリケーションをフィルター処理するために使用するアプリケーションの種類の名前。 この値には、アプリケーションの種類のバージョンを含めてはなりません。

applicationTypeName?: string

プロパティ値

string

continuationToken

継続トークン パラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合、空でない値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API は次の結果セットを返します。 それ以上の結果がない場合、継続トークンには値が含まれません。 このパラメーターの値は URL エンコードしないでください。

continuationToken?: string

プロパティ値

string

excludeApplicationParameters

アプリケーション パラメーターを結果から除外するかどうかを指定するフラグ。 既定値: false。

excludeApplicationParameters?: boolean

プロパティ値

boolean

maxResults

ページングされたクエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数の上限を定義します。 返される結果は、構成で定義されている最大メッセージ サイズ制限に従ってメッセージに収まらない場合、指定された最大結果より小さくすることができます。 このパラメーターが 0 または指定されていない場合、ページングされたクエリには、返されるメッセージに収まるできるだけ多くの結果が含まれます。 既定値: 0。

maxResults?: number

プロパティ値

number

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 から継承された