AzureScout

2.10.0

manifests/collectors/Monitor/MonitorMetricsIngestion.psd1

#
# GENERATED by scripts/ConvertTo-ScoutCollectorDefinition.ps1 from Modules/Public/InventoryModules/Monitor/MonitorMetricsIngestion.ps1 (AB#5660).
# Field expressions are copied verbatim from the original collector and evaluate in an
# equivalent scope -- see docs/design/decisions/declarative-collectors.md.
# Review before trusting; regenerate rather than hand-patch if the source collector changes.
#
@{
    ResourceTypes = @(
        'microsoft.operationalinsights/workspaces'
    )

    ResourceTypeMatching = 'Grouped'

    AdditionalFilter = $null

    FilterPreamble = ''

    RowLoopVariable = '1'

    Preamble = @'
$ResUCount = 1
            # An EMPTY $sub1 is not $null -- the match is empty for any resource whose subscription
            # is outside the requested scope -- and reading .Name off an empty collection throws
            # under StrictMode (AB#5671). Resolved once here, as VirtualMachine.ps1 already does.
            $sub1 = $SUB | Where-Object { $_.Id -eq $1.subscriptionId }
            # The else arm is $null, NOT '': with StrictMode off $sub1.Name on an unmatched ($null)
            # $sub1 evaluated to $null, and the ~110 collectors that still read $sub1.Name directly
            # emit $null here. '' was a silent behaviour change -- the declarative equivalence proof
            # caught it on 11 collectors, and it would have been invisible on the rest (AB#5659).
            $SubscriptionName = if ($sub1) { @($sub1)[0].Name } else { $null }
            $data = $1.PROPERTIES
            # AB#5671: an untagged resource's Resource Graph row OMITS the tags property rather
            # than carrying an empty object, so the raw read throws under StrictMode -- and so
            # does psobject.properties on a $null. The historic '0' sentinel existed only to make
            # the tag loop below run ONCE for an untagged resource, but '0'.Name throws too; an
            # empty tag object runs it once AND emits the identical [string]-cast empty Name/Value.
            $RowTags = Get-AZSCSafeProperty -InputObject $1 -Path 'tags'
            $TagProps = if ($null -ne $RowTags) { $RowTags.psobject.properties } else { $null }
            $Tags = if (![string]::IsNullOrEmpty($TagProps)) { $TagProps } else { [pscustomobject]@{ Name = $null; Value = $null } }
 
            # SKU details
            $skuName = if ((Get-AZSCSafeProperty -InputObject $data -Path 'sku.name' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path 'sku.name' -Enumerate) } else { 'N/A' }
            $capResLevel = if ((Get-AZSCSafeProperty -InputObject $data -Path 'sku.capacityReservationLevel' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path 'sku.capacityReservationLevel' -Enumerate) } else { 'N/A' }
 
            # Retention
            $retentionDays = if ((Get-AZSCSafeProperty -InputObject $data -Path 'retentionInDays' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path 'retentionInDays' -Enumerate) } else { 'N/A' }
 
            # Daily cap
            $dailyQuotaGb = if ((Get-AZSCSafeProperty -InputObject $data -Path 'workspaceCapping.dailyQuotaGb' -Enumerate) -and (Get-AZSCSafeProperty -InputObject $data -Path 'workspaceCapping.dailyQuotaGb' -Enumerate) -ne -1) {
                                  (Get-AZSCSafeProperty -InputObject $data -Path 'workspaceCapping.dailyQuotaGb' -Enumerate)
                               } else { 'Unlimited' }
            $dataIngestionStatus = if ((Get-AZSCSafeProperty -InputObject $data -Path 'workspaceCapping.dataIngestionStatus' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path 'workspaceCapping.dataIngestionStatus' -Enumerate) } else { 'N/A' }
 
            # Customer-managed key
            $cmkEnabled = if ((Get-AZSCSafeProperty -InputObject $data -Path 'features.enableDataExport' -Enumerate) -eq $true) { 'Yes' } else { 'No' }
 
            # Public network access
            $publicIngestion = if ((Get-AZSCSafeProperty -InputObject $data -Path 'publicNetworkAccessForIngestion' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path 'publicNetworkAccessForIngestion' -Enumerate) } else { 'N/A' }
            $publicQuery = if ((Get-AZSCSafeProperty -InputObject $data -Path 'publicNetworkAccessForQuery' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path 'publicNetworkAccessForQuery' -Enumerate) } else { 'N/A' }
'@

    AdditionalRowLoops = @()

    TagLoop = @{
        Variable = 'Tag'
        Source = '$Tags'
        Preamble = ''
    }

    Fields = @(
        @{
            Name = 'ID'
            Expression = '$1.id'
        }
        @{
            Name = 'Subscription'
            Expression = '$SubscriptionName'
        }
        @{
            Name = 'Resource Group'
            Expression = '$1.RESOURCEGROUP'
        }
        @{
            Name = 'Workspace Name'
            Expression = '$1.NAME'
        }
        @{
            Name = 'Location'
            Expression = '$1.LOCATION'
        }
        @{
            Name = 'SKU'
            Expression = '$skuName'
        }
        @{
            Name = 'Capacity Reservation (GB/d)'
            Expression = '$capResLevel'
        }
        @{
            Name = 'Retention (days)'
            Expression = '$retentionDays'
        }
        @{
            Name = 'Daily Cap (GB)'
            Expression = '$dailyQuotaGb'
        }
        @{
            Name = 'Daily Cap Status'
            Expression = '$dataIngestionStatus'
        }
        @{
            Name = 'Public Ingestion'
            Expression = '$publicIngestion'
        }
        @{
            Name = 'Public Query'
            Expression = '$publicQuery'
        }
        @{
            Name = 'Provisioning State'
            Expression = 'if ((Get-AZSCSafeProperty -InputObject $data -Path ''provisioningState'' -Enumerate)) { (Get-AZSCSafeProperty -InputObject $data -Path ''provisioningState'' -Enumerate) } else { ''N/A'' }'
        }
        @{
            Name = 'Resource U'
            Expression = '$ResUCount'
        }
        @{
            Name = 'Tag Name'
            Expression = '[string]$Tag.Name'
        }
        @{
            Name = 'Tag Value'
            Expression = '[string]$Tag.Value'
        }
    )

    Export = @{
        WorksheetName = 'Monitor Metrics Ingestion'
        TableNamePrefix = 'MonitorMetricsIngTable_'
        Columns = @(
            'Subscription'
            'Resource Group'
            'Workspace Name'
            'Location'
            'SKU'
            'Capacity Reservation (GB/d)'
            'Retention (days)'
            'Daily Cap (GB)'
            'Daily Cap Status'
            'Public Ingestion'
            'Public Query'
            'Provisioning State'
            'Resource U'
        )
        TagColumns = @()
        TagColumnsBefore = $null
        NumberFormat = '0'
        ConditionalText = @(
            'New-ConditionalText -ConditionalType ContainsText ''Unlimited'' -ConditionalTextColor ([System.Drawing.Color]::FromArgb(0,176,240)) -BackgroundColor ([System.Drawing.Color]::White)'
            'New-ConditionalText -ConditionalType ContainsText ''CapReached'' -ConditionalTextColor ([System.Drawing.Color]::White) -BackgroundColor ([System.Drawing.Color]::FromArgb(255,0,0))'
            'New-ConditionalText -ConditionalType ContainsText ''PerNodeNotAllowed'' -ConditionalTextColor ([System.Drawing.Color]::White) -BackgroundColor ([System.Drawing.Color]::FromArgb(255,165,0))'
        )
    }

    SourceCollector = 'Modules/Public/InventoryModules/Monitor/MonitorMetricsIngestion.ps1'
}