AppConfiguration | @azure/app-configuration

Hierarchy

AppConfigurationContext
- AppConfiguration

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AppConfiguration(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, apiVersion: string, options?: Models.AppConfigurationOptions): AppConfiguration

Overrides AppConfigurationContext.constructor
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:17
Initializes a new instance of the AppConfiguration class.

Parameters
- credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials
  
  Subscription credentials which uniquely identify client subscription.
- apiVersion: string
  
  The API version to be used with the HTTP request.
- Optional options: Models.AppConfigurationOptions
Returns AppConfiguration

Properties

apiVersion

apiVersion: string

credentials

credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials

Optional syncToken

syncToken: undefined | string

Methods

checkKeyValue

checkKeyValue(key: string, options?: Models.AppConfigurationCheckKeyValueOptionalParams): Promise<Models.CheckKeyValueResponse>
checkKeyValue(key: string, callback: coreHttp.ServiceCallback<void>): void
checkKeyValue(key: string, options: AppConfigurationCheckKeyValueOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:214
summary

Requests the headers and status of the given resource.

Parameters
- key: string
  
  The key of the key-value to retrieve.
- Optional options: Models.AppConfigurationCheckKeyValueOptionalParams
Returns Promise<Models.CheckKeyValueResponse>

Promise<Models.CheckKeyValueResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:219
Parameters
- key: string
  
  The key of the key-value to retrieve.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:225
Parameters
- key: string
  
  The key of the key-value to retrieve.
- options: AppConfigurationCheckKeyValueOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

checkKeyValues

checkKeyValues(options?: Models.AppConfigurationCheckKeyValuesOptionalParams): Promise<Models.CheckKeyValuesResponse>
checkKeyValues(callback: coreHttp.ServiceCallback<void>): void
checkKeyValues(options: AppConfigurationCheckKeyValuesOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:105
summary

Requests the headers and status of the given resource.

Parameters
- Optional options: Models.AppConfigurationCheckKeyValuesOptionalParams
Returns Promise<Models.CheckKeyValuesResponse>

Promise<Models.CheckKeyValuesResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:109
Parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:114
Parameters
- options: AppConfigurationCheckKeyValuesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

checkKeys

checkKeys(options?: Models.AppConfigurationCheckKeysOptionalParams): Promise<Models.CheckKeysResponse>
checkKeys(callback: coreHttp.ServiceCallback<void>): void
checkKeys(options: AppConfigurationCheckKeysOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:57
summary

Requests the headers and status of the given resource.

Parameters
- Optional options: Models.AppConfigurationCheckKeysOptionalParams
Returns Promise<Models.CheckKeysResponse>

Promise<Models.CheckKeysResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:61
Parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:66
Parameters
- options: AppConfigurationCheckKeysOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

checkLabels

checkLabels(options?: Models.AppConfigurationCheckLabelsOptionalParams): Promise<Models.CheckLabelsResponse>
checkLabels(callback: coreHttp.ServiceCallback<void>): void
checkLabels(options: AppConfigurationCheckLabelsOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:265
summary

Requests the headers and status of the given resource.

Parameters
- Optional options: Models.AppConfigurationCheckLabelsOptionalParams
Returns Promise<Models.CheckLabelsResponse>

Promise<Models.CheckLabelsResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:269
Parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:274
Parameters
- options: AppConfigurationCheckLabelsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

checkRevisions

checkRevisions(options?: Models.AppConfigurationCheckRevisionsOptionalParams): Promise<Models.CheckRevisionsResponse>
checkRevisions(callback: coreHttp.ServiceCallback<void>): void
checkRevisions(options: AppConfigurationCheckRevisionsOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:369
summary

Requests the headers and status of the given resource.

Parameters
- Optional options: Models.AppConfigurationCheckRevisionsOptionalParams
Returns Promise<Models.CheckRevisionsResponse>

Promise<Models.CheckRevisionsResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:373
Parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:378
Parameters
- options: AppConfigurationCheckRevisionsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

deleteKeyValue

deleteKeyValue(key: string, options?: Models.AppConfigurationDeleteKeyValueOptionalParams): Promise<Models.DeleteKeyValueResponse>
deleteKeyValue(key: string, callback: coreHttp.ServiceCallback<KeyValue>): void
deleteKeyValue(key: string, options: AppConfigurationDeleteKeyValueOptionalParams, callback: coreHttp.ServiceCallback<KeyValue>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:186
summary

Deletes a key-value.

Parameters
- key: string
  
  The key of the key-value to delete.
- Optional options: Models.AppConfigurationDeleteKeyValueOptionalParams
Returns Promise<Models.DeleteKeyValueResponse>

Promise<Models.DeleteKeyValueResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:191
Parameters
- key: string
  
  The key of the key-value to delete.
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:197
Parameters
- key: string
  
  The key of the key-value to delete.
- options: AppConfigurationDeleteKeyValueOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void

deleteLock

deleteLock(key: string, options?: Models.AppConfigurationDeleteLockOptionalParams): Promise<Models.DeleteLockResponse>
deleteLock(key: string, callback: coreHttp.ServiceCallback<KeyValue>): void
deleteLock(key: string, options: AppConfigurationDeleteLockOptionalParams, callback: coreHttp.ServiceCallback<KeyValue>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:318
summary

Unlocks a key-value.

Parameters
- key: string
  
  The key of the key-value to unlock.
- Optional options: Models.AppConfigurationDeleteLockOptionalParams
Returns Promise<Models.DeleteLockResponse>

Promise<Models.DeleteLockResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:323
Parameters
- key: string
  
  The key of the key-value to unlock.
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:329
Parameters
- key: string
  
  The key of the key-value to unlock.
- options: AppConfigurationDeleteLockOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void

getKeyValue

getKeyValue(key: string, options?: Models.AppConfigurationGetKeyValueOptionalParams): Promise<Models.GetKeyValueResponse>
getKeyValue(key: string, callback: coreHttp.ServiceCallback<KeyValue>): void
getKeyValue(key: string, options: AppConfigurationGetKeyValueOptionalParams, callback: coreHttp.ServiceCallback<KeyValue>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:130
summary

Gets a single key-value.

Parameters
- key: string
  
  The key of the key-value to retrieve.
- Optional options: Models.AppConfigurationGetKeyValueOptionalParams
Returns Promise<Models.GetKeyValueResponse>

Promise<Models.GetKeyValueResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:135
Parameters
- key: string
  
  The key of the key-value to retrieve.
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:141
Parameters
- key: string
  
  The key of the key-value to retrieve.
- options: AppConfigurationGetKeyValueOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void

getKeyValues

getKeyValues(options?: Models.AppConfigurationGetKeyValuesOptionalParams): Promise<Models.GetKeyValuesResponse>
getKeyValues(callback: coreHttp.ServiceCallback<KeyValueListResult>): void
getKeyValues(options: AppConfigurationGetKeyValuesOptionalParams, callback: coreHttp.ServiceCallback<KeyValueListResult>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:81
summary

Gets a list of key-values.

Parameters
- Optional options: Models.AppConfigurationGetKeyValuesOptionalParams
Returns Promise<Models.GetKeyValuesResponse>

Promise<Models.GetKeyValuesResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:85
Parameters
- callback: coreHttp.ServiceCallback<KeyValueListResult>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:90
Parameters
- options: AppConfigurationGetKeyValuesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValueListResult>
  
  The callback
Returns void

getKeys

getKeys(options?: Models.AppConfigurationGetKeysOptionalParams): Promise<Models.GetKeysResponse>
getKeys(callback: coreHttp.ServiceCallback<KeyListResult>): void
getKeys(options: AppConfigurationGetKeysOptionalParams, callback: coreHttp.ServiceCallback<KeyListResult>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:33
summary

Gets a list of keys.

Parameters
- Optional options: Models.AppConfigurationGetKeysOptionalParams
Returns Promise<Models.GetKeysResponse>

Promise<Models.GetKeysResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:37
Parameters
- callback: coreHttp.ServiceCallback<KeyListResult>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:42
Parameters
- options: AppConfigurationGetKeysOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyListResult>
  
  The callback
Returns void

getLabels

getLabels(options?: Models.AppConfigurationGetLabelsOptionalParams): Promise<Models.GetLabelsResponse>
getLabels(callback: coreHttp.ServiceCallback<LabelListResult>): void
getLabels(options: AppConfigurationGetLabelsOptionalParams, callback: coreHttp.ServiceCallback<LabelListResult>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:241
summary

Gets a list of labels.

Parameters
- Optional options: Models.AppConfigurationGetLabelsOptionalParams
Returns Promise<Models.GetLabelsResponse>

Promise<Models.GetLabelsResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:245
Parameters
- callback: coreHttp.ServiceCallback<LabelListResult>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:250
Parameters
- options: AppConfigurationGetLabelsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<LabelListResult>
  
  The callback
Returns void

getRevisions

getRevisions(options?: Models.AppConfigurationGetRevisionsOptionalParams): Promise<Models.GetRevisionsResponse>
getRevisions(callback: coreHttp.ServiceCallback<KeyValueListResult>): void
getRevisions(options: AppConfigurationGetRevisionsOptionalParams, callback: coreHttp.ServiceCallback<KeyValueListResult>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:345
summary

Gets a list of key-value revisions.

Parameters
- Optional options: Models.AppConfigurationGetRevisionsOptionalParams
Returns Promise<Models.GetRevisionsResponse>

Promise<Models.GetRevisionsResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:349
Parameters
- callback: coreHttp.ServiceCallback<KeyValueListResult>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:354
Parameters
- options: AppConfigurationGetRevisionsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValueListResult>
  
  The callback
Returns void

putKeyValue

putKeyValue(key: string, options?: Models.AppConfigurationPutKeyValueOptionalParams): Promise<Models.PutKeyValueResponse>
putKeyValue(key: string, callback: coreHttp.ServiceCallback<KeyValue>): void
putKeyValue(key: string, options: AppConfigurationPutKeyValueOptionalParams, callback: coreHttp.ServiceCallback<KeyValue>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:158
summary

Creates a key-value.

Parameters
- key: string
  
  The key of the key-value to create.
- Optional options: Models.AppConfigurationPutKeyValueOptionalParams
Returns Promise<Models.PutKeyValueResponse>

Promise<Models.PutKeyValueResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:163
Parameters
- key: string
  
  The key of the key-value to create.
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:169
Parameters
- key: string
  
  The key of the key-value to create.
- options: AppConfigurationPutKeyValueOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void

putLock

putLock(key: string, options?: Models.AppConfigurationPutLockOptionalParams): Promise<Models.PutLockResponse>
putLock(key: string, callback: coreHttp.ServiceCallback<KeyValue>): void
putLock(key: string, options: AppConfigurationPutLockOptionalParams, callback: coreHttp.ServiceCallback<KeyValue>): void

- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:290
summary

Locks a key-value.

Parameters
- key: string
  
  The key of the key-value to lock.
- Optional options: Models.AppConfigurationPutLockOptionalParams
Returns Promise<Models.PutLockResponse>

Promise<Models.PutLockResponse>
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:295
Parameters
- key: string
  
  The key of the key-value to lock.
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void
- Defined in home/vsts/work/1/s/sdk/appconfiguration/app-configuration/src/generated/src/appConfiguration.ts:301
Parameters
- key: string
  
  The key of the key-value to lock.
- options: AppConfigurationPutLockOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyValue>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials

apiVersion: string

Optional options: Models.AppConfigurationOptions

Returns AppConfiguration

Properties

apiVersion

credentials

Optional syncToken

Methods

checkKeyValue

Parameters

key: string

Optional options: Models.AppConfigurationCheckKeyValueOptionalParams

Returns Promise<Models.CheckKeyValueResponse>

Parameters

key: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

key: string

options: AppConfigurationCheckKeyValueOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

checkKeyValues

Parameters

Optional options: Models.AppConfigurationCheckKeyValuesOptionalParams

Returns Promise<Models.CheckKeyValuesResponse>

Parameters

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

options: AppConfigurationCheckKeyValuesOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

checkKeys

Parameters

Optional options: Models.AppConfigurationCheckKeysOptionalParams

Returns Promise<Models.CheckKeysResponse>

Parameters

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

options: AppConfigurationCheckKeysOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

checkLabels

Parameters

Optional options: Models.AppConfigurationCheckLabelsOptionalParams

Returns Promise<Models.CheckLabelsResponse>

Parameters

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

options: AppConfigurationCheckLabelsOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

checkRevisions

Parameters

Optional options: Models.AppConfigurationCheckRevisionsOptionalParams

Returns Promise<Models.CheckRevisionsResponse>

Parameters

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

options: AppConfigurationCheckRevisionsOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

deleteKeyValue

Parameters

key: string

Optional options: Models.AppConfigurationDeleteKeyValueOptionalParams

Returns Promise<Models.DeleteKeyValueResponse>