Skip to content

Commit

Permalink
refreshing docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
potatoqualitee authored and github-actions[bot] committed Jul 16, 2024
1 parent c58b1b4 commit 4ace112
Show file tree
Hide file tree
Showing 29 changed files with 812 additions and 789 deletions.
3 changes: 2 additions & 1 deletion Connect-DbaInstance.html
Original file line number Diff line number Diff line change
Expand Up @@ -1492,7 +1492,8 @@ <h5 id="tenant">-Tenant</h5>
</table>
<h5 id="accesstoken">-AccessToken</h5>
<p>Connect to an Azure SQL Database or an Azure SQL Managed Instance with an AccessToken, that has to be generated with Get-AzAccessToken or New-DbaAzAccessToken.<br />
Note that the token is valid for only one hour and cannot be renewed automatically.<br></p>
Note that the token is valid for only one hour and cannot be renewed automatically.<br />
Note that the returned SMO is not a fully functional SMO. It can only be used in a limited list of commands like Invoke-DbaQuery, Import-DbaCsv or Write-DbaDbTableData.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Disable-DbaDbEncryption.html
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ <h5 id="noencryptionkeydrop">-NoEncryptionKeyDrop</h5>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and disables you to catch exceptions with your own try/catch.<br></p>
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Export-DbatoolsConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -788,8 +788,9 @@ <h5 id="skipunchanged">-SkipUnchanged</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>This parameters disables user-friendly warnings and enables the throwing of exceptions.<br />
This is less user friendly, but allows catching exceptions in calling scripts.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaBackupInformation.html
Original file line number Diff line number Diff line change
Expand Up @@ -802,8 +802,9 @@ <h5 id="directoryrecurse">-DirectoryRecurse</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>Replaces user friendly yellow warnings with bloody red exceptions of doom!<br />
Use this if you want the function to throw terminating errors you want to catch.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbAssembly.html
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ <h5 id="name">-Name</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong, we try to catch it, interpret it and give you a friendly warning message.<br />
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbObjectTrigger.html
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ <h5 id="inputobject">-InputObject</h5>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/ca<br></p>
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbTrigger.html
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,7 @@ <h5 id="inputobject">-InputObject</h5>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/ca<br></p>
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaLastBackup.html
Original file line number Diff line number Diff line change
Expand Up @@ -642,8 +642,9 @@ <h5 id="excludedatabase">-ExcludeDatabase</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>If this switch is enabled exceptions will be thrown to the caller, which will need to perform its own exception processing. Otherwise, the function will try to catch the exception, interpret it and<br />
provide a friendly error message.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
6 changes: 3 additions & 3 deletions Get-DbaMsdtc.html
Original file line number Diff line number Diff line change
Expand Up @@ -575,9 +575,9 @@ <h5 id="credential">-Credential</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default in most of our commands, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This command, however, gifts you with &quot;sea of red&quot; exceptions, by default, because it is useful for advanced scripting.<br />
Using this switch turns our &quot;nice by default&quot; feature on which makes errors into pretty warnings.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaPermission.html
Original file line number Diff line number Diff line change
Expand Up @@ -701,8 +701,9 @@ <h5 id="excludesystemobjects">-ExcludeSystemObjects</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>If this switch is enabled exceptions will be thrown to the caller, which will need to perform its own exception processing. Otherwise, the function will try to catch the exception, interpret it and<br />
provide a friendly error message.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaServerRole.html
Original file line number Diff line number Diff line change
Expand Up @@ -655,8 +655,9 @@ <h5 id="excludefixedrole">-ExcludeFixedRole</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because<br />
it basically disables advanced scripting. Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaStartupParameter.html
Original file line number Diff line number Diff line change
Expand Up @@ -599,8 +599,9 @@ <h5 id="simple">-Simple</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>If this switch is enabled, exceptions will be thrown to the caller, which will need to perform its own exception processing. Otherwise, the function will try to catch the exception, interpret it and<br />
provide a friendly error message.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaWaitResource.html
Original file line number Diff line number Diff line change
Expand Up @@ -631,8 +631,9 @@ <h5 id="row">-Row</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>Replaces user friendly yellow warnings with bloody red exceptions of doom!<br />
Use this if you want the function to throw terminating errors you want to catch.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Get-DbaXEObject.html
Original file line number Diff line number Diff line change
Expand Up @@ -609,8 +609,9 @@ <h5 id="type">-Type</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because<br />
it basically disables advanced scripting. Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 3 additions & 2 deletions Import-DbatoolsConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -715,8 +715,9 @@ <h5 id="peek">-Peek</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>This parameters disables user-friendly warnings and enables the throwing of exceptions.<br />
This is less user friendly, but allows catching exceptions in calling scripts.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
5 changes: 5 additions & 0 deletions Install-DbaInstance.html
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,11 @@ <h5 id="example-5">Example: 5</h5>
<p>Install SQL Server 2016 instance into D:\Root drive, set default data folder as E: and default logs folder as L:.<br>
Perform volume maintenance tasks permission is granted. MyDomain\SvcSqlServer is used as a service account for SqlServer.<br></p>
<h5 id="example-6">Example: 6</h5>
<pre><code>PS C:\&gt; $svcAcc = [PSCredential]::new(&quot;MyDomain\SvcSqlServer$&quot;, [SecureString]::new())
PS C:\&gt; Install-DbaInstance -Version 2016 -InstancePath D:\Root -DataPath E: -LogPath L: -PerformVolumeMaintenanceTasks -EngineCredential $svcAcc
</code></pre>
<p>The same as the last example except MyDomain\SvcSqlServer is now a Managed Service Account (MSA).<br></p>
<h5 id="example-7">Example: 7</h5>
<pre><code>PS C:\&gt; $config = @{
&gt;&gt; AGTSVCSTARTUPTYPE = &quot;Manual&quot;
&gt;&gt; BROWSERSVCSTARTUPTYPE = &quot;Manual&quot;
Expand Down
5 changes: 3 additions & 2 deletions Invoke-DbaAdvancedRestore.html
Original file line number Diff line number Diff line change
Expand Up @@ -1134,8 +1134,9 @@ <h5 id="stopafterdate">-StopAfterDate</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>Replaces user friendly yellow warnings with bloody red exceptions of doom!<br />
Use this if you want the function to throw terminating errors you want to catch.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
4 changes: 3 additions & 1 deletion Invoke-DbaDbLogShipping.html
Original file line number Diff line number Diff line change
Expand Up @@ -2990,7 +2990,9 @@ <h5 id="force">-Force</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>Use this switch to disable any kind of verbose messages<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
6 changes: 3 additions & 3 deletions New-DbaAzAccessToken.html
Original file line number Diff line number Diff line change
Expand Up @@ -745,9 +745,9 @@ <h5 id="store">-Store</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default in most of our commands, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This command, however, gifts you with &quot;sea of red&quot; exceptions, by default, because it is useful for advanced scripting.<br />
Using this switch turns our &quot;nice by default&quot; feature on which makes errors into pretty warnings.<br></p>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
<tr>
Expand Down
Loading

0 comments on commit 4ace112

Please sign in to comment.