Unregister-AzStorageMoverAgent

Reference

Module:: Az.StorageMover

Deletes an agent resource.

Syntax

Unregister-AzStorageMoverAgent
          -Name <String>
          -ResourceGroupName <String>
          -StorageMoverName <String>
          [-SubscriptionId <String>]
          [-DefaultProfile <PSObject>]
          [-Force]
          [-AsJob]
          [-NoWait]
          [-PassThru]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Unregister-AzStorageMoverAgent
          -InputObject <IStorageMoverIdentity>
          [-DefaultProfile <PSObject>]
          [-Force]
          [-AsJob]
          [-NoWait]
          [-PassThru]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

Deletes an agent resource.

Examples

Example 1: Unregister an agent

Unregister-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent

This command unresgisters an agent under a Storage mover.

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 credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

-Name

The name of the agent resource.

Type:	String
Aliases:	AgentName
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

-StorageMoverName

The name of the Storage Mover 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

IStorageMoverIdentity

Outputs

Boolean

Share via