From 9fc6498f7cfa1a3e4a8f388c5cd4c2c38f71ca39 Mon Sep 17 00:00:00 2001 From: Stephan van Rooij <1292510+svrooij@users.noreply.github.com> Date: Fri, 6 Sep 2024 16:52:58 +0200 Subject: [PATCH] Update docs --- .../Commands/ConnectWtWinTuner.cs | 8 ++- .../Svrooij.WinTuner.CmdLets.dll-Help.xml | 58 +++++++++++++++++++ 2 files changed, 64 insertions(+), 2 deletions(-) diff --git a/src/Svrooij.WinTuner.CmdLets/Commands/ConnectWtWinTuner.cs b/src/Svrooij.WinTuner.CmdLets/Commands/ConnectWtWinTuner.cs index 9636ad6..92a1dd4 100644 --- a/src/Svrooij.WinTuner.CmdLets/Commands/ConnectWtWinTuner.cs +++ b/src/Svrooij.WinTuner.CmdLets/Commands/ConnectWtWinTuner.cs @@ -34,6 +34,10 @@ namespace Svrooij.WinTuner.CmdLets.Commands; /// Let's say you have a token from another source, just hand us to token and we'll use it to connect to Intune. This token has a limited lifetime, so you'll be responsible for refreshing it. /// /// +/// ClientCertificateCredentials +/// Client credentials flow using a certificate in the user or local computer store.\r\n\r\nMake sure to mark the certificate as not exportable, this helps in keeping the certificate secure. +/// +/// /// ClientCredentials /// :::warning Last resort\r\nUsing client credentials is not recommended because you'll have to keep the secret, **secret**!\r\n\r\nPlease let us know if you have to use this method, we might be able to help you with a better solution.\r\n::: /// @@ -202,8 +206,8 @@ public class ConnectWtWinTuner : DependencyCmdlet Position = 1, ParameterSetName = ParamSetClientCertificateCredentials, ValueFromPipeline = false, - HelpMessage = "Specify the thumbprint of the certificate.")] - public string? ClientCertificateThumbprint { get; set; } + HelpMessage = "Specify the thumbprint of the certificate. Loaded from `AZURE_CLIENT_CERT_THUMBPRINT`")] + public string? ClientCertificateThumbprint { get; set; } = Environment.GetEnvironmentVariable("AZURE_CLIENT_CERT_THUMBPRINT"); /// /// Specify scopes to use diff --git a/src/Svrooij.WinTuner.CmdLets/Svrooij.WinTuner.CmdLets.dll-Help.xml b/src/Svrooij.WinTuner.CmdLets/Svrooij.WinTuner.CmdLets.dll-Help.xml index bd855c1..25749d3 100644 --- a/src/Svrooij.WinTuner.CmdLets/Svrooij.WinTuner.CmdLets.dll-Help.xml +++ b/src/Svrooij.WinTuner.CmdLets/Svrooij.WinTuner.CmdLets.dll-Help.xml @@ -168,6 +168,53 @@ None + + Connect-WtWinTuner + + ClientId + + Specify the client ID, mandatory for Client Certificate flow. Loaded from `AZURE_CLIENT_ID` + + String + + String + + None + + + ClientCertificateThumbprint + + Specify the thumbprint of the certificate. Loaded from `AZURE_CLIENT_CERT_THUMBPRINT` + + String + + String + + None + + + TenantId + + Specify the tenant ID. Loaded from `AZURE_TENANT_ID` + + String + + String + + None + + + Scopes + + Specify the scopes to request, default is `https://graph.microsoft.com/.default` + + String[] + + String[] + + None + + Connect-WtWinTuner @@ -316,6 +363,17 @@ None + + ClientCertificateThumbprint + + Specify the thumbprint of the certificate. Loaded from `AZURE_CLIENT_CERT_THUMBPRINT` + + String + + String + + None + Scopes