Package version:

Interface ListConfigurationSettingsOptions

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.

interface ListConfigurationSettingsOptions {
    acceptDateTime?: any;
    fields?: (
        | "value"
        | "contentType"
        | "tags"
        | "isReadOnly"
        | "lastModified"
        | (keyof ConfigurationSettingId))[];
    keyFilter?: string;
    labelFilter?: string;
    pageEtags?: string[];
    tagsFilter?: string[];
}

Hierarchy (view full)

Properties

acceptDateTime? fields? keyFilter? labelFilter? pageEtags? tagsFilter?

Properties

OptionalacceptDateTime

acceptDateTime?: any

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

Optionalfields

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

Which fields to return for each ConfigurationSetting

OptionalkeyFilter

keyFilter?: string

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 ,

OptionallabelFilter

labelFilter?: string

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

OptionalpageEtags

pageEtags?: string[]

Etags list for page

OptionaltagsFilter

tagsFilter?: string[]

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

Settings

Member Visibility