M365SLIC.LicenseMon.Serial.PA

M365SLIC.LicenseMon.Serial.PA (ProbeActionModuleType)

Designed to leverage a Posh script PA for retrieving License SKU properties/metrics.

Element properties:

TypeProbeActionModuleType
IsolationAny
AccessibilityInternal
RunAsM365SL.RunAs.Profile
InputTypeSystem.BaseData
OutputTypeMicrosoft.Windows.SerializedObjectData

Member Modules:

ID Module Type TypeId RunAs 
POSH ProbeAction Microsoft.Windows.PowerShellProbe Default

Overrideable Parameters:

IDParameterTypeSelector
CD_SkuPartNumberRegExstring$Config/CD_SkuPartNumberRegEx$
EventIDFilterstring$Config/EventIDFilter$
PoshLibraryPathstring$Config/PoshLibraryPath$
ProbeActionTimeoutSecondsint$Config/ProbeActionTimeoutSeconds$
WorkflowNamestring$Config/WorkflowName$
WriteToEventLogbool$Config/WriteToEventLog$

Source Code:

<ProbeActionModuleType ID="M365SLIC.LicenseMon.Serial.PA" Accessibility="Internal" Batching="false" PassThrough="false" RunAs="M365SL!M365SL.RunAs.Profile">
<Configuration>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="0" name="CD_SkuPartNumberRegEx" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="ApiTokenScopeURL" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="ApiTokenURL" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="ApiURL" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="M365_AccountName" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="M365_AccountPassword" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="M365_ClientID" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="M365_ClientSecret" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="EventIDFilter" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="PoshLibraryPath" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="ProbeActionTimeoutSeconds" type="xsd:integer"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="TenantName" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="TLSVersion" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="WorkflowName" type="xsd:string"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="WriteToEventLog" type="xsd:boolean"/>
</Configuration>
<OverrideableParameters>
<OverrideableParameter ID="CD_SkuPartNumberRegEx" Selector="$Config/CD_SkuPartNumberRegEx$" ParameterType="string"/>
<OverrideableParameter ID="EventIDFilter" Selector="$Config/EventIDFilter$" ParameterType="string"/>
<OverrideableParameter ID="PoshLibraryPath" Selector="$Config/PoshLibraryPath$" ParameterType="string"/>
<OverrideableParameter ID="ProbeActionTimeoutSeconds" Selector="$Config/ProbeActionTimeoutSeconds$" ParameterType="int"/>
<OverrideableParameter ID="WorkflowName" Selector="$Config/WorkflowName$" ParameterType="string"/>
<OverrideableParameter ID="WriteToEventLog" Selector="$Config/WriteToEventLog$" ParameterType="bool"/>
</OverrideableParameters>
<ModuleImplementation Isolation="Any">
<Composite>
<MemberModules>
<ProbeAction ID="POSH" TypeID="Windows!Microsoft.Windows.PowerShellProbe">
<ScriptName>M365SLIC.LicenseMon.ps1</ScriptName>
<ScriptBody><Script>&lt;#
#===============================================================================================================================================================
Created by: Brian Zoucha, Tyson Paul
Filename: M365SLIC.LicenseMon.ps1
Description: This will retrieve a few properties from the license object to be used for monitoring workflows.

Version History:
2020.11.17.2338 - Added API Url params
2020.10.23.1408 - updated reference to Service-StatusBag
2020.10.06.1550 - Added CD_SkuPartNumberRegEx
2020.10.02.1141 - Added Service-FailureBag function. Added logging.
2020.09.29.1445 - Modified to produce monitor type-specific PBs for each instance so that PB data is specific to the mon that will use it. (will provide more streamlined State Change tab details in HealthExplorer)
2020.09.28.1444 - Moved TLS function call higher before access token retrieval
2020.09.17.0912 - Polishing.
2020.09.16.1150 - Tyson, revised for MP. Made one universal script to accommodate any mailflow direction.

Requirements: Must have an Azure application registered and have the following:
Delegated permissions, Sites.Read.All
ClientID &amp; Application Secret
===============================================================================================================================================================
#&gt;

Param(
[string]$CD_SkuPartNumberRegEx,
[string]$ApiTokenScopeURL,
[string]$ApiTokenURL,
[string]$ApiURL,
[string]$M365_AccountName,
[string]$M365_AccountPassword,

# Azure Application auth
[string]$M365_ClientID,
[string]$M365_ClientSecret,

# Comma-separated list of event IDs, script will only write to log for these EventIDs. This is a way to only write specific events. Only valid if $WriteToEventLog parameter is 'true'.
[string]$EventIDFilter,

# Comma-separated list of .ps1 files to load
[string]$PoshLibraryPath,


# This is a clever way to utilize the exact same script for both rule/mon and agent tasks.
[Parameter(Mandatory=$false,
ValueFromPipeline=$false,
ValueFromPipelineByPropertyName=$false,
ValueFromRemainingArguments=$false)]
[ValidateSet('PropertyBag', 'Serialized')]
[string]$ScriptOutputType = 'PropertyBag',

# Azure tenant
[string]$TenantName,

[string]$TLSVersion,

# Typically this is the name of the workflow calling this script. Should be set to the name of the probe/WA if being used by both rules/mons so as not to break cookdown.
# Keep in mind that datasource params need to be identical for cookdown to work.
[string]$WorkflowName,

# type:string. SCOM bool params are different than Posh bool. Will get converted to Posh bool below.
[string]$WriteToEventLog = 'false'
)

# Set defaults for event filters. Apparently setting this in the Params declaration did not work.
If (-NOT $EventIDFilter) {
$EventIDFilter = "9990,9991,9992,9995,9996,9997,9998,9999"
}

$ScriptName = 'M365SLIC.LicenseMon.ps1'
[bool]$WriteToEventLog = [System.Convert]::ToBoolean($WriteToEventLog)
$Testing = $false
$NameSpace = "License"
######################### FUNCTIONS ############################
################################################################
Function Load-Library {
Param (
[string]$PoshLibraryPath
)
$ErrorActionPreference = 'STOP'
If ($PoshLibraryPath ){
ForEach ($Path in $PoshLibraryPath.Split(',') ){
Try {
If (($Path.Length) -AND ($Path -notmatch '^-1$')) {
. $Path
}
} Catch {
Write-Host "Line [$($MyInvocation.ScriptLineNumber )]: Error loading PoshLibrary at path:[$($Path)]. This is likely to cause many other dependent functions to fail. `n`nError data: $($_)`n`n"
}
}
}
$ErrorActionPreference = 'CONTINUE'
}
################################################################

############## TESTING ##############
&lt;# #Run this as needed when testing

Function Testing {
$Testing = $true
Get-Item Alias:\_LINE_ -ErrorAction Ignore | Remove-Item -ErrorAction Ignore
$testParamsFile = (Join-path $TestFolder ("PARAMS_$($ScriptName)"))
#Write-Host "$(Test-Path $testParamsFile):$($testParamsFile)" -F Yellow -B Green
. $testParamsFile
. Load-Library -PoshLibraryPath $PoshLibraryPath

# Encode user data/passwords in current test user context
$M365_ClientSecret = Encode-UserData $M365_ClientSecret_PLAINTEXT
$M365_AccountPassword = Encode-UserData $M365_AccountPassword_PLAINTEXT
$error.Clear()
}

$TestFolder = 'C:\Test\M365SMP_Dev\$($NameSpace)\TestSetup'
If (Test-Path -Path $TestFolder) {
. Testing
}

#&gt;
############## TESTING ##############


. Load-Library -PoshLibraryPath $PoshLibraryPath
LogIt -EventID 9990 -Type $info -Msg "Begin script..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()

LogIt -EventID 9992 -Type $info -msg "Setting TLS for session, Version: [$($TLSVersion)]." -Proceed $WriteToEventLog -Line $(_LINE_); $Error.Clear();
#Set Default TLS
. Set-TLS -TLSVersion $TLSVersion


# Decode Account Password
LogIt -EventID 9992 -Type $info -Msg "Decode password..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
Try {
$M365_AccountPassword_DECRYPTED = Decode-UserData -Data $M365_AccountPassword
} Catch {
LogIt -EventID 9995 -Type $warn -Msg "Unable to decode password. See error data. Exiting." -Proceed $true -LINE $(_LINE_); $Error.Clear()
Exit
}

# Decode Client Secret
LogIt -EventID 9992 -Type $info -Msg "Decode password and get Access Token..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
Try {
$M365_ClientSecret_DECRYPTED = Decode-UserData -Data $M365_ClientSecret
} Catch {
LogIt -EventID 9995 -Type $warn -Msg "Unable to decode password and get Access Token. See error data. Exiting." -Proceed $true -LINE $(_LINE_); $Error.Clear()
Exit
}

# Get Access Token
$TokenResponse = Get-AccessToken -Delegated -User $M365_AccountName -Pass $M365_AccountPassword_DECRYPTED -ClientID $M365_ClientID -ClientSecret $M365_ClientSecret_DECRYPTED -TenantName $TenantName -ApiTokenUrl $ApiTokenURL -ApiTokenScopeURL $ApiTokenScopeURL
Try {
} Catch {
$Message = "Unable to retrieve Access Token. See error data. Will output connectivity failure bag data. Exiting."
LogIt -EventID 9997 -Type $warn -Msg $Message -Proceed $true -LINE $(_LINE_); $Error.Clear()
# Output service bag
Service-FailureBag -Message $Message
Exit
}

# Retrieve License object(s)
LogIt -EventID 9992 -Type $info -Msg "Retrieve $($NameSpace) object(s)" -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
Try {
$LicenseUrl = "$($ApiURL)/v1.0/subscribedSkus"
$Licenses = Invoke-RestMethod -Headers @{Authorization = "Bearer $($TokenResponse.access_token)"} -Uri $LicenseUrl -Method Get -ContentType 'application/json' -ErrorAction Stop

$Msg =@"
Retrieved License object(s):
$($Licenses.Value.skuPartNumber | Out-String)
"@
LogIt -EventID 9992 -Type $info -Msg $Msg -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
} Catch {
$Message = "Unable to get $($NameSpace) object(s) from Graph URL: [$($LicenseUrl)]. See error data. Will output connectivity failure bag data. Exiting."
LogIt -EventID 9995 -Type $warn -Msg $Message -Proceed $true -LINE $(_LINE_); $Error.Clear()
# Output service bag
Service-StatusBag -Message $Message -Status FAILURE
Exit
}


#$Skus = $Licenses.Value
# If regex is provided (used for Serial output task PA). Otherwise all objects will match an empty comparison.
$Skus = $Licenses.Value | Where-Object {$_.skuPartNumber -match $CD_SkuPartNumberRegEx }


#----------------------------------------
# Build bag for LicensesConsumed
LogIt -EventID 9992 -Type $info -Msg "Proceed to build bags for bag category: [LicensesConsumed]..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
ForEach ($SkuPN in $Skus) {
LogIt -EventID 9992 -Type $info -Msg "Build (LicensesConsumed) bag for SKU [$($SkuPN.skuPartNumber)]..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
$Units = [math]::Max(( $SkuPN.PrepaidUnits.Enabled - $SkuPN.ConsumedUnits),0)
[double]$Percent = 0

# Set up BasicBag with defaults
$bag = New-Object -TypeName BasicBag
$bag.AddValue('Category',"LicensesConsumed")
$bag.AddValue('Message',"")
$bag.AddValue('LicensesConsumedPercent',[double]$Percent)
$bag.AddValue('LicensesAvailablePercent',[double]$Percent)
$bag.AddValue('LicensesAvailableUnits', [double]$Units)
$bag.AddValue('PrepaidUnitsEnabled', [double]($SkuPN.PrepaidUnits.Enabled))
$bag.AddValue('PrepaidUnitsSuspended', [double]($SkuPN.PrepaidUnits.Suspended))
$bag.AddValue('PrepaidUnitsWarning', [double]($SkuPN.PrepaidUnits.Warning))
$bag.AddValue('PrepaidUnitsConsumed', [double]($SkuPN.ConsumedUnits))
$bag.AddValue('SkuPartNumber',"$($SkuPN.skuPartNumber)")
$bag.AddValue('CapabilityStatus',"$($SkuPN.capabilityStatus)")
$bag.AddValue('ThisScriptInstanceGUID',"$ThisScriptInstanceGUID")
$bag.AddValue('Whoami',"$whoami")
$bag.AddValue('M365_ClientID',"$M365_ClientID")
$bag.AddValue('M365_AccountName',"$M365_AccountName")
$bag.AddValue('TenantName',"$TenantName")

Try {
[double]$ConsumpedPercent = "{0:N2}" -f (( [int]$SkuPN.ConsumedUnits) / (([int]$SkuPN.PrepaidUnits.Enabled)) * 100 )
$bag.LicensesAvailablePercent = (100 - $ConsumpedPercent)
$bag.LicensesConsumedPercent = $ConsumpedPercent
$bag.Message = "License statistics calculated successfully."
} Catch {
If ($SkuPN.PrepaidUnits.suspended -gt 0) {
$tmp1 = "LicensesSuspended: [$($SkuPN.PrepaidUnits.suspended)]. "
}

$Msg = "$($tmp1)Error calculating available licenses. $($_.Exception.InnerException)"
$bag.Message += $Msg
LogIt -EventID 9996 -Type $warn -Msg $Msg -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
}
OutPut $bag -Tag "skuPartNumber:$($SkuPN.skuPartNumber)"
}

Remove-Variable -Name bag -ErrorAction Ignore

#----------------------------------------
#Build bag for CapabilityStatus
LogIt -EventID 9992 -Type $info -Msg "Proceed to build bags for bag category: [CapabilityStatus]..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
ForEach ($SkuPN in $Skus) {
LogIt -EventID 9992 -Type $info -Msg "Build (CapabilityStatus) bag for SKU [$($SkuPN.skuPartNumber)]..." -Proceed $WriteToEventLog -LINE $(_LINE_); $Error.Clear()
# Set up BasicBag with defaults
$bag = New-Object -TypeName BasicBag
$bag.AddValue('Category',"CapabilityStatus")
$bag.AddValue('Message',"Status collected successfully.")
$bag.AddValue('SkuPartNumber',"$($SkuPN.skuPartNumber)")
$bag.AddValue('CapabilityStatus',"$($SkuPN.capabilityStatus)")
$bag.AddValue('ThisScriptInstanceGUID',"$ThisScriptInstanceGUID")
$bag.AddValue('Whoami',"$whoami")
$bag.AddValue('M365_ClientID',"$M365_ClientID")
$bag.AddValue('M365_AccountName',"$M365_AccountName")
$bag.AddValue('TenantName',"$TenantName")

OutPut $bag -Tag "skuPartNumber:$($SkuPN.skuPartNumber)"
}

#----------------------------------------

LogIt -EventID 9991 -Type $info -Proceed $WriteToEventLog -msg "Script Finished in [$($ScriptTimer.Elapsed.TotalSeconds)] seconds. `n" -LINE $(_LINE_)
</Script></ScriptBody>
<Parameters>
<Parameter>
<Name>CD_SkuPartNumberRegEx</Name>
<Value>$Config/CD_SkuPartNumberRegEx$</Value>
</Parameter>
<Parameter>
<Name>ApiTokenScopeURL</Name>
<Value>$Config/ApiTokenScopeURL$</Value>
</Parameter>
<Parameter>
<Name>ApiTokenURL</Name>
<Value>$Config/ApiTokenURL$</Value>
</Parameter>
<Parameter>
<Name>ApiURL</Name>
<Value>$Config/ApiURL$</Value>
</Parameter>
<Parameter>
<Name>M365_AccountName</Name>
<Value>$Config/M365_AccountName$</Value>
</Parameter>
<Parameter>
<Name>M365_AccountPassword</Name>
<Value>$Config/M365_AccountPassword$</Value>
</Parameter>
<Parameter>
<Name>M365_ClientID</Name>
<Value>$Config/M365_ClientID$</Value>
</Parameter>
<Parameter>
<Name>M365_ClientSecret</Name>
<Value>$Config/M365_ClientSecret$</Value>
</Parameter>
<Parameter>
<Name>EventIDFilter</Name>
<Value>$Config/EventIDFilter$</Value>
</Parameter>
<Parameter>
<Name>PoshLibraryPath</Name>
<Value>$FileResource[Name='Res.M365SLIC.M365Library.ps1.Resource']/Path$,$Config/PoshLibraryPath$</Value>
</Parameter>
<Parameter>
<Name>ScriptOutputType</Name>
<Value>Serialized</Value>
</Parameter>
<Parameter>
<Name>TenantName</Name>
<Value>$Config/TenantName$</Value>
</Parameter>
<Parameter>
<Name>TLSVersion</Name>
<Value>$Config/TLSVersion$</Value>
</Parameter>
<Parameter>
<Name>WorkflowName</Name>
<Value>M365SLIC.LicenseMon.Serial.PA_($Config/WorkflowName$)</Value>
</Parameter>
<Parameter>
<Name>WriteToEventLog</Name>
<Value>$Config/WriteToEventLog$</Value>
</Parameter>
</Parameters>
<TimeoutSeconds>$Config/ProbeActionTimeoutSeconds$</TimeoutSeconds>
</ProbeAction>
</MemberModules>
<Composition>
<Node ID="POSH"/>
</Composition>
</Composite>
</ModuleImplementation>
<!--<OutputType>System!System.PropertyBagData</OutputType>-->
<OutputType>Windows!Microsoft.Windows.SerializedObjectData</OutputType>
<InputType>System!System.BaseData</InputType>
</ProbeActionModuleType>