@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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.
*
* Uses Azure REST API version 2024-05-01.
*
* Other available API versions: 2023-03-01, 2023-08-01-preview, 2023-09-01-preview, 2024-06-01, 2024-06-15-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native appconfiguration [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getKeyValue(args: GetKeyValueArgs, opts?: pulumi.InvokeOptions): Promise<GetKeyValueResult>;
export interface GetKeyValueArgs {
/**
* The name of the configuration store.
*/
configStoreName: string;
/**
* Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
*/
keyValueName: string;
/**
* The name of the resource group to which the container registry belongs.
*/
resourceGroupName: string;
}
/**
* The key-value resource along with all resource properties.
*/
export interface GetKeyValueResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* 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.
*/
readonly contentType?: string;
/**
* An ETag indicating the state of a key-value within a configuration store.
*/
readonly eTag: string;
/**
* The resource ID.
*/
readonly id: string;
/**
* The primary identifier of a key-value.
* The key is used in unison with the label to uniquely identify a key-value.
*/
readonly key: string;
/**
* A value used to group key-values.
* The label is used in unison with the key to uniquely identify a key-value.
*/
readonly label: string;
/**
* The last time a modifying operation was performed on the given key-value.
*/
readonly lastModified: string;
/**
* A value indicating whether the key-value is locked.
* A locked key-value may not be modified until it is unlocked.
*/
readonly locked: boolean;
/**
* The name of the resource.
*/
readonly name: string;
/**
* A dictionary of tags that can help identify what a key-value may be applicable for.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource.
*/
readonly type: string;
/**
* The value of the key-value.
*/
readonly value?: string;
}
/**
* 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.
*
* Uses Azure REST API version 2024-05-01.
*
* Other available API versions: 2023-03-01, 2023-08-01-preview, 2023-09-01-preview, 2024-06-01, 2024-06-15-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native appconfiguration [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getKeyValueOutput(args: GetKeyValueOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKeyValueResult>;
export interface GetKeyValueOutputArgs {
/**
* The name of the configuration store.
*/
configStoreName: pulumi.Input<string>;
/**
* Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
*/
keyValueName: pulumi.Input<string>;
/**
* The name of the resource group to which the container registry belongs.
*/
resourceGroupName: pulumi.Input<string>;
}