Share via

ListSettingsOptions interface

  • Reference
Package:
@azure/app-configuration

Common options for 'list' style APIs in AppConfig used to specify wildcards as well as the accept date time header.

Extends
OptionalFields

Properties

acceptDateTime

Requests the server to respond with the state of the resource at the specified time.
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
tagsFilter

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

Inherited Properties

fields

Which fields to return for each ConfigurationSetting

Property Details

acceptDateTime

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

acceptDateTime?: Date

Property Value

Date

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

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

tagsFilter

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

tagsFilter?: string[]

Property Value

string[]

Inherited Property Details

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 OptionalFields.fields