Remove-AzFleetUpdateRun

Reference

Module:: Az.Fleet

Delete a UpdateRun

Syntax

Remove-AzFleetUpdateRun
      -FleetName <String>
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-IfMatch <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzFleetUpdateRun
      -Name <String>
      -FleetInputObject <IFleetIdentity>
      [-IfMatch <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzFleetUpdateRun
      -InputObject <IFleetIdentity>
      [-IfMatch <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Delete a UpdateRun

Examples

Example 1: Delete a fleet update run

Remove-AzFleetUpdateRun -FleetName testfleet01 -Name run2 -ResourceGroupName K8sFleet-Test

This command delete specified fleet update run.

Parameters

-AsJob

Run the command as a job

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

-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

-FleetInputObject

Identity Parameter

Type:	IFleetIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-FleetName

The name of the Fleet resource.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-IfMatch

The request should only proceed if an entity matches this string.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter

Type:	IFleetIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the UpdateRun resource.

Type:	String
Aliases:	UpdateRunName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

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

-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

IFleetIdentity

Outputs

Boolean

Share via