KeyValue interface

The key-value resource along with all resource properties.

Extends

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.

key

The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.

label

A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.

lastModified

The last time a modifying operation was performed on the given key-value.

locked

A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.

tags

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

value

The value of the key-value.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

eTag?: 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.

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.

label?: string

Property Value

string

lastModified

The last time a modifying operation was performed on the given key-value.

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.

locked?: boolean

Property Value

boolean

tags

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

tags?: Record<string, string>

Property Value

Record<string, string>

value

The value of the key-value.

value?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type