Edit

Share via

Get-AzAppConfigurationKeyValue

Module:
Az.AppConfiguration Module

Gets a list of key-values.

Syntax

Get (Default) 

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>]

List 

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-After

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Endpoint

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IfMatch

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IfNoneMatch

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Key

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Label

A filter used to match labels

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Select

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

Parameter properties

Type:

List<T>[String]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SyncToken

Used to guarantee real-time consistency between requests.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

IKeyValue