PowervRA

2.2.0

Functions/Public/identity/Remove-vRABusinessGroup.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
105
106
107
108
109
110
111
112
 function Remove-vRABusinessGroup {
<#
    .SYNOPSIS
    Remove a vRA Business Group
    
    .DESCRIPTION
    Remove a vRA Business Group
    
    .PARAMETER TenantId
    Tenant Id

    .PARAMETER Id
    Business Group Id

    .PARAMETER Name
    Business Group Name

    .INPUTS
    System.String.

    .OUTPUTS
    None

    .EXAMPLE
    Remove-vRABusinessGroup -TenantId Tenant01 -Id "f8e0d99e-c567-4031-99cb-d8410c841ed7"

    .EXAMPLE
    Remove-vRABusinessGroup -TenantId Tenant01 -Name "BusinessGroup01","BusinessGroup02"
    
    .EXAMPLE
    Get-vRABusinessGroup -TenantId Tenant01 -Name BusinessGroup01 | Remove-vRABusinessGroup -Confirm:$false
#>
[CmdletBinding(SupportsShouldProcess,ConfirmImpact="High",DefaultParameterSetName="Id")]

    Param (

    [parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)]
    [ValidateNotNullOrEmpty()]
    [Alias(“Tenant”)]
    [String]$TenantId,

    [parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,ParameterSetName="Id")]
    [ValidateNotNullOrEmpty()]
    [String[]]$Id,

    [parameter(Mandatory=$true,ParameterSetName="Name")]
    [ValidateNotNullOrEmpty()]
    [String[]]$Name
    )    

    begin {
        # --- Test for vRA API version
        xRequires -Version 7.0
    }
    
    process {    

        switch ($PsCmdlet.ParameterSetName) 
        { 
            "Id"  {

                foreach ($BusinessGroupId in $Id){
                
                    try {
                        if ($PSCmdlet.ShouldProcess($BusinessGroupId)){

                            $URI = "/identity/api/tenants/$($TenantId)/subtenants/$($id)"  

                            # --- Run vRA REST Request
                            $Response = Invoke-vRARestMethod -Method DELETE -URI $URI
                        }
                    }
                    catch [Exception]{

                        throw
                    } 
                }                
            
                break
            }

            "Name"  {

                foreach ($BusinessGroupName in $Name){
                
                    try {
                        if ($PSCmdlet.ShouldProcess($BusinessGroupName)){

                            # --- Find the Business Group
                            $BusinessGroup = Get-vRABusinessGroup -TenantId $TenantId -Name $BusinessGroupName
                            $Id = $BusinessGroup.ID

                            $URI = "/identity/api/tenants/$($TenantId)/subtenants/$($Id)"  

                            # --- Run vRA REST Request
                            $Response = Invoke-vRARestMethod -Method DELETE -URI $URI
                        }
                    }
                    catch [Exception]{

                        throw
                    } 
                }
                
                break
            } 
        }             
    }
    end {
        
    }
}