en-US/about_AzDoAuditStream.help.txt
|
.NAME
AzDoAuditStream .SYNOPSIS DSC resource for managing Azure DevOps audit log streaming. .DESCRIPTION This resource manages audit streams that forward Azure DevOps audit events to external SIEM or monitoring systems. Audit streams help organizations meet compliance and security monitoring requirements. .PARAMETER StreamName Key - System.String The name of the audit stream. This property is mandatory and serves as the key property for the resource. .PARAMETER ConsumerType Required - System.String Allowed values: AzureMonitorLogs, Splunk, AzureEventGrid, AzureEventHub The type of audit log consumer. Valid values are AzureMonitorLogs, Splunk, AzureEventGrid, and AzureEventHub. .PARAMETER ConsumerInputs Required - HashTable A hashtable of configuration inputs specific to the consumer type. .PARAMETER Enabled Write - System.Boolean Whether the audit stream is active. Defaults to $true. .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' } } |