-
Notifications
You must be signed in to change notification settings - Fork 96
/
Powershell_Template_with_Transcript_and_AzModules.ps1
167 lines (134 loc) · 4.95 KB
/
Powershell_Template_with_Transcript_and_AzModules.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
# when creating a scheduled task to run such scripts, use the following structure example:
# powershell.exe -NoProfile -ExecutionPolicy Bypass -File "C:\Madeira\Powershell_Template_with_Transcript.ps1"
Param
(
## Specify the relevant subscription Name.
[Parameter(Mandatory=$false,
HelpMessage="Enter the Name of the relevant Subscription")]
[string]
$SubscriptionName = "Visual Studio MPN",
[string]$logFileFolderPath = "C:\Madeira\log",
[string]$logFilePrefix = "my_ps_script_",
[string]$logFileDateFormat = "yyyyMMdd_HHmmss",
[int]$logFileRetentionDays = 30
)
Process {
#region initialization
function Get-TimeStamp {
Param(
[switch]$NoWrap,
[switch]$Utc
)
$dt = Get-Date
if ($Utc -eq $true) {
$dt = $dt.ToUniversalTime()
}
$str = "{0:MM/dd/yy} {0:HH:mm:ss}" -f $dt
if ($NoWrap -ne $true) {
$str = "[$str]"
}
return $str
}
if ($logFileFolderPath -ne "")
{
if (!(Test-Path -PathType Container -Path $logFileFolderPath)) {
Write-Output "$(Get-TimeStamp) Creating directory $logFileFolderPath" | Out-Null
New-Item -ItemType Directory -Force -Path $logFileFolderPath | Out-Null
} else {
$DatetoDelete = $(Get-Date).AddDays(-$logFileRetentionDays)
Get-ChildItem $logFileFolderPath | Where-Object { $_.Name -like "*$logFilePrefix*" -and $_.LastWriteTime -lt $DatetoDelete } | Remove-Item | Out-Null
}
$logFilePath = $logFileFolderPath + "\$logFilePrefix" + (Get-Date -Format $logFileDateFormat) + ".LOG"
# attempt to start the transcript log, but don't fail the script if unsuccessful:
try
{
Start-Transcript -Path $logFilePath -Append
}
catch [Exception]
{
Write-Warning "$(Get-TimeStamp) Unable to start Transcript: $($_.Exception.Message)"
$logFileFolderPath = ""
}
}
#endregion initialization
#region install-modules
## Uninstall deprecated AzureRm modules
if (Get-Module -ListAvailable -Name "AzureRm*") {
Write-Verbose "$(Get-TimeStamp) AzureRm module found. Uninstalling..."
Get-Module -ListAvailable -Name "AzureRm*" | foreach {
Write-Output "$(Get-TimeStamp) Uninstalling: $_"
Remove-Module $_ -Force -Confirm:$false | Out-Null
Uninstall-Module $_ -AllVersions -Force -Confirm:$false | Out-Null
}
}
## Install the modules that you need from the PowerShell Gallery
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
if (Get-PSRepository -Name "PSGallery") {
Write-Verbose "$(Get-TimeStamp) PSGallery already registered"
}
else {
Write-Information "$(Get-TimeStamp) Registering PSGallery"
Register-PSRepository -Default
}
## you can add or remove additional modules here as needed
$modules = @("Az.Accounts", "Az.Compute", "Az.Sql", "dbatools")
foreach ($module in $modules) {
if (Get-Module -ListAvailable -Name $module) {
Write-Verbose "$(Get-TimeStamp) $module already installed"
}
else {
Write-Information "$(Get-TimeStamp) Installing $module"
Install-Module $module -Force -SkipPublisherCheck -Scope CurrentUser -ErrorAction Stop -AllowClobber | Out-Null
Import-Module $module -Force -Scope Local | Out-Null
}
}
#endregion install-modules
#region azure-logon
## Log into Azure if you aren't already logged in. Unfortunately there
## appears to be a problem using regular MS accounts as credentials for
## Login-AzAccount so you have to go through the pop-up window & log in manually.
$needLogin = $true
Try
{
$content = Get-AzContext
if ($content)
{
$needLogin = ([string]::IsNullOrEmpty($content.Account))
}
}
Catch
{
if ($_ -like "*Connect-AzAccount to login*")
{
$needLogin = $true
}
else
{
throw
}
}
if ($needLogin)
{
Connect-AzAccount -Subscription $SubscriptionName | Out-Null
}
## Switch to the correct directory and subscription
Get-AzSubscription | Where-Object {$_.Name -eq $SubscriptionName} | ForEach-Object {
Write-Output "$(Get-TimeStamp) Switching to subscription '$($_.Name)' in TenantId '$($_.TenantId)'"
$SubscriptionId = $_.Id
Connect-AzAccount -Subscription $SubscriptionName -Tenant $_.TenantId | Out-Null
}
if ($SubscriptionId -eq "" -or $SubscriptionId -eq $null)
{
Stop-PSFFunction -Message "$(Get-TimeStamp) No suitable subscription found" -Category InvalidArgument
}
#endregion azure-logon
#region main
# TODO: Replace this code with your actual script body:
Write-Output "$(Get-TimeStamp) Example output message. Check out the timestamp on this bad boy."
# When using Invoke-Sqlcmd, be sure to add parameters -OutputSqlErrors $true -Verbose to capture all output. For example:
Invoke-Sqlcmd -Server "." -Database "master" -Query "PRINT 'This is the output of a SQL command, generated by: ' + PROGRAM_NAME() + ' on server ' + @@SERVERNAME" -QueryTimeout 0 -OutputSqlErrors $true -Verbose
#endregion main
#region finalization
if ($logFileFolderPath -ne "") { Stop-Transcript }
#endregion finalization
}