KeyValues interface
Interface representing a KeyValues.
Methods
| begin |
Deletes a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead. |
| begin |
Deletes a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead. |
| create |
Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead. |
| get(string, string, string, Key |
Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead. |
Method Details
beginDelete(string, string, string, KeyValuesDeleteOptionalParams)
Deletes a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
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. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
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, KeyValue, KeyValuesCreateOrUpdateOptionalParams)
Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
function createOrUpdate(resourceGroupName: string, configStoreName: string, keyValueName: string, keyValueParameters: KeyValue, 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.
- keyValueParameters
- KeyValue
The parameters for creating a key-value.
The options parameters.
Returns
Promise<KeyValue>
get(string, string, string, KeyValuesGetOptionalParams)
Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
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>