Get-AzAppConfigurationSnapshot
Gets a single key-value snapshot or lists key-value snapshots.
Syntax
List (Default)
Get-AzAppConfigurationSnapshot
-Endpoint <String>
[-Name <String>]
[-After <String>]
[-Status <System.Collections.Generic.List`1[System.String]>]
[-Select <System.Collections.Generic.List`1[System.String]>]
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzAppConfigurationSnapshot
-Endpoint <String>
[-Name <String>]
[-Select <System.Collections.Generic.List`1[System.String]>]
[-SyncToken <String>]
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets a single key-value snapshot by name, or lists key-value snapshots with optional filtering.
Examples
Example 1: List all snapshots in an App Configuration store
Get-AzAppConfigurationSnapshot -Endpoint $endpoint
Name Status CompositionType Created Expires RetentionPeriod Size ItemsCount Etag
---- ------ --------------- ------- ------- --------------- ---- ---------- ----
mySnapshot ready key 7/21/2023 02:40:00 3600 1024 5 abcdef
List all key-value snapshots in an App Configuration store.
Example 2: Get a specific snapshot by name
Get-AzAppConfigurationSnapshot -Endpoint $endpoint -Name "mySnapshot"
Name Status CompositionType Created Expires RetentionPeriod Size ItemsCount Etag
---- ------ --------------- ------- ------- --------------- ---- ---------- ----
mySnapshot ready key 7/21/2023 02:40:00 3600 1024 5 abcdef
Get a single key-value snapshot by name from an App Configuration store.
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
List
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
Get
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
-Name
The name of the snapshot.
When used with the Get parameter set, retrieves a single snapshot by exact name.
When used with the List parameter set, filters the returned snapshots by name.
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
-Status
Used to filter returned snapshots by their status property.
Parameter properties
Type: List<T> [ 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
-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
