Test-AzAppConfigurationKeyValue

Reference

Module:: Az.AppConfiguration

Requests the headers and status of the given resource.

Syntax

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

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

Description

Requests the headers and status of the given resource.

Examples

Example 1: Test a key-value in an App Configuration store

Test-AzAppConfigurationKeyValue -Endpoint $endpoint -Key keyName1

Test a key-value in an App Configuration store

Example 2: Test a key-value in an App Configuration store with wildcard

Test-AzAppConfigurationKeyValue -Endpoint $endpoint -Key keyName*

Test a key-value in an App Configuration store with wildcard

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

Test-AzAppConfigurationKeyValue -Endpoint $endpoint -Key keyName5

Test-AzAppConfigurationKeyValue_Check: The server responded with a Request Error, Status: NotFound

If the key-value does not exist, the cmdlet will throw an error.

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

-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

-InputObject

Identity Parameter

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

-Key

The key of the key-value to retrieve.

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

-Label

The label of the key-value to retrieve.

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

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
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

Inputs

IAppConfigurationdataIdentity

Outputs

Boolean

Share via