Functions/Remove-DqEntity.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
Function Remove-DqEntity
{
  <#
    .SYNOPSIS
      Deze functie verwijdert een enkele entiteit uit een DQ Monitor Webservice.
   
    .DESCRIPTION
      De Remove-DqEntity functie geeft de mogelijkheid om een enkele entiteit te verwijderen uit een DQ Monitor Webservice.
      Voordat deze functie gebruikt wordt, zorg ervoor dat de Context is gezet via functie Set-DqContext.
   
    .PARAMETER Name
      De unieke naam van het entiteit zoals deze bekend is bij de DQ Monitor Webservice.
     
    .PARAMETER Force
      Optioneel: Indien opgegeven zal het entiteit worden verwijderd zonder eerst een bevestiging te vragen.
       
    .REMARS
      Let op: Indien er nog controles aan een entiteit hangen is het niet mogelijk het entiteit te verwijderen.
      Zorg er eerst voor dat het entiteit niet meer wordt gebruikt.
 
    .INPUTS
      Geen.
   
    .OUTPUTS
      Geen.
   
    .EXAMPLE
      PS> Remove-DqEntity -Name "Contract"
      Weet u zeker dat entiteit 'Contract' met Id 84 verwijderd moet worden uit DQ Monitor? Dit kan niet ongedaan gemaakt worden:
      Keuze (jn):
   
    .EXAMPLE
      PS> Remove-DqEntity -Name "Contract" -Force
      Entiteit is verwijderd.
 
    .LINK
      Set-DqContext
  #>


  [CmdletBinding(DefaultParameterSetName="ByEntityName")]
  Param(
    [Parameter(Mandatory=$True, ParameterSetName="ByEntityName", position=1)]
    [ValidateNotNullOrEmpty()]
    [String] $Name,

    [Parameter(Mandatory=$False, ParameterSetName="ByEntityName", position=2)]
    [Switch] $Force,

    [Parameter(Mandatory=$True, ParameterSetName="ByEntityObject", position=1)]
    [ValidateNotNull()]
    [PsCustomObject] $EntityObject
  )
  
  If ($PSCmdlet.ParameterSetName.Equals("ByEntityName"))
  { 
    $EntityObjects = Get-DqEntities -CustomOnly | Where-Object { $_.Name -eq $Name } 
    If (-not($EntityObjects))
    {
      Write-Host "Entiteit '$($Name)' kon niet worden gevonden." -ForegroundColor Red
      Return $False;
    }

    $EntityObject = $EntityObjects | Select -First 1
  }
  
  If (-not($EntityObject.IsCustom))
  {
    Write-Host "Entiteit '$($EntityObject.Name)' is geen eigen gemaakte entiteit. Verwijderen wordt niet ondersteund." -ForegroundColor Red 
    Return;
  }

  # Check if there are checks that depend on this entity
  [Array] $Checks = Get-DqChecks | Where-Object { $_.Entity -eq $EntityObject.Name }
  If ($Checks.Count -gt 0)
  {
    Write-Host "Entiteit '$($EntityObject.Name)' is nog gekoppeld aan $($Checks.Count) controle(s). Verwijderen wordt niet ondersteund." -ForegroundColor Red 
    Return;
  }
  
  If (-Not($Force.IsPresent) -or -not($Force))
  {
    Write-Host "Weet u zeker dat entiteit " -NoNewline
    Write-Host "'$($EntityObject.Name)'" -NoNewline -ForegroundColor White -BackgroundColor DarkRed 
    Write-Host " met Id " -NoNewline
    Write-Host "$($EntityObject.Id)" -NoNewline -ForegroundColor White -BackgroundColor DarkRed 
    Write-Host " verwijderd moet worden uit DQ Monitor? Dit kan niet ongedaan gemaakt worden:" 
  
    $Keuze = ""
    Do
    {
      $Keuze = Read-Host "Keuze (jn)"
    } While ($Keuze.Trim() -notmatch '^[jJnN]$')

    If ($Keuze.ToLowerInvariant().Equals("n"))
    {
      Write-Host "Handeling afgebroken."
      Return;
    }
  }

  Write-Verbose "Verwijderen van entiteit '$($EntityObject.Name)' met Id $($EntityObject.Id)..."
  Remove-Entity -EntityId $EntityObject.Id -ErrorAction Stop | Out-Null
  Write-Host "Entiteit is verwijderd."
}