Get-AzAksSnapshot
Gets a snapshot.
Syntax
Get-AzAksSnapshot
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzAksSnapshot
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzAksSnapshot
-ResourceGroupName <String>
-ResourceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzAksSnapshot
-InputObject <IAksIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets a snapshot.
Examples
Example 1: List all AKS snapshots
Get-AzAksSnapshot
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType
-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ----------------------------
eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User
eastus snapshot2 3/30/2023 10:09:38 AM user1@microsoft.com User 3/30/2023 10:09:38 AM user1@microsoft.com User
eastus snapshot3 3/30/2023 10:11:24 AM user1@microsoft.com User 3/30/2023 10:11:24 AM user1@microsoft.com User
Example 2: List all AKS snapshots in a resource group
Get-AzAksSnapshot -ResourceGroupName mygroup
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType
-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ----------------------------
eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User
eastus snapshot2 3/30/2023 10:09:38 AM user1@microsoft.com User 3/30/2023 10:09:38 AM user1@microsoft.com User
Example 3: Get an AKS snapshot
Get-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1'
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType
-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ----------------------------
eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User
Example 4: Get an AKS snapshot via identity
$pool = Get-AzAksNodePool -ResourceGroupName mygroup -ClusterName mycluster -Name default
$Snapshot = New-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1' -Location eastus -SnapshotType 'NodePool' -CreationDataSourceResourceId $pool.Id
$Snapshot | Get-AzAksSnapshot
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType
-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ----------------------------
eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User
Parameters
-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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IAksIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceName
The name of the managed cluster resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
Type: | String[] |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |