KeyValue interface

The key-value resource along with all resource properties.

Properties

contentType

The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications.

eTag

An ETag indicating the state of a key-value within a configuration store. NOTE: This property will not be serialized. It can only be populated by the server.

id

The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

key

The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. NOTE: This property will not be serialized. It can only be populated by the server.

label

A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified

The last time a modifying operation was performed on the given key-value. NOTE: This property will not be serialized. It can only be populated by the server.

locked

A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

tags

A dictionary of tags that can help identify what a key-value may be applicable for.

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

value

The value of the key-value.

Property Details

contentType

The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications.

contentType?: string

Property Value

string

eTag

An ETag indicating the state of a key-value within a configuration store. NOTE: This property will not be serialized. It can only be populated by the server.

eTag?: string

Property Value

string

id

The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

key

The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. NOTE: This property will not be serialized. It can only be populated by the server.

key?: string

Property Value

string

label

A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. NOTE: This property will not be serialized. It can only be populated by the server.

label?: string

Property Value

string

lastModified

The last time a modifying operation was performed on the given key-value. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified?: Date

Property Value

Date

locked

A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. NOTE: This property will not be serialized. It can only be populated by the server.

locked?: boolean

Property Value

boolean

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

tags

A dictionary of tags that can help identify what a key-value may be applicable for.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

value

The value of the key-value.

value?: string

Property Value

string