Copy-VPASUsagePlatform


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

DUPICATE USAGE PLATFORM


Description:

USE THIS FUNCTION TO DUPLICATE A USAGE PLATFORM


Syntax:

Copy-VPASUsagePlatform -DuplicateFromUsagePlatformID <String> -NewUsagePlatformID <String> [-Description <String>] [-token <Hashtable>] [<CommonParameters>]

Copy-VPASUsagePlatform -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-DuplicateFromUsagePlatformID <String>
Specify which UsagePlatformID will be the base of the new platform

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-NewUsagePlatformID <String>
New unique UsagePlatformID for the new platform

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Description <String>
An explanation/details of the target resource
Best practice states to leave informative descriptions to help identify the resource purpose

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
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)


Examples:

$NewUsagePlatformIDJSON = Copy-VPASUsagePlatform -DuplicateFromUsagePlatformID {DUPLICATE FROM USAGE PLATFORMID VALUE} -NewUsagePlatformID {NEW USAGE PLATFORMID VALUE} -Description {DESCRIPTION VALUE}

$InputParameters = @{
        DuplicateFromUsagePlatformID = "ExistingUsagePlatformID"
         NewUsagePlatformID = "NewUsagePlatformID"
         Description = "Description for new platform here"
}
$NewUsagePlatformIDJSON = Copy-VPASUsagePlatform -InputParameters $InputParameters


Outputs:

If successful:
{
         "ID": 14,
         "PlatformID": "NewUsagePlatform",
         "Name": "NewUsagePlatform",
         "Description": "New usage platform for documentation"
}

$false if failed