Edit

Test-AzAppConfigurationSnapshot

Requests the headers and status of the given resource.

Syntax

Check (Default)

Test-AzAppConfigurationSnapshot
    -Endpoint <String>
    [-After <String>]
    [-ClientRequestId <String>]
    [-SyncToken <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Check1

Test-AzAppConfigurationSnapshot
    -Endpoint <String>
    -Name <String>
    [-ClientRequestId <String>]
    [-SyncToken <String>]
    [-IfMatch <String>]
    [-IfNoneMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

CheckViaIdentity

Test-AzAppConfigurationSnapshot
    -Endpoint <String>
    -InputObject <IAppConfigurationdataIdentity>
    [-ClientRequestId <String>]
    [-SyncToken <String>]
    [-IfMatch <String>]
    [-IfNoneMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Description

Requests the headers and status of the given resource.

Examples

Example 1: Check if snapshots exist in an App Configuration store

Test-AzAppConfigurationSnapshot -Endpoint $endpoint -PassThru
True

Check whether any snapshots exist in the App Configuration store. Returns True if snapshots are found.

Example 2: Check if a specific snapshot exists

Test-AzAppConfigurationSnapshot -Endpoint $endpoint -Name "mySnapshot" -PassThru
True

Check whether a specific snapshot exists in the App Configuration store by name.

Parameters

-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

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

-ClientRequestId

An opaque, globally-unique, client-generated string identifier for the request.

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

-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

Check1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CheckViaIdentity
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

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

-InputObject

Identity Parameter

Parameter properties

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

Parameter sets

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

-Name

The name of the key-value snapshot to check.

Parameter properties

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

Parameter sets

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

-PassThru

Returns true when the command succeeds

Parameter properties

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

Inputs

IAppConfigurationdataIdentity

Outputs

Boolean