ps/Modules/Alkami.DevOps.Inventory/Public/New-PlatformElementDetailPSObject.ps1

55 lines
1.6 KiB
PowerShell
Raw Permalink Normal View History

2023-05-30 22:51:22 -07:00
function New-PlatformElementDetailPSObject {
<#
.SYNOPSIS
Convenience function to create and return a PSOBject required by the BoRG REST API for PlatformElementDetails updates
.EXAMPLE
$detailObj = New-PlatformElementDetailPSObject `
-EnvironmentTypeName "AWS Sandbox 0.2" `
-PlatformVersionName "R2019.07.1.731" `
-ElementTierName "Web" `
-ElementName "Alkami.Ops.Common" `
-ElementVersionName "3.0.3"
.PARAMETER EnvironmentTypeName
The Environment label
.PARAMETER PlatformVersionName
The Platform version value
.PARAMETER ElementTierName
The label of the tier (Web, App, Fab, Mic, etc.)
.PARAMETER ElementName
The name of the actual element
.PARAMETER ElementVersion
The version of the actual element
#>
[CmdletBinding()]
Param(
[Parameter(Mandatory = $true)]
[string]$EnvironmentTypeName,
[Parameter(Mandatory = $false)]
[string]$PlatformVersionName,
[Parameter(Mandatory = $false)]
[string]$ElementTierName,
[Parameter(Mandatory = $true)]
[string]$ElementName,
[Parameter(Mandatory = $false)]
[string]$ElementVersionName
)
return New-Object PSObject -Property @{
"EnvironmentTypeName" = $EnvironmentTypeName
"PlatformVersionName" = $PlatformVersionName
"ElementName" = $ElementName
"ElementTierName" = $ElementTierName
"ElementVersionName" = $ElementVersionName
"DoNotCopy" = $false
}
}