Get-AzAppConfigurationKeyValue

Reference

Module:: Az.AppConfiguration

Gets a list of key-values.

Syntax

Get-AzAppConfigurationKeyValue
   -Endpoint <String>
   [-Key <String>]
   [-Label <String>]
   [-Select <System.Collections.Generic.List`1[System.String]>]
   [-AcceptDatetime <String>]
   [-SyncToken <String>]
   [-IfMatch <String>]
   [-IfNoneMatch <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzAppConfigurationKeyValue
   -Endpoint <String>
   [-Key <String>]
   [-Label <String>]
   [-Select <System.Collections.Generic.List`1[System.String]>]
   [-After <String>]
   [-AcceptDatetime <String>]
   [-SyncToken <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a list of key-values.

Examples

Example 1: Get all the key-values in an App Configuration store

Get-AzAppConfigurationKeyValue -Endpoint $endpoint

ContentType Etag                                        Key      Label LastModified       Locked SyncToken Value
----------- ----                                        ---      ----- ------------       ------ --------- -----
            7VYSVQjjNgQ987zh8bjsXeDqgdAUkspRblp6Ceh-Zb0 keyName1 label 7/21/2023 02:22:45 False            value1
            EAy26mDBHMBrUohZn-uJhNTTxoeKiMRin9h1OpfGpZc keyName2 label 7/21/2023 02:22:50 False            value2
            6tRurLbnyEBDKT7ynXV4F3mZpfA2hf_5z58cK2LDsHY keyName3 label 7/21/2023 02:22:55 False            value3

Get all the key-values in an App Configuration store

Example 2: List by key-values with wildcard

Get-AzAppConfigurationKeyValue -Endpoint $endpoint -Key "key*"

ContentType Etag                                        Key      Label LastModified       Locked SyncToken Value
----------- ----                                        ---      ----- ------------       ------ --------- -----
            7VYSVQjjNgQ987zh8bjsXeDqgdAUkspRblp6Ceh-Zb0 keyName1 label 7/21/2023 02:22:45 False            value1
            EAy26mDBHMBrUohZn-uJhNTTxoeKiMRin9h1OpfGpZc keyName2 label 7/21/2023 02:22:50 False            value2
            6tRurLbnyEBDKT7ynXV4F3mZpfA2hf_5z58cK2LDsHY keyName3 label 7/21/2023 02:22:55 False            value3

You can use wildcard to list key-values in an App Configuration store

Example 3: Get a key-value in an App Configuration store

Get-AzAppConfigurationKeyValue -Endpoint $endpoint -Key "keyName1"

ContentType Etag                                        Key      Label LastModified       Locked SyncToken Value
----------- ----                                        ---      ----- ------------       ------ --------- -----
            7VYSVQjjNgQ987zh8bjsXeDqgdAUkspRblp6Ceh-Zb0 keyName1 label 7/21/2023 02:22:45 False            value1

You can get a key-value in an App Configuration store with the key name.

Parameters

-AcceptDatetime

Requests the server to respond with the state of the resource at the specified time.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-After

Instructs the server to return elements that appear after the element referred to by the specified token.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Endpoint

The endpoint of the App Configuration instance to send requests to.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-IfMatch

Used to perform an operation only if the targeted resource's etag matches the value provided.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IfNoneMatch

Used to perform an operation only if the targeted resource's etag does not match the value provided.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Key

The key to retrieve. If is a wildcard expression, then the returned list will contain all keys that match the expression.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Label

A filter used to match labels

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Select

Used to select what fields are present in the returned resource(s).

Type:	List<T>[String]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SyncToken

Used to guarantee real-time consistency between requests.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

IKeyValue

Share via