次の方法で共有


ListConfigurationSettingsOptions interface

キー、ラベル、その他のフィールドに基づくフィルター処理を可能にする listConfigurationSettings のオプション。 また、結果に入力するフィールドを選択できる fields も用意されています。

Extends

プロパティ

pageEtags

ページの Etags リスト

継承されたプロパティ

abortSignal

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

acceptDateTime

指定された時刻にリソースの状態で応答するようにサーバーに要求します。

fields

各 ConfigurationSetting に対して返すフィールド

keyFilter

キーのフィルター。 一致には次の 2 種類があります。

  1. 完全一致。 最大 5 つのキー名をコンマ (',') で区切って使用できます。

  2. ワイルドカードの一致。 1 つのワイルドカード式を指定できます。

    価値 一致
    省略または * 任意のキーと一致します
    甲乙丙 abc という名前のキーと一致します
    甲乙丙* abc で始まるキー名と一致します

これらの文字は予約済みであり、* または \ または 、 を指定するには、先頭に円記号を付ける必要があります。

labelFilter

ラベルのフィルター。 一致には次の 2 種類があります。

  1. 完全一致。 最大 5 つのラベルをコンマ (',') で区切って使用できます。

  2. ワイルドカードの一致。 1 つのワイルドカード式を指定できます。

    |値 |一致 | |--------------|------------------------------------------------------| |省略または * |任意のキーと一致する | |\0 |ラベルのない任意のキーと一致します (%00としてエンコードされた URL) | |prod |prod という名前のラベルを持つキーと一致します | |prod* |prod で始まるラベル名を持つキーと一致します |これらの文字は予約済みであり、* または \ または 、 を指定するには、先頭に円記号を付ける必要があります。

リファレンス: https://zcusa.951200.xyz/azure/azure-app-configuration/rest-api-key-value

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

tagsFilter

タグによるクエリに使用されるフィルター。 構文リファレンス: https://aka.ms/azconfig/docs/keyvaluefiltering

tracingOptions

トレースが有効な場合に使用されるオプション。

プロパティの詳細

pageEtags

ページの Etags リスト

pageEtags?: string[]

プロパティ値

string[]

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

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

OperationOptions.abortSignal から継承された

acceptDateTime

指定された時刻にリソースの状態で応答するようにサーバーに要求します。

acceptDateTime?: Date

プロパティ値

Date

ListSettingsOptions.acceptDateTime から継承された

fields

各 ConfigurationSetting に対して返すフィールド

fields?: ("value" | "contentType" | "tags" | "isReadOnly" | "lastModified" | (keyof ConfigurationSettingId))[]

プロパティ値

("value" | "contentType" | "tags" | "isReadOnly" | "lastModified" | (keyof ConfigurationSettingId))[]

ListSettingsOptions.fields から継承

keyFilter

キーのフィルター。 一致には次の 2 種類があります。

  1. 完全一致。 最大 5 つのキー名をコンマ (',') で区切って使用できます。

  2. ワイルドカードの一致。 1 つのワイルドカード式を指定できます。

    価値 一致
    省略または * 任意のキーと一致します
    甲乙丙 abc という名前のキーと一致します
    甲乙丙* abc で始まるキー名と一致します

これらの文字は予約済みであり、* または \ または 、 を指定するには、先頭に円記号を付ける必要があります。

keyFilter?: string

プロパティ値

string

ListSettingsOptions.keyFilter から継承された

labelFilter

ラベルのフィルター。 一致には次の 2 種類があります。

  1. 完全一致。 最大 5 つのラベルをコンマ (',') で区切って使用できます。

  2. ワイルドカードの一致。 1 つのワイルドカード式を指定できます。

    |値 |一致 | |--------------|------------------------------------------------------| |省略または * |任意のキーと一致する | |\0 |ラベルのない任意のキーと一致します (%00としてエンコードされた URL) | |prod |prod という名前のラベルを持つキーと一致します | |prod* |prod で始まるラベル名を持つキーと一致します |これらの文字は予約済みであり、* または \ または 、 を指定するには、先頭に円記号を付ける必要があります。

リファレンス: https://zcusa.951200.xyz/azure/azure-app-configuration/rest-api-key-value

labelFilter?: string

プロパティ値

string

ListSettingsOptions.labelFilter から継承された

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

OperationOptions.onResponse から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationOptions.requestOptions から継承された

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

OperationOptions.serializerOptions から継承された

tagsFilter

タグによるクエリに使用されるフィルター。 構文リファレンス: https://aka.ms/azconfig/docs/keyvaluefiltering

tagsFilter?: string[]

プロパティ値

string[]

listSettingsOptions.tagsFilter から継承

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationOptions.tracingOptions から継承された