Share via

ListConfigurationSettingsOptions interface

  • Reference
Package:
@azure/app-configuration

Options for listConfigurationSettings that allow for filtering based on keys, labels and other fields. Also provides fields which allows you to selectively choose which fields are populated in the result.

Extends

OperationOptions,ListSettingsOptions

Properties

pageEtags

Etags list for page

Inherited Properties

abortSignal

The signal which can be used to abort requests.
acceptDateTime

Requests the server to respond with the state of the resource at the specified time.
fields

Which fields to return for each ConfigurationSetting
keyFilter

Filters for keys. There are two types of matching:

  1. Exact matching. Up to 5 key names are allowed, separated by commas (',')

  2. Wildcard matching. A single wildcard expression can be specified.

    Value Matches
    omitted or * Matches any key
    abc Matches a key named abc
    abc* Matches key names that start with abc

These characters are reserved and must be prefixed with backslash in order to be specified: * or \ or ,
labelFilter

Filters for labels. There are two types of matching:

  1. Exact matching. Up to 5 labels are allowed, separated by commas (',')

  2. Wildcard matching. A single wildcard expression can be specified.

    | Value | Matches | |--------------|------------------------------------------------------| | omitted or * | Matches any key | | \0 | Matches any key without a label (URL encoded as %00) | | prod | Matches a key with label named prod | | prod* | Matches key with label names that start with prod | These characters are reserved and must be prefixed with backslash in order to be specified: * or \ or ,

Reference: https://learn.microsoft.com/azure/azure-app-configuration/rest-api-key-value
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
serializerOptions

Options to override serialization/de-serialization behavior.
tagsFilter

A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering
tracingOptions

Options used when tracing is enabled.

Property Details

pageEtags

Etags list for page

pageEtags?: string[]

Property Value

string[]

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

acceptDateTime

Requests the server to respond with the state of the resource at the specified time.

acceptDateTime?: Date

Property Value

Date

Inherited From ListSettingsOptions.acceptDateTime

fields

Which fields to return for each ConfigurationSetting

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

Property Value

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

Inherited From ListSettingsOptions.fields

keyFilter

Filters for keys. There are two types of matching:

  1. Exact matching. Up to 5 key names are allowed, separated by commas (',')

  2. Wildcard matching. A single wildcard expression can be specified.

    Value Matches
    omitted or * Matches any key
    abc Matches a key named abc
    abc* Matches key names that start with abc

These characters are reserved and must be prefixed with backslash in order to be specified: * or \ or ,

keyFilter?: string

Property Value

string

Inherited From ListSettingsOptions.keyFilter

labelFilter

Filters for labels. There are two types of matching:

  1. Exact matching. Up to 5 labels are allowed, separated by commas (',')

  2. Wildcard matching. A single wildcard expression can be specified.

    | Value | Matches | |--------------|------------------------------------------------------| | omitted or * | Matches any key | | \0 | Matches any key without a label (URL encoded as %00) | | prod | Matches a key with label named prod | | prod* | Matches key with label names that start with prod | These characters are reserved and must be prefixed with backslash in order to be specified: * or \ or ,

Reference: https://learn.microsoft.com/azure/azure-app-configuration/rest-api-key-value

labelFilter?: string

Property Value

string

Inherited From ListSettingsOptions.labelFilter

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tagsFilter

A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering

tagsFilter?: string[]

Property Value

string[]

Inherited From ListSettingsOptions.tagsFilter

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions