Functions/Common/ConnectionObjectRequests.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
function New-RsWebServiceProxyHelper
{
    <#
        .SYNOPSIS
            Internal helper function. Facilitates generating WebProxy objects.
        
        .DESCRIPTION
            Internal helper function. Facilitates generating WebProxy objects.
            
            It accepts all bound parameters of the calling function and processes the following keys:
            - ReportServerUri
            - Credential
            - Proxy
            - APIVersion
            These parameters are passed on to the New-RsWebServiceProxy function, unless Proxy was specified.
            If the bound parameters contain the proxy parameter, the function will return that object.
            All other bound parameters are ignored.
        
        .PARAMETER BoundParameters
            The bound parameters of the calling function
        
        .EXAMPLE
            $Proxy = New-RsWebServiceProxyHelper -BoundParameters $PSBoundParameters
        
            Generates or retrieves a proxy object for the reporting services web api.
    #>

    [CmdletBinding()]
    Param (
        [AllowNull()]
        [object]
        $BoundParameters
    )
    
    if ($BoundParameters["Proxy"])
    {
        return $BoundParameters["Proxy"]
    }
    
    $goodKeys = @("ReportServerUri", "Credential", "ApiVersion")
    $NewRsWebServiceProxyParam = @{ }
    
    foreach ($key in $BoundParameters.Keys)
    {
        if ($goodKeys -contains $key)
        {
            $NewRsWebServiceProxyParam[$key] = $BoundParameters[$key]
        }
    }
    
    New-RsWebServiceProxy @NewRsWebServiceProxyParam
}

function New-RsRestSessionHelper
{
    <#
        .SYNOPSIS
            Internal helper function. Facilitates generating Rest Session objects.
        
        .DESCRIPTION
            Internal helper function. Facilitates generating Rest Session objects.
            
            It accepts all bound parameters of the calling function and processes the following keys:
            - ReportPortalUri
            - RestApiVersion
            - Credential
            - WebSession
            These parameters are passed on to the New-RsRestSession function, unless WebSession was specified.
            If the bound parameters contain the WebSession parameter, the function will return that object.
            All other bound parameters are ignored.
        
        .PARAMETER BoundParameters
            The bound parameters of the calling function
        
        .EXAMPLE
            $RsRestWebSession = New-RsRestSessionHelper -BoundParameters $PSBoundParameters
        
            Generates or retrieves a WebSession object for the reporting services REST api.
    #>


    [CmdletBinding()]
    Param (
        [AllowNull()]
        [object]
        $BoundParameters
    )

    if ($BoundParameters["WebSession"])
    {
        return $BoundParameters["WebSession"]
    }

    $goodKeys = @("ReportPortalUri", "RestApiVersion", "Credential")
    $NewRsRestSessionParams = @{ }

    foreach ($key in $BoundParameters.Keys)
    {
        if ($goodKeys -contains $key)
        {
            $NewRsRestSessionParams[$key] = $BoundParameters[$key]
        }
    }

    New-RsRestSession @NewRsRestSessionParams
}

function Get-RsPortalUriHelper
{
    <#
        .SYNOPSIS
            Internal helper function. Facilitates determining the Portal Uri from WebSession object.
        
        .DESCRIPTION
            Internal helper function. Facilitates determining the Portal Uri from WebSession object.
        
        .PARAMETER WebSession
            The WebSession object returned from executing New-RsRestSession command.
        
        .EXAMPLE
            $reportPortalUri = Get-RsPortalUriHelper -WebSession $mySession
        
            Retrieves the Portal Uri for which this web session was created.
    #>


    [CmdletBinding()]
    Param (
        [AllowNull()]
        [Microsoft.PowerShell.Commands.WebRequestSession]
        $WebSession
    )

    if ($WebSession -ne $null)
    {
        $reportPortalUri = $WebSession.Headers['X-RSTOOLS-PORTALURI']
        if (![String]::IsNullOrEmpty($reportPortalUri))
        {
            if ($reportPortalUri -notlike '*/') 
            {
                $reportPortalUri = $reportPortalUri + '/'
            }
            return $reportPortalUri
        }
    }

    throw "Invalid WebSession specified! Please specify a valid WebSession or run New-RsRestSession to create a new one."
}

function New-RsConfigurationSettingObjectHelper
{
    <#
        .SYNOPSIS
            Internal helper function. Facilitates generating wmi objects.
        
        .DESCRIPTION
            Internal helper function. Facilitates generating wmi objects.
            
            It accepts all bound parameters of the calling function and processes the following keys:
            - ReportServerInstance
            - ReportServerVersion
            - ComputerName
            - Credential
            - MinimumReportServerVersion
            These parameters are passed on to the New-RsConfigurationSettingObject function.
            All other bound parameters are ignored.
        
        .PARAMETER BoundParameters
            The bound parameters of the calling function
        
        .EXAMPLE
            $rsWmiObject = New-RsConfigurationSettingObjectHelper -BoundParameters $PSBoundParameters
        
            Generates or retrieves a wmi object for administrating a Report Server.
    #>

    [CmdletBinding()]
    Param (
        [AllowNull()]
        [object]
        $BoundParameters
    )
    
    $goodKeys = @("SqlServerInstance", "ReportServerInstance", "SqlServerVersion", "ReportServerVersion", "ComputerName", "Credential", "MinimumSqlServerVersion", "MinimumReportServerVersion")
    $NewRsConfigurationSettingObjectParam = @{ }
    
    foreach ($key in $BoundParameters.Keys)
    {
        if ($goodKeys -contains $key)
        {
            $NewRsConfigurationSettingObjectParam[$key] = $BoundParameters[$key]
        }
    }
    
    New-RsConfigurationSettingObject @NewRsConfigurationSettingObjectParam
}