Merge branch 'release/2.0.0'

abbgrade · Jul 19, 2023 · 988dcc8 · 988dcc8
2 parents 12ef744 + c7b07b7
commit 988dcc8
Show file tree

Hide file tree

Showing 8 changed files with 792 additions and 175 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2023-05-30
+
+### Added
+
+- Support for default Azure authentication.
+- Acquire token switch.
+
+### Changed
+
+- Parametersets of `Connect-Instance`.
+
 ## [1.5.0] - 2023-03-29
 
 ### Added

diff --git a/docs/Connect-TSqlInstance.md b/docs/Connect-TSqlInstance.md
@@ -12,30 +12,62 @@ schema: 2.0.0
 
 ## SYNTAX
 
-### Properties_IntegratedSecurity (Default)
+### Properties_Basic (Default)
 ```
 Connect-TSqlInstance [-DataSource] <String> [-Port <Int32>] [[-InitialCatalog] <String>]
- [-ConnectTimeout <Int32>] [-RetryCount <Int32>] [-RetryInterval <Int32>] [<CommonParameters>]
+ [-TrustServerCertificate] [-ConnectTimeout <Int32>] [-ConnectRetryCount <Int32>]
+ [-ConnectRetryInterval <Int32>] [-Authentication <SqlAuthenticationMethod>] [-IntegratedSecurity]
+ [<CommonParameters>]
 ```
 
 ### ConnectionString
 ```
-Connect-TSqlInstance [-ConnectionString] <String> [-RetryCount <Int32>] [-RetryInterval <Int32>]
+Connect-TSqlInstance [-ConnectionString] <String> [-Authentication <SqlAuthenticationMethod>]
+ [-IntegratedSecurity] [<CommonParameters>]
+```
+
+### ConnectionString_withToken
+```
+Connect-TSqlInstance [-ConnectionString] <String> [-Authentication <SqlAuthenticationMethod>]
+ [-IntegratedSecurity] -AccessToken <String> [<CommonParameters>]
+```
+
+### ConnectionString_acquireToken
+```
+Connect-TSqlInstance [-ConnectionString] <String> [-Authentication <SqlAuthenticationMethod>]
+ [-IntegratedSecurity] [-AcquireToken] [<CommonParameters>]
+```
+
+### Properties_Basic_withToken
+```
+Connect-TSqlInstance [-DataSource] <String> [-Port <Int32>] [-InitialCatalog] <String>
+ [-TrustServerCertificate] [-ConnectTimeout <Int32>] [-ConnectRetryCount <Int32>]
+ [-ConnectRetryInterval <Int32>] [-Authentication <SqlAuthenticationMethod>] [-IntegratedSecurity]
+ -AccessToken <String> [<CommonParameters>]
+```
+
+### Properties_Basic_acquireToken
+```
+Connect-TSqlInstance [-DataSource] <String> [-Port <Int32>] [-InitialCatalog] <String>
+ [-ConnectTimeout <Int32>] [-ConnectRetryCount <Int32>] [-ConnectRetryInterval <Int32>]
+ [-Authentication <SqlAuthenticationMethod>] [-IntegratedSecurity] [-AcquireToken] [-Resource <String>]
  [<CommonParameters>]
 ```
 
 ### Properties_Credential
 ```
 Connect-TSqlInstance [-DataSource] <String> [-Port <Int32>] [[-InitialCatalog] <String>]
- [-ConnectTimeout <Int32>] [-UserId] <String> [-Password] <SecureString> [-RetryCount <Int32>]
- [-RetryInterval <Int32>] [<CommonParameters>]
+ [-TrustServerCertificate] [-ConnectTimeout <Int32>] [-ConnectRetryCount <Int32>]
+ [-ConnectRetryInterval <Int32>] [-Authentication <SqlAuthenticationMethod>] [-IntegratedSecurity]
+ [-UserId] <String> [-Password] <SecureString> [<CommonParameters>]
 ```
 
-### Properties_AccessToken
+### Properties_CredentialObject
 ```
 Connect-TSqlInstance [-DataSource] <String> [-Port <Int32>] [[-InitialCatalog] <String>]
- [-ConnectTimeout <Int32>] -AccessToken <String> [-RetryCount <Int32>] [-RetryInterval <Int32>]
- [<CommonParameters>]
+ [-TrustServerCertificate] [-ConnectTimeout <Int32>] [-ConnectRetryCount <Int32>]
+ [-ConnectRetryInterval <Int32>] [-Authentication <SqlAuthenticationMethod>] [-IntegratedSecurity]
+ [-Credential <PSCredential>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -57,7 +89,7 @@ PS C:\> {{ Add example code here }}
 
 ```yaml
 Type: String
-Parameter Sets: Properties_AccessToken
+Parameter Sets: ConnectionString_withToken, Properties_Basic_withToken
 Aliases:
 
 Required: True
@@ -72,7 +104,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: Int32
-Parameter Sets: Properties_IntegratedSecurity, Properties_Credential, Properties_AccessToken
+Parameter Sets: Properties_Basic, Properties_Basic_withToken, Properties_Basic_acquireToken, Properties_Credential, Properties_CredentialObject
 Aliases:
 
 Required: False
@@ -97,12 +129,24 @@ Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
+```yaml
+Type: String
+Parameter Sets: ConnectionString_withToken, ConnectionString_acquireToken
+Aliases:
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
 ### -DataSource
 {{ Fill DataSource Description }}
 
 ```yaml
 Type: String
-Parameter Sets: Properties_IntegratedSecurity, Properties_Credential, Properties_AccessToken
+Parameter Sets: Properties_Basic, Properties_Basic_withToken, Properties_Basic_acquireToken, Properties_Credential, Properties_CredentialObject
 Aliases: Server, ServerName, ServerInstance
 
 Required: True
@@ -117,7 +161,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: String
-Parameter Sets: Properties_IntegratedSecurity, Properties_Credential, Properties_AccessToken
+Parameter Sets: Properties_Basic, Properties_Credential, Properties_CredentialObject
 Aliases: Database, DatabaseName
 
 Required: False
@@ -127,6 +171,18 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+```yaml
+Type: String
+Parameter Sets: Properties_Basic_withToken, Properties_Basic_acquireToken
+Aliases: Database, DatabaseName
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -Password
 {{ Fill Password Description }}
 
@@ -147,7 +203,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: Int32
-Parameter Sets: Properties_IntegratedSecurity, Properties_Credential, Properties_AccessToken
+Parameter Sets: Properties_Basic, Properties_Basic_withToken, Properties_Basic_acquireToken, Properties_Credential, Properties_CredentialObject
 Aliases:
 
 Required: False
@@ -157,48 +213,138 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -RetryCount
-{{ Fill RetryCount Description }}
+### -UserId
+{{ Fill UserId Description }}
 
 ```yaml
-Type: Int32
+Type: String
+Parameter Sets: Properties_Credential
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -Authentication
+{{ Fill Authentication Description }}
+
+```yaml
+Type: SqlAuthenticationMethod
 Parameter Sets: (All)
 Aliases:
 
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ConnectRetryCount
+{{ Fill ConnectRetryCount Description }}
+
+```yaml
+Type: Int32
+Parameter Sets: Properties_Basic, Properties_Basic_withToken, Properties_Basic_acquireToken, Properties_Credential, Properties_CredentialObject
+Aliases: RetryCount
+
 Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -RetryInterval
-{{ Fill RetryInterval Description }}
+### -ConnectRetryInterval
+{{ Fill ConnectRetryInterval Description }}
 
 ```yaml
 Type: Int32
+Parameter Sets: Properties_Basic, Properties_Basic_withToken, Properties_Basic_acquireToken, Properties_Credential, Properties_CredentialObject
+Aliases: RetryInterval
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Credential
+{{ Fill Credential Description }}
+
+```yaml
+Type: PSCredential
+Parameter Sets: Properties_CredentialObject
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IntegratedSecurity
+{{ Fill IntegratedSecurity Description }}
+
+```yaml
+Type: SwitchParameter
 Parameter Sets: (All)
 Aliases:
 
 Required: False
 Position: Named
 Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -AcquireToken
+{{ Fill AcquireToken Description }}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: ConnectionString_acquireToken, Properties_Basic_acquireToken
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -UserId
-{{ Fill UserId Description }}
+### -Resource
+{{ Fill Resource Description }}
 
 ```yaml
 Type: String
-Parameter Sets: Properties_Credential
+Parameter Sets: Properties_Basic_acquireToken
 Aliases:
 
-Required: True
-Position: 1
+Required: False
+Position: Named
 Default value: None
-Accept pipeline input: True (ByPropertyName, ByValue)
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -TrustServerCertificate
+{{ Fill TrustServerCertificate Description }}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: Properties_Basic, Properties_Basic_withToken, Properties_Credential, Properties_CredentialObject
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 

diff --git a/src/PsSqlClient/.vscode/launch.json b/src/PsSqlClient/.vscode/launch.json
@@ -0,0 +1,20 @@
+{
+    "configurations": [
+        {
+            "name": "PowerShell cmdlets: pwsh",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "debug build",
+            "program": "pwsh",
+            "args": [
+                "-NoExit",
+                "-NoProfile",
+                "-Command",
+                "Import-Module ${workspaceFolder}/bin/Debug/net6.0/publish/PsSqlClient.psd1",
+            ],
+            "cwd": "${workspaceFolder}",
+            "stopAtEntry": false,
+            "console": "integratedTerminal"
+        }
+    ]
+}
diff --git a/src/PsSqlClient/.vscode/tasks.json b/src/PsSqlClient/.vscode/tasks.json
@@ -0,0 +1,23 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "debug build",
+            "command": "dotnet",
+            "type": "shell",
+            "args": [
+                "publish",
+                "${workspaceFolder}",
+                // Ask dotnet build to generate full paths for file names.
+                "/property:GenerateFullPaths=true",
+                // Do not generate summary otherwise it leads to duplicate errors in Problems panel
+                "/consoleloggerparameters:NoSummary",
+            ],
+            "group": "build",
+            "problemMatcher": "$msCompile"
+        }
+
+    ]
+}