New-AzAppConfigurationSnapshot
Create a key-value snapshot.
Syntax
Create (Default)
New-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-Entity <ISnapshot>
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-JsonString <String>
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-JsonFilePath <String>
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateExpanded
New-AzAppConfigurationSnapshot
-Endpoint <String>
-Name <String>
-Filter <IKeyValueFilter[]>
[-SyncToken <String>]
[-CompositionType <String>]
[-RetentionPeriod <Int64>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityExpanded
New-AzAppConfigurationSnapshot
-Endpoint <String>
-InputObject <IAppConfigurationdataIdentity>
-Filter <IKeyValueFilter[]>
[-SyncToken <String>]
[-CompositionType <String>]
[-RetentionPeriod <Int64>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentity
New-AzAppConfigurationSnapshot
-Endpoint <String>
-InputObject <IAppConfigurationdataIdentity>
-Entity <ISnapshot>
[-SyncToken <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a key-value snapshot.
Examples
Example 1: Create a snapshot with a key filter
$filter = @{ Key = "app/*" }
New-AzAppConfigurationSnapshot -Endpoint $endpoint -Name "mySnapshot" -Filter $filter
Name Status CompositionType Created Expires RetentionPeriod Size ItemsCount Etag
---- ------ --------------- ------- ------- --------------- ---- ---------- ----
mySnapshot ready key 7/21/2023 02:40:00 3600 1024 5 abcdef
Create a key-value snapshot that captures all key-values matching the key filter "app/*".
Example 2: Create a snapshot with a retention period and composition type
$filter = @{ Key = "app/*"; Label = "prod" }
New-AzAppConfigurationSnapshot -Endpoint $endpoint -Name "prodSnapshot" -Filter $filter -CompositionType "key_label" -RetentionPeriod 7776000
Name Status CompositionType Created Expires RetentionPeriod Size ItemsCount Etag
---- ------ --------------- ------- ------- --------------- ---- ---------- ----
prodSnapshot ready key_label 7/21/2023 02:40:00 10/19/2023 02:40:00 7776000 2048 10 ghijkl
Create a snapshot with key_label composition type and a 90-day retention period, filtering by both key and label.
Parameters
-AsJob
Run the command as a job
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
-CompositionType
The composition type describes how the key-values within the snapshot are composed.
The 'key' composition type ensures there are no two key-values containing the same key.
The 'key_label' composition type ensures there are no two key-values containing the same key and label.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityExpanded
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
A snapshot is a named, immutable subset of an App Configuration store's key-values.
Parameter properties
Type: ISnapshot
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Create
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Filter
A list of filters used to filter the key-values included in the snapshot.
Parameter properties
Type: IKeyValueFilter [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
CreateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentity
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 Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonFilePath
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 Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonString
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 create.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Create
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
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
-RetentionPeriod
The amount of time, in seconds, that a snapshot will remain in the archived state before expiring.
This property is only writable during the creation of a snapshot.
If not specified, the default lifetime of key-value revisions will be used.
Parameter properties
Type: Int64
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityExpanded
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
-Tag
The tags of the snapshot.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityExpanded
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
