< Back

Get-ItGlueFlexibleAssetInstance

Wed Jan 15, 2020 9:24 am

NAME Get-ItGlueFlexibleAssetInstance



SYNOPSIS





SYNTAX

Get-ItGlueFlexibleAssetInstance -ApiKey <SecureString> -FlexibleAssetId <Object> [-UriBase <String>] [-PageSize

<Int64>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]



Get-ItGlueFlexibleAssetInstance -Credential <PSCredential> -FlexibleAssetId <Object> [-UriBase <String>]

[-PageSize <Int64>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]





DESCRIPTION

Gets all instances of a flexible asset, based on the ID.





PARAMETERS

-ApiKey <SecureString>

ITGlue API key used to send data to ITGlue.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-FlexibleAssetId <Object>

Identifier ID for the desired flexible asset type.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UriBase <String>

Base URL for the ITGlue API.



Required? false

Position? named

Default value https://api.itglue.com

Accept pipeline input? false

Accept wildcard characters? false



-PageSize <Int64>

Page size when requesting ITGlue resources via the API. Note that retrieving flexible asset instances is

computationally expensive, which may cause a timeout. When that happens, drop the page size down (a lot).



Required? false

Position? named

Default value 1000

Accept pipeline input? false

Accept wildcard characters? false



-EventLogSource <String>

When included, (and when LogPath is null), represents the event log source for the Application log. If no

event log source or path are provided, output is sent only to the host.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LogPath <String>

When included (when EventLogSource is null), represents the file, to which the cmdlet will output will be

logged. If no path or event log source are provided, output is sent only to the host.



Required? false

Position? named

Default value

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



NOTES





V1.0.0.8 date: 2 July 2019

V1.0.0.9 date: 11 July 2019

V1.0.0.10 date: 18 July 2019

V1.0.0.11 date: 25 July 2019

V1.0.0.12 date: 30 July 2019

V1.0.0.13 date: 1 August 2019

V1.0.0.14 date: 1 August 2019

V1.0.0.15 date: 6 August 2019

V1.0.0.16 date: 9 August 2019

V1.0.0.17 date: 13 August 2019

V1.0.0.18 date: 11 December 2019



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



PS C:\\>Get-ItGlueFlexibleAssetInstance -ApiKey ITG.XXXXXXXXXXXXX -FlexibleAssetId 123456 Verbose



In this example, the cmdlet will get all instances of flexible asset type 123456, using the provided ITGlue API

key. Verbose output is sent to the host.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-ItGlueFlexibleAssetInstance -FlexibleAssetId 123456 -Credential (Get-Credential) -LogPath

C:\\Temp\\log.txt



In this example, the cmdlet will get all instances of the flexible asset type 123456, using the provided ITGlue

user credentials. Output will be written to the log file and host.











RELATED LINKS

https://github.com/wetling23/Public.ItG ... hellModule