Share via

KeyValues interface

  • Reference
Package:
@azure/arm-appconfiguration

Interface representing a KeyValues.

Methods

beginDelete(string, string, string, KeyValuesDeleteOptionalParams)

Deletes a key-value.
beginDeleteAndWait(string, string, string, KeyValuesDeleteOptionalParams)

Deletes a key-value.
createOrUpdate(string, string, string, KeyValuesCreateOrUpdateOptionalParams)

Creates a key-value.
get(string, string, string, KeyValuesGetOptionalParams)

Gets the properties of the specified key-value.

Method Details

beginDelete(string, string, string, KeyValuesDeleteOptionalParams)

Deletes a key-value.

function beginDelete(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

keyValueName

string

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

options
KeyValuesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, KeyValuesDeleteOptionalParams)

Deletes a key-value.

function beginDeleteAndWait(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

keyValueName

string

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

options
KeyValuesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, KeyValuesCreateOrUpdateOptionalParams)

Creates a key-value.

function createOrUpdate(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesCreateOrUpdateOptionalParams): Promise<KeyValue>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

keyValueName

string

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

options
KeyValuesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<KeyValue>

get(string, string, string, KeyValuesGetOptionalParams)

Gets the properties of the specified key-value.

function get(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesGetOptionalParams): Promise<KeyValue>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

keyValueName

string

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

options
KeyValuesGetOptionalParams

The options parameters.

Returns

Promise<KeyValue>