Edit

Remove-AzAksSnapshot

  • Reference
Module:
Az.Aks

Deletes a snapshot.

Syntax

Remove-AzAksSnapshot
      -ResourceGroupName <String>
      -ResourceName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzAksSnapshot
      -InputObject <IAksIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Deletes a snapshot.

Examples

Example 1: Remove an AKS snapshot

Remove-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1'

Example 2: Remove an AKS snapshot via identity

$Snapshot = Get-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1'
$Snapshot | Remove-AzAksSnapshot

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IAksIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IAksIdentity>: Identity Parameter

  • [AgentPoolName <String>]: The name of the agent pool.
  • [CommandId <String>]: Id of the command.
  • [ConfigName <String>]: The name of the maintenance configuration.
  • [Id <String>]: Resource identity path
  • [Location <String>]: The name of Azure region.
  • [PrivateEndpointConnectionName <String>]: The name of the private endpoint connection.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [ResourceName <String>]: The name of the managed cluster resource.
  • [RoleName <String>]: The name of the role for managed cluster accessProfile resource.
  • [SubscriptionId <String>]: The ID of the target subscription.