Get-VPASUsagePlatformDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET USAGE PLATFORM DETAILS


Description:

USE THIS FUNCTION TO GET USAGE PLATFORM DETAILS


Syntax:

Get-VPASUsagePlatformDetails [-usageplatformID] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-usageplatformID <String>
Unique UsagePlatformID to retrieve details for

Required: true
Position: 1
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: 2
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:

$UsagePlatformDetailsJSON = Get-VPASUsagePlatformDetails -usageplatformID {USAGE PLATFORMID VALUE}


Outputs:

If successful:
{
         "NumberOfLinkedTargetPlatforms": 1,
         "CredentialsManagementPolicy": {
                 "Change": {
                         "AllowManual": true
                 }
         },
         "ID": 8,
         "PlatformID": "INIFile",
         "Name": "INI File",
         "PlatformBaseType": "INIFile",
         "PlatformBaseID": "INIFile"
}

$false if failed