Storefront

0.9.6

DSCResources/VE_SFStore/VE_SFStore.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
 Import-LocalizedData -BindingVariable localizedData -FileName Resources.psd1;

function Get-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param (
        [Parameter(Mandatory)]
        [System.String] $VirtualPath,

        ## Only applicable to v3.5 stores (if thinking about backward compatibility
        [Parameter(Mandatory)]
        [System.String] $AuthenticationServiceVirtualPath,

        [Parameter()]
        [System.UInt64] $SiteId = 1,

        [Parameter()] [ValidateNotNullOrEmpty()]
        [System.String] $FriendlyName,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'

    )
    process {
        ImportSFModule -Name Citrix.Storefront.Stores;
        $store = GetStoreService @PSBoundParameters;
        $targetResource = @{
            VirtualPath = $store.VirtualPath;
            AuthenticationServiceVirtualPath = $store.AuthenticationServiceVirtualPath
            SiteId = $store.SiteId;
            FriendlyName = $store.FriendlyName;
            Ensure = if ($store) { 'Present' } else { 'Absent' };
        }
        return $targetResource;
    } #end process
} #end function Get-TargetResource

function Test-TargetResource {
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param (
        [Parameter(Mandatory)]
        [System.String] $VirtualPath,

        ## Only applicable to v3.5 stores (if thinking about backward compatibility
        [Parameter(Mandatory)]
        [System.String] $AuthenticationServiceVirtualPath,

        [Parameter()]
        [System.UInt64] $SiteId = 1,

        [Parameter()] [ValidateNotNullOrEmpty()]
        [System.String] $FriendlyName,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    process {
        $targetResource = Get-TargetResource @PSBoundParameters;
        $inDesiredState = $true;

        if ($Ensure -ne $targetResource.Ensure) {
            Write-Verbose -Message ($localizedData.ResourcePropertyMismatch -f 'Ensure', $Ensure, $targetResource.Ensure);
            $inDesiredState = $false;
        }

        ## Only check all remaing properties if we're setting
        if ($Ensure -eq 'Present') {
            $properties = @('VirtualPath','AuthenticationServiceVirtualPath','SiteId','FriendlyName');
            foreach ($property in $properties) {
                if ($PSBoundParameters.ContainsKey($property)) {
                    $propertyValue = (Get-Variable -Name $property).Value;
                    if ($targetResource.$property -ne $propertyValue) {
                        $message = $localizedData.ResourcePropertyMismatch -f $property, $propertyValue, $targetResource.$property;
                        Write-Verbose -Message $message;
                        $inDesiredState = $false;
                    }
                } #end if PSBoundParameter
            } #end foreach property
        } #end if ensure is present

        if ($inDesiredState) {
            Write-Verbose -Message ($localizedData.ResourceInDesiredState -f $VirtualPath);
        }
        else {
            Write-Verbose -Message ($localizedData.ResourceNotInDesiredState -f $VirtualPath);
        }
        return $inDesiredState;
    } #end process
} #end function Test-TargetResource

function Set-TargetResource {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory)]
        [System.String] $VirtualPath,

        ## Only applicable to v3.5 stores (if thinking about backward compatibility
        [Parameter(Mandatory)]
        [System.String] $AuthenticationServiceVirtualPath,

        [Parameter()]
        [System.UInt64] $SiteId = 1,

        [Parameter()] [ValidateNotNullOrEmpty()]
        [System.String] $FriendlyName,

        [Parameter()] [ValidateSet('Present','Absent')]
        [System.String] $Ensure = 'Present'
    )
    process {
        ImportSFModule -Name Citrix.Storefront.Stores;
        $store = GetStoreService @PSBoundParameters;
        $authenticationService = GetAuthenticationService -VirtualPath $AuthenticationServiceVirtualPath;

        if ($Ensure -eq 'Absent') {
            if ($store) {
                ## Store exists, removing
                Write-Verbose -Message ($localizedData.RemovingStore -f $VirtualPath);
                [ref] $null = Remove-STFStoreService -StoreService $store -Force -Confirm:$false;
            }
        }
        elseif ($Ensure -eq 'Present') {
            if ($store) {
                ## Store already exists
                if ($FriendlyName -ne $store.FriendlyName) {
                    ## Cannot update friendly name
                    $errorMessage = $localizedData.CannotUpdatePropertyError -f 'FriendlyName';
                    ThrowInvalidOperationException -ErrorId ImmutableProperty -ErrorMessage $errorMessage;
                }
                if ($AuthenticationServiceVirtualPath -ne $authenticationService.VirtualPath) {
                    ## Update authentication
                    Write-Verbose -Message ($localizedData.UpdatingStoreAuthentication -f $AuthenticationServiceVirtualPath);
                    [ref] $null = Set-STFStoreService -StoreService $store -AuthenticationService $authenticationService -Force -Confirm:$false;
                }
            }
            else {
                Write-Verbose -Message ($localizedData.AddingStore -f $VirtualPath);
                $addSTFStoreServiceParams = @{
                    VirtualPath = $VirtualPath;
                    AuthenticationService = $authenticationService;
                }
                if ($PSBoundParameters.ContainsKey('SiteId')) {
                    $addSTFStoreServiceParams['SiteId'] = $SiteId;
                }
                if ($PSBoundParameters.ContainsKey('FriendlyName')) {
                    $addSTFStoreServiceParams['FriendlyName'] = $FriendlyName;
                }
                [ref] $null = Add-STFStoreService @addSTFStoreServiceParams;
            }
        }
    } #end process
} #end function Set-TargetResource