Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. appconfiguration
  5. getKeyValue
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.appconfiguration.getKeyValue

Explore with Pulumi AI

azure-native-v2 logo
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

    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. Azure REST API version: 2023-03-01.

    Other available API versions: 2023-08-01-preview, 2023-09-01-preview, 2024-05-01.

    Using getKeyValue

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKeyValue(args: GetKeyValueArgs, opts?: InvokeOptions): Promise<GetKeyValueResult>
function getKeyValueOutput(args: GetKeyValueOutputArgs, opts?: InvokeOptions): Output<GetKeyValueResult>
    def get_key_value(config_store_name: Optional[str] = None,
                  key_value_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetKeyValueResult
def get_key_value_output(config_store_name: Optional[pulumi.Input[str]] = None,
                  key_value_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetKeyValueResult]
    func LookupKeyValue(ctx *Context, args *LookupKeyValueArgs, opts ...InvokeOption) (*LookupKeyValueResult, error)
func LookupKeyValueOutput(ctx *Context, args *LookupKeyValueOutputArgs, opts ...InvokeOption) LookupKeyValueResultOutput

    > Note: This function is named LookupKeyValue in the Go SDK.

    public static class GetKeyValue 
{
    public static Task<GetKeyValueResult> InvokeAsync(GetKeyValueArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyValueResult> Invoke(GetKeyValueInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyValueResult> getKeyValue(GetKeyValueArgs args, InvokeOptions options)
public static Output<GetKeyValueResult> getKeyValue(GetKeyValueArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:appconfiguration:getKeyValue
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    resourceGroupName string
    The name of the resource group to which the container registry belongs.
    config_store_name str
    The name of the configuration store.
    key_value_name str
    Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
    resource_group_name str
    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.
    resourceGroupName String
    The name of the resource group to which the container registry belongs.

    getKeyValue Result

    The following output properties are available:

    ETag string
    An ETag indicating the state of a key-value within a configuration store.
    Id string
    The resource ID.
    Key string
    The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
    Label string
    A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
    LastModified string
    The last time a modifying operation was performed on the given key-value.
    Locked bool
    A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
    Name string
    The name of the resource.
    Type string
    The type of the resource.
    ContentType 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.
    Tags Dictionary<string, string>
    A dictionary of tags that can help identify what a key-value may be applicable for.
    Value string
    The value of the key-value.
    ETag string
    An ETag indicating the state of a key-value within a configuration store.
    Id string
    The resource ID.
    Key string
    The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
    Label string
    A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
    LastModified string
    The last time a modifying operation was performed on the given key-value.
    Locked bool
    A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
    Name string
    The name of the resource.
    Type string
    The type of the resource.
    ContentType 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.
    Tags map[string]string
    A dictionary of tags that can help identify what a key-value may be applicable for.
    Value string
    The value of the key-value.
    eTag String
    An ETag indicating the state of a key-value within a configuration store.
    id String
    The resource ID.
    key String
    The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
    label String
    A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
    lastModified String
    The last time a modifying operation was performed on the given key-value.
    locked Boolean
    A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
    name String
    The name of the resource.
    type String
    The type of the resource.
    contentType 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.
    tags Map<String,String>
    A dictionary of tags that can help identify what a key-value may be applicable for.
    value String
    The value of the key-value.
    eTag string
    An ETag indicating the state of a key-value within a configuration store.
    id string
    The resource ID.
    key string
    The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
    label string
    A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
    lastModified string
    The last time a modifying operation was performed on the given key-value.
    locked boolean
    A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
    name string
    The name of the resource.
    type string
    The type of the resource.
    contentType 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.
    tags {[key: string]: string}
    A dictionary of tags that can help identify what a key-value may be applicable for.
    value string
    The value of the key-value.
    e_tag str
    An ETag indicating the state of a key-value within a configuration store.
    id str
    The resource ID.
    key str
    The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
    label str
    A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
    last_modified str
    The last time a modifying operation was performed on the given key-value.
    locked bool
    A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
    name str
    The name of the resource.
    type str
    The type of the resource.
    content_type str
    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.
    tags Mapping[str, str]
    A dictionary of tags that can help identify what a key-value may be applicable for.
    value str
    The value of the key-value.
    eTag String
    An ETag indicating the state of a key-value within a configuration store.
    id String
    The resource ID.
    key String
    The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
    label String
    A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
    lastModified String
    The last time a modifying operation was performed on the given key-value.
    locked Boolean
    A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
    name String
    The name of the resource.
    type String
    The type of the resource.
    contentType 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.
    tags Map<String>
    A dictionary of tags that can help identify what a key-value may be applicable for.
    value String
    The value of the key-value.

    Package Details

    Repository
    azure-native-v2 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v2 logo
    These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
    Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-azure-native