AzureDevOpsDscNative

1.0.0-preview5

en-US/about_AzDoAuditStream.help.txt

.NAME
    AzDoAuditStream
 
.SYNOPSIS
    DSC resource for managing Azure DevOps audit log streaming.
 
.DESCRIPTION
 
 
.PARAMETER StreamName
    Key - System.String
 
.PARAMETER ConsumerType
    Required - System.String
    Allowed values: AzureMonitorLogs, Splunk, AzureEventGrid, AzureEventHub
 
.PARAMETER ConsumerInputs
    Required - HashTable
 
.PARAMETER Enabled
    Write - System.Boolean
 
.EXAMPLE 1
 
 
configuration Add_AzDoAuditStream
{
    Import-DscResource -ModuleName AzureDevOpsDscNative
 
    AzDoAuditStream 'AddAuditStream'
    {
        StreamName = 'MySlackAuditStream'
        ConsumerType = 'Slack'
        ConsumerInputs = @{
            webhookUrl = 'https://hooks.slack.com/services/T000/B000/XXXX'
            channelId = '#audit'
        }
        Enabled = $true
        Ensure = 'Present'
    }
}
 
.EXAMPLE 2
 
 
configuration Update_AzDoAuditStream
{
    Import-DscResource -ModuleName AzureDevOpsDscNative
 
    AzDoAuditStream 'UpdateAuditStream'
    {
        StreamName = 'MySlackAuditStream'
        ConsumerType = 'Slack'
        ConsumerInputs = @{
            webhookUrl = 'https://hooks.slack.com/services/T000/B000/YYYY'
            channelId = '#audit-updated'
        }
        Enabled = $true
        Ensure = 'Present'
    }
}
 
.EXAMPLE 3
 
 
configuration Remove_AzDoAuditStream
{
    Import-DscResource -ModuleName AzureDevOpsDscNative
 
    AzDoAuditStream 'RemoveAuditStream'
    {
        StreamName = 'MySlackAuditStream'
        ConsumerType = 'Slack'
        ConsumerInputs = @{
            webhookUrl = 'https://hooks.slack.com/services/T000/B000/XXXX'
        }
        Ensure = 'Absent'
    }
}