Update-AzAppConfigurationSnapshot
Update the state of a key-value snapshot.
Syntax
UpdateExpanded (Default)
Update-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SyncToken <String>]
[-Status <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-JsonString <String>
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-JsonFilePath <String>
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update
Update-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-Entity <ISnapshotUpdateParameters>
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzAppConfigurationSnapshot
-Endpoint <String>
-InputObject <IAppConfigurationdataIdentity>
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SyncToken <String>]
[-Status <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentity
Update-AzAppConfigurationSnapshot
-Endpoint <String>
-InputObject <IAppConfigurationdataIdentity>
-Entity <ISnapshotUpdateParameters>
[-ClientRequestId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the state of a key-value snapshot.
Examples
Example 1: Archive a snapshot
Update-AzAppConfigurationSnapshot -Endpoint $endpoint -Name "mySnapshot" -Status "archived"
Name Status CompositionType Created Expires RetentionPeriod Size ItemsCount Etag
---- ------ --------------- ------- ------- --------------- ---- ---------- ----
mySnapshot archived key 7/21/2023 02:40:00 3600 1024 5 abcdef
Archive a snapshot by updating its status to "archived".
Example 2: Recover an archived snapshot
Update-AzAppConfigurationSnapshot -Endpoint $endpoint -Name "mySnapshot" -Status "ready"
Name Status CompositionType Created Expires RetentionPeriod Size ItemsCount Etag
---- ------ --------------- ------- ------- --------------- ---- ---------- ----
mySnapshot ready key 7/21/2023 02:40:00 3600 1024 5 abcdef
Recover an archived snapshot by updating its status back to "ready".
Parameters
-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
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
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
-Entity
Parameters used to update a snapshot.
Parameter properties
Parameter sets
Update
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentity
Position: Named Mandatory: True Value from pipeline: True 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
(All)
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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Update operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the key-value snapshot to update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Update
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Status
The desired status of the snapshot.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
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
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
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
