Set-SmaAssetAsArchived

NAME Set-SmaAssetAsArchived



SYNOPSIS







SYNTAX

Set-SmaAssetAsArchived [-AssetID] <Int32> [-Body] <Hashtable> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

Archives an existing SMA asset.





PARAMETERS

-AssetID <Int32>

The ID of the asset you want to archive.



Required? true

Position? 0

Default value 0

Accept pipeline input? False

Accept wildcard characters? false



-Body <Hashtable>

A hashtable-formatted payload containing the asset information. See example.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

PSCustomObject







NOTES









-------------------------- EXAMPLE 1 --------------------------



PS> $Body = @{

@{

archiveReason = "Testing Archival via API"

}

}



PS> Set-SmaAssetAsArchived -AssetID 1234 -Body $Body



Archives an asset with ID 1234 with the reason "Testing Archival via API"



RELATED LINKS

Online Version: https://github.com/ArtisanByteCrafter/K ... rchived.md