Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/app-configuration

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AddConfigurationSettingParam

AddConfigurationSettingParam<T>: ConfigurationSettingParam<T>

Parameters for adding a new configuration setting

Type parameters

ApiVersion10

ApiVersion10: string

Defines values for ApiVersion10.
KnownApiVersion10 can be used interchangeably with ApiVersion10, this enum contains the known values that the service supports.

Known values supported by the service

1.0: Api Version '1.0'

CheckKeyValueResponse

CheckKeyValueResponse: AppConfigurationCheckKeyValueHeaders

Contains response data for the checkKeyValue operation.

CheckKeyValuesResponse

CheckKeyValuesResponse: AppConfigurationCheckKeyValuesHeaders

Contains response data for the checkKeyValues operation.

CheckKeysResponse

CheckKeysResponse: AppConfigurationCheckKeysHeaders

Contains response data for the checkKeys operation.

CheckLabelsResponse

CheckLabelsResponse: AppConfigurationCheckLabelsHeaders

Contains response data for the checkLabels operation.

CheckRevisionsResponse

CheckRevisionsResponse: AppConfigurationCheckRevisionsHeaders

Contains response data for the checkRevisions operation.

ConfigurationSetting

ConfigurationSetting<T>: ConfigurationSettingParam<T> & { isReadOnly: boolean; lastModified?: Date }

Configuration setting with extra metadata from the server, indicating its etag, whether it is currently readOnly and when it was last modified.

Type parameters

ConfigurationSettingParam

ConfigurationSettingParam<T>: ConfigurationSettingId & { contentType?: undefined | string; tags?: undefined | {} }

Necessary fields for updating or creating a new configuration setting

Type parameters

ConfigurationSettingResponse

ConfigurationSettingResponse<HeadersT>: ConfigurationSetting & HttpResponseField<HeadersT> & Pick<HeadersT, Exclude<keyof HeadersT, "eTag">>

Standard base response for getting, deleting or updating a configuration setting

Type parameters

  • HeadersT

DeleteKeyValueResponse

DeleteKeyValueResponse: AppConfigurationDeleteKeyValueHeaders & KeyValue

Contains response data for the deleteKeyValue operation.

DeleteLockResponse

DeleteLockResponse: AppConfigurationDeleteLockHeaders & KeyValue

Contains response data for the deleteLock operation.

Enum5

Enum5: string

Defines values for Enum5.
KnownEnum5 can be used interchangeably with Enum5, this enum contains the known values that the service supports.

Known values supported by the service

key
label
content_type
value
last_modified
tags
locked
etag

Enum6

Enum6: string

Defines values for Enum6.
KnownEnum6 can be used interchangeably with Enum6, this enum contains the known values that the service supports.

Known values supported by the service

key
label
content_type
value
last_modified
tags
locked
etag

Get6ItemsItem

Get6ItemsItem: string

Defines values for Get6ItemsItem.
KnownGet6ItemsItem can be used interchangeably with Get6ItemsItem, this enum contains the known values that the service supports.

Known values supported by the service

key
label
content_type
value
last_modified
tags
locked
etag

Get7ItemsItem

Get7ItemsItem: string

Defines values for Get7ItemsItem.
KnownGet7ItemsItem can be used interchangeably with Get7ItemsItem, this enum contains the known values that the service supports.

Known values supported by the service

key
label
content_type
value
last_modified
tags
locked
etag

GetKeyValueResponse

GetKeyValueResponse: AppConfigurationGetKeyValueHeaders & KeyValue

Contains response data for the getKeyValue operation.

GetKeyValuesNextResponse

GetKeyValuesNextResponse: AppConfigurationGetKeyValuesNextHeaders & KeyValueListResult

Contains response data for the getKeyValuesNext operation.

GetKeyValuesResponse

GetKeyValuesResponse: AppConfigurationGetKeyValuesHeaders & KeyValueListResult

Contains response data for the getKeyValues operation.

GetKeysNextResponse

GetKeysNextResponse: AppConfigurationGetKeysNextHeaders & KeyListResult

Contains response data for the getKeysNext operation.

GetKeysResponse

GetKeysResponse: AppConfigurationGetKeysHeaders & KeyListResult

Contains response data for the getKeys operation.

GetLabelsNextResponse

GetLabelsNextResponse: AppConfigurationGetLabelsNextHeaders & LabelListResult

Contains response data for the getLabelsNext operation.

GetLabelsResponse

GetLabelsResponse: AppConfigurationGetLabelsHeaders & LabelListResult

Contains response data for the getLabels operation.

GetRevisionsNextResponse

GetRevisionsNextResponse: AppConfigurationGetRevisionsNextHeaders & KeyValueListResult

Contains response data for the getRevisionsNext operation.

GetRevisionsResponse

GetRevisionsResponse: AppConfigurationGetRevisionsHeaders & KeyValueListResult

Contains response data for the getRevisions operation.

Head6ItemsItem

Head6ItemsItem: string

Defines values for Head6ItemsItem.
KnownHead6ItemsItem can be used interchangeably with Head6ItemsItem, this enum contains the known values that the service supports.

Known values supported by the service

key
label
content_type
value
last_modified
tags
locked
etag

Head7ItemsItem

Head7ItemsItem: string

Defines values for Head7ItemsItem.
KnownHead7ItemsItem can be used interchangeably with Head7ItemsItem, this enum contains the known values that the service supports.

Known values supported by the service

key
label
content_type
value
last_modified
tags
locked
etag

PutKeyValueResponse

PutKeyValueResponse: AppConfigurationPutKeyValueHeaders & KeyValue

Contains response data for the putKeyValue operation.

PutLockResponse

PutLockResponse: AppConfigurationPutLockHeaders & KeyValue

Contains response data for the putLock operation.

SetConfigurationSettingParam

SetConfigurationSettingParam<T>: ConfigurationSettingParam<T>

Parameters for creating or updating a new configuration setting

Type parameters

Variables

Const ConnectionStringRegex

ConnectionStringRegex: Object = /Endpoint=(.*);Id=(.*);Secret=(.*)/

Const featureFlagContentType

featureFlagContentType: "application/vnd.microsoft.appconfig.ff+json;charset=utf-8" = "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"

The content type for a FeatureFlag

Const featureFlagPrefix

featureFlagPrefix: ".appconfig.featureflag/" = ".appconfig.featureflag/"

The prefix for feature flags.

Const secretReferenceContentType

secretReferenceContentType: "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8" = "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"

content-type for the secret reference.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Const syncTokenRegex

syncTokenRegex: Object = /^([^=]+)=([^;]+);sn=(\d+)$/

Functions

appConfigKeyCredentialPolicy

  • appConfigKeyCredentialPolicy(credential: string, secret: string): PipelinePolicy

  • Create an HTTP pipeline policy to authenticate a request using an AzureKeyCredential for AppConfig.

    Parameters

    • credential: string
    • secret: string

    Returns PipelinePolicy

assertResponse

  • assertResponse<T>(result: T): assertsresult is T & HttpResponseField<any>

  • Type parameters

    • T: object

    Parameters

    • result: T

    Returns assertsresult is T & HttpResponseField<any>

hasUnderscoreResponse

  • hasUnderscoreResponse<T>(result: T): result is T & HttpResponseField<any>

  • Type parameters

    • T: object

    Parameters

    • result: T

    Returns result is T & HttpResponseField<any>

isFeatureFlag

  • isFeatureFlag(setting: ConfigurationSetting): setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">>

  • Lets you know if the ConfigurationSetting is a feature flag.

    [Checks if the content type is featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

    Parameters

    Returns setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">>

isSecretReference

  • isSecretReference(setting: ConfigurationSetting): setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">>

  • Lets you know if the ConfigurationSetting is a secret reference.

    [Checks if the content type is secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

    Parameters

    Returns setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">>

makeConfigurationSettingEmpty

  • makeConfigurationSettingEmpty(configurationSetting: Partial<Record<Exclude<keyof ConfigurationSetting, "key">, any>>): void

  • Makes a ConfigurationSetting-based response throw for all of the data members. Used primarily to prevent possible errors by the user in accessing a model that is uninitialized. This can happen in cases like HTTP status code 204 or 304, which return an empty response body.

    Parameters

    • configurationSetting: Partial<Record<Exclude<keyof ConfigurationSetting, "key">, any>>

      The configuration setting to alter

    Returns void

parseFeatureFlag

parseSecretReference

Object literals

Const AppConfigurationCheckKeyValueHeaders

AppConfigurationCheckKeyValueHeaders: object

type

type: object

className

className: string = "AppConfigurationCheckKeyValueHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: string = "String"

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationCheckKeyValuesHeaders

AppConfigurationCheckKeyValuesHeaders: object

type

type: object

className

className: string = "AppConfigurationCheckKeyValuesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationCheckKeysHeaders

AppConfigurationCheckKeysHeaders: object

type

type: object

className

className: string = "AppConfigurationCheckKeysHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationCheckLabelsHeaders

AppConfigurationCheckLabelsHeaders: object

type

type: object

className

className: string = "AppConfigurationCheckLabelsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationCheckRevisionsHeaders

AppConfigurationCheckRevisionsHeaders: object

type

type: object

className

className: string = "AppConfigurationCheckRevisionsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationDeleteKeyValueHeaders

AppConfigurationDeleteKeyValueHeaders: object

type

type: object

className

className: string = "AppConfigurationDeleteKeyValueHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationDeleteLockHeaders

AppConfigurationDeleteLockHeaders: object

type

type: object

className

className: string = "AppConfigurationDeleteLockHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetKeyValueHeaders

AppConfigurationGetKeyValueHeaders: object

type

type: object

className

className: string = "AppConfigurationGetKeyValueHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: string = "String"

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetKeyValuesHeaders

AppConfigurationGetKeyValuesHeaders: object

type

type: object

className

className: string = "AppConfigurationGetKeyValuesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetKeyValuesNextHeaders

AppConfigurationGetKeyValuesNextHeaders: object

type

type: object

className

className: string = "AppConfigurationGetKeyValuesNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetKeysHeaders

AppConfigurationGetKeysHeaders: object

type

type: object

className

className: string = "AppConfigurationGetKeysHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetKeysNextHeaders

AppConfigurationGetKeysNextHeaders: object

type

type: object

className

className: string = "AppConfigurationGetKeysNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetLabelsHeaders

AppConfigurationGetLabelsHeaders: object

type

type: object

className

className: string = "AppConfigurationGetLabelsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetLabelsNextHeaders

AppConfigurationGetLabelsNextHeaders: object

type

type: object

className

className: string = "AppConfigurationGetLabelsNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetRevisionsHeaders

AppConfigurationGetRevisionsHeaders: object

type

type: object

className

className: string = "AppConfigurationGetRevisionsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationGetRevisionsNextHeaders

AppConfigurationGetRevisionsNextHeaders: object

type

type: object

className

className: string = "AppConfigurationGetRevisionsNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationPutKeyValueHeaders

AppConfigurationPutKeyValueHeaders: object

type

type: object

className

className: string = "AppConfigurationPutKeyValueHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const AppConfigurationPutLockHeaders

AppConfigurationPutLockHeaders: object

type

type: object

className

className: string = "AppConfigurationPutLockHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

syncToken

syncToken: object

serializedName

serializedName: string = "sync-token"

type

type: object

name

name: string = "String"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

detail

detail: object

serializedName

serializedName: string = "detail"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "Number"

title

title: object

serializedName

serializedName: string = "title"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const Key

Key: object

type

type: object

className

className: string = "Key"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const KeyListResult

KeyListResult: object

type

type: object

className

className: string = "KeyListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "items"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Key"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "@nextLink"

type

type: object

name

name: string = "String"

Const KeyValue

KeyValue: object

type

type: object

className

className: string = "KeyValue"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

serializedName

serializedName: string = "content_type"

type

type: object

name

name: string = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

key

key: object

required

required: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: string = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last_modified"

type

type: object

name

name: string = "DateTime"

locked

locked: object

serializedName

serializedName: string = "locked"

type

type: object

name

name: string = "Boolean"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const KeyValueListResult

KeyValueListResult: object

type

type: object

className

className: string = "KeyValueListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "items"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "KeyValue"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "@nextLink"

type

type: object

name

name: string = "String"

Const Label

Label: object

type

type: object

className

className: string = "Label"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const LabelListResult

LabelListResult: object

type

type: object

className

className: string = "LabelListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

items

items: object

serializedName

serializedName: string = "items"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Label"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "@nextLink"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/vnd.microsoft.appconfig.keyset+json, application/json, application/problem+json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept1

accept1: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/vnd.microsoft.appconfig.kvset+json, application/json, application/problem+json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept2

accept2: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/vnd.microsoft.appconfig.kv+json, application/json, application/problem+json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept3

accept3: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/vnd.microsoft.appconfig.labelset+json, application/json, application/problem+json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const acceptDatetime

acceptDatetime: object

parameterPath

parameterPath: string[] = ["options", "acceptDatetime"]

mapper

mapper: object

serializedName

serializedName: string = "Accept-Datetime"

type

type: object

name

name: string = "String"

Const after

after: object

parameterPath

parameterPath: string[] = ["options", "after"]

mapper

mapper: object

serializedName

serializedName: string = "After"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object = "1.0"

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const checkKeyValueOperationSpec

checkKeyValueOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.ifMatch,Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/kv/{key}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.label,Parameters.select3]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.key1]

responses

responses: object

default

default: {}

Type declaration

200

200: object

headersMapper

headersMapper: any = Mappers.AppConfigurationCheckKeyValueHeaders

304

304: object

headersMapper

headersMapper: any = Mappers.AppConfigurationCheckKeyValueHeaders

Const checkKeyValuesOperationSpec

checkKeyValuesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken, Parameters.acceptDatetime]

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/kv"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.after,Parameters.key,Parameters.label,Parameters.select1]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

default

default: {}

Type declaration

200

200: object

headersMapper

headersMapper: any = Mappers.AppConfigurationCheckKeyValuesHeaders

Const checkKeysOperationSpec

checkKeysOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken, Parameters.acceptDatetime]

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/keys"

queryParameters

queryParameters: any[] = [Parameters.name, Parameters.apiVersion, Parameters.after]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

default

default: {}

Type declaration

200

200: object

headersMapper

headersMapper: any = Mappers.AppConfigurationCheckKeysHeaders

Const checkLabelsOperationSpec

checkLabelsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken, Parameters.acceptDatetime]

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/labels"

queryParameters

queryParameters: any[] = [Parameters.name,Parameters.apiVersion,Parameters.after,Parameters.select4]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

default

default: {}

Type declaration

200

200: object

headersMapper

headersMapper: any = Mappers.AppConfigurationCheckLabelsHeaders

Const checkRevisionsOperationSpec

checkRevisionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken, Parameters.acceptDatetime]

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/revisions"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.after,Parameters.key,Parameters.label,Parameters.select6]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

default

default: {}

Type declaration

200

200: object

headersMapper

headersMapper: any = Mappers.AppConfigurationCheckRevisionsHeaders

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/vnd.microsoft.appconfig.kv+json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const deleteKeyValueOperationSpec

deleteKeyValueOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.accept2,Parameters.ifMatch]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/kv/{key}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.label]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.key1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValue

headersMapper

headersMapper: any = Mappers.AppConfigurationDeleteKeyValueHeaders

204

204: object

headersMapper

headersMapper: any = Mappers.AppConfigurationDeleteKeyValueHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const deleteLockOperationSpec

deleteLockOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.accept2,Parameters.ifMatch,Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/locks/{key}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.label]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.key1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValue

headersMapper

headersMapper: any = Mappers.AppConfigurationDeleteLockHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const deserializationContentTypes

deserializationContentTypes: object

json

json: string[] = ["application/vnd.microsoft.appconfig.kvset+json","application/vnd.microsoft.appconfig.kv+json","application/vnd.microsoft.appconfig.kvs+json","application/vnd.microsoft.appconfig.keyset+json","application/vnd.microsoft.appconfig.revs+json",]

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const entity

entity: object

mapper

mapper: any = KeyValueMapper

parameterPath

parameterPath: string[] = ["options", "entity"]

Const getKeyValueOperationSpec

getKeyValueOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept2,Parameters.ifMatch,Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "GET"

path

path: string = "/kv/{key}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.label,Parameters.select2]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.key1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValue

headersMapper

headersMapper: any = Mappers.AppConfigurationGetKeyValueHeaders

304

304: object

headersMapper

headersMapper: any = Mappers.AppConfigurationGetKeyValueHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getKeyValuesNextOperationSpec

getKeyValuesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.after,Parameters.key,Parameters.label,Parameters.select]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValueListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetKeyValuesNextHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getKeyValuesOperationSpec

getKeyValuesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/kv"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.after,Parameters.key,Parameters.label,Parameters.select]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValueListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetKeyValuesHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getKeysNextOperationSpec

getKeysNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept,Parameters.syncToken,Parameters.acceptDatetime]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.name, Parameters.apiVersion, Parameters.after]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetKeysNextHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getKeysOperationSpec

getKeysOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept,Parameters.syncToken,Parameters.acceptDatetime]

httpMethod

httpMethod: string = "GET"

path

path: string = "/keys"

queryParameters

queryParameters: any[] = [Parameters.name, Parameters.apiVersion, Parameters.after]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetKeysHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getLabelsNextOperationSpec

getLabelsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept3]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.name,Parameters.apiVersion,Parameters.after,Parameters.select4]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LabelListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetLabelsNextHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getLabelsOperationSpec

getLabelsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept3]

httpMethod

httpMethod: string = "GET"

path

path: string = "/labels"

queryParameters

queryParameters: any[] = [Parameters.name,Parameters.apiVersion,Parameters.after,Parameters.select4]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LabelListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetLabelsHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getRevisionsNextOperationSpec

getRevisionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.after,Parameters.key,Parameters.label,Parameters.select5]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValueListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetRevisionsNextHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const getRevisionsOperationSpec

getRevisionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.acceptDatetime,Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/revisions"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.after,Parameters.key,Parameters.label,Parameters.select5]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValueListResult

headersMapper

headersMapper: any = Mappers.AppConfigurationGetRevisionsHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const ifMatch

ifMatch: object

parameterPath

parameterPath: string[] = ["options", "ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: string = "String"

Const ifNoneMatch

ifNoneMatch: object

parameterPath

parameterPath: string[] = ["options", "ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: string = "String"

Const key

key: object

parameterPath

parameterPath: string[] = ["options", "key"]

mapper

mapper: object

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

Const key1

key1: object

parameterPath

parameterPath: string = "key"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

Const label

label: object

parameterPath

parameterPath: string[] = ["options", "label"]

mapper

mapper: object

serializedName

serializedName: string = "label"

type

type: object

name

name: string = "String"

Const name

name: object

parameterPath

parameterPath: string[] = ["options", "name"]

mapper

mapper: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const putKeyValueOperationSpec

putKeyValueOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.accept2,Parameters.ifMatch,Parameters.ifNoneMatch,Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/kv/{key}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.label]

requestBody

requestBody: any = Parameters.entity

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.key1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValue

headersMapper

headersMapper: any = Mappers.AppConfigurationPutKeyValueHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const putLockOperationSpec

putLockOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.syncToken,Parameters.accept2,Parameters.ifMatch,Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "PUT"

path

path: string = "/locks/{key}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.label]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.key1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyValue

headersMapper

headersMapper: any = Mappers.AppConfigurationPutLockHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorModel

Const select

select: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const select1

select1: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const select2

select2: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const select3

select3: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const select4

select4: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

defaultValue

defaultValue: string = "name"

isConstant

isConstant: boolean = true

type

type: object

name

name: string = "String"

Const select5

select5: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const select6

select6: object

collectionFormat

collectionFormat: string = "CSV"

parameterPath

parameterPath: string[] = ["options", "select"]

mapper

mapper: object

serializedName

serializedName: string = "$Select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const syncToken

syncToken: object

parameterPath

parameterPath: string = "syncToken"

mapper

mapper: object

serializedName

serializedName: string = "Sync-Token"

type

type: object

name

name: string = "String"

Generated using TypeDoc