From e954245d92b05cf17515d9d15488d18663b699c9 Mon Sep 17 00:00:00 2001 From: Beisi Zhou Date: Fri, 17 Feb 2023 18:18:49 +0800 Subject: [PATCH] Move ConnectedKubernetes to main (#20958) * Clean Az.ConnectedKubernetes * Move ConnectedKubernetes to tmp/Az.ConnectedKubernetes (#20957) * Update src/ConnectedKubernetes/Properties/AssemblyInfo.cs --------- Co-authored-by: Azure PowerShell <65331932+azure-powershell-bot@users.noreply.github.com> --- .../Az.ConnectedKubernetes.csproj | 3 +- .../Az.ConnectedKubernetes.psd1 | 4 +- .../Az.ConnectedKubernetes.psm1 | 2 +- .../ConnectedKubernetes.sln | 122 ++-- src/ConnectedKubernetes/MSSharedLibKey.snk | Bin 160 -> 0 bytes .../custom/New-AzConnectedKubernetes.ps1 | 25 +- src/ConnectedKubernetes/custom/README.md | 2 +- .../{utils => custom}/RSAHelper.ps1 | 4 + .../docs/Az.ConnectedKubernetes.md | 28 - .../docs/Get-AzConnectedKubernetes.md | 204 ------- ...Get-AzConnectedKubernetesUserCredential.md | 235 -------- .../docs/New-AzConnectedKubernetes.md | 563 ------------------ .../docs/Remove-AzConnectedKubernetes.md | 260 -------- .../docs/Update-AzConnectedKubernetes.md | 302 ---------- .../exports/New-AzConnectedKubernetes.ps1 | 56 +- .../exports/ProxyCmdletDefinitions.ps1 | 56 +- src/ConnectedKubernetes/exports/README.md | 2 +- src/ConnectedKubernetes/generate-info.json | 4 +- .../help/New-AzConnectedKubernetes.md | 165 ++++- src/ConnectedKubernetes/how-to.md | 2 +- .../internal/New-AzConnectedKubernetes.ps1 | 10 + .../internal/ProxyCmdletDefinitions.ps1 | 10 + src/ConnectedKubernetes/internal/README.md | 2 +- 23 files changed, 356 insertions(+), 1705 deletions(-) delete mode 100644 src/ConnectedKubernetes/MSSharedLibKey.snk rename src/ConnectedKubernetes/{utils => custom}/RSAHelper.ps1 (92%) delete mode 100644 src/ConnectedKubernetes/docs/Az.ConnectedKubernetes.md delete mode 100644 src/ConnectedKubernetes/docs/Get-AzConnectedKubernetes.md delete mode 100644 src/ConnectedKubernetes/docs/Get-AzConnectedKubernetesUserCredential.md delete mode 100644 src/ConnectedKubernetes/docs/New-AzConnectedKubernetes.md delete mode 100644 src/ConnectedKubernetes/docs/Remove-AzConnectedKubernetes.md delete mode 100644 src/ConnectedKubernetes/docs/Update-AzConnectedKubernetes.md diff --git a/src/ConnectedKubernetes/Az.ConnectedKubernetes.csproj b/src/ConnectedKubernetes/Az.ConnectedKubernetes.csproj index d12c91b7cb5d..f1e10a6218f1 100644 --- a/src/ConnectedKubernetes/Az.ConnectedKubernetes.csproj +++ b/src/ConnectedKubernetes/Az.ConnectedKubernetes.csproj @@ -3,7 +3,6 @@ ConnectedKubernetes - + - diff --git a/src/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 b/src/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 index 338365297ca9..fdc667ce4344 100644 --- a/src/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 +++ b/src/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 17/01/2023 +# Generated on: 2/17/2023 # @{ @@ -110,7 +110,7 @@ PrivateData = @{ # IconUri = '' # ReleaseNotes of this module - ReleaseNotes = '* Made ''New-AzConnectedKubernetes'' support PowerShell 5.' + # ReleaseNotes = '' # Prerelease string of this module # Prerelease = '' diff --git a/src/ConnectedKubernetes/Az.ConnectedKubernetes.psm1 b/src/ConnectedKubernetes/Az.ConnectedKubernetes.psm1 index 32b99aec0909..f0eb94be89c3 100644 --- a/src/ConnectedKubernetes/Az.ConnectedKubernetes.psm1 +++ b/src/ConnectedKubernetes/Az.ConnectedKubernetes.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - Write-Error "`nThis module requires $accountsName version 2.7.5 or greater. For installation instructions, please see: https://learn.microsoft.com/powershell/azure/install-az-ps" -ErrorAction Stop + Write-Error "`nThis module requires $accountsName version 2.7.5 or greater. For installation instructions, please see: https://docs.microsoft.com/powershell/azure/install-az-ps" -ErrorAction Stop } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { Write-Error "`nThis module requires $accountsName version 2.7.5 or greater. An earlier version of Az.Accounts is imported in the current PowerShell session. If you are running test, please try to add the switch '-RegenerateSupportModule' when executing 'test-module.ps1'. Otherwise please open a new PowerShell session and import this module again.`nAdditionally, this error could indicate that multiple incompatible versions of Azure PowerShell modules are installed on your system. For troubleshooting information, please see: https://aka.ms/azps-version-error" -ErrorAction Stop } diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.sln b/src/ConnectedKubernetes/ConnectedKubernetes.sln index d345ea0579ca..488efd883e40 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.sln +++ b/src/ConnectedKubernetes/ConnectedKubernetes.sln @@ -1,104 +1,58 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.6.30114.105 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Accounts", "..\Accounts\Accounts\Accounts.csproj", "{827D5D9D-228A-4659-ABAA-2B3B46E4E192}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Accounts", "..\Accounts\Accounts\Accounts.csproj", "{C9D8E39F-55C3-43C2-93B6-8F00CEFAF786}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication", "..\Accounts\Authentication\Authentication.csproj", "{6193F9CE-3F9A-4069-9265-47F4E2440BF8}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssemblyLoading", "..\Accounts\AssemblyLoading\AssemblyLoading.csproj", "{3EDD8420-0387-42B9-8430-D3F4300047A1}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication.ResourceManager", "..\Accounts\Authentication.ResourceManager\Authentication.ResourceManager.csproj", "{D3034A38-46C3-44B5-9AD3-7AD369CFBD62}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication", "..\Accounts\Authentication\Authentication.csproj", "{EB15DC7B-F1FF-4776-AA34-3260552A5A2C}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AuthenticationAssemblyLoadContext", "..\Accounts\AuthenticationAssemblyLoadContext\AuthenticationAssemblyLoadContext.csproj", "{8EA0C726-FE60-4EE7-A549-BEC861E985FE}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication.ResourceManager", "..\Accounts\Authentication.ResourceManager\Authentication.ResourceManager.csproj", "{51FC081F-09F5-411C-A2A8-6BB46FCB4BBB}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accounts\Authenticators\Authenticators.csproj", "{7A9EB8DF-4E08-4739-B894-E54D7A6F8311}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AuthenticationAssemblyLoadContext", "..\Accounts\AuthenticationAssemblyLoadContext\AuthenticationAssemblyLoadContext.csproj", "{42BE450C-B2DE-4958-9F4A-320DFECFD7AE}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ConnectedKubernetes", "Az.ConnectedKubernetes.csproj", "{CD9D5ED3-3724-4AF6-8941-3395986E8D49}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accounts\Authenticators\Authenticators.csproj", "{15CFFEBB-F56F-41BB-845F-2A442E5C7523}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ConnectedKubernetes", "Az.ConnectedKubernetes.csproj", "{0BFCE22D-2CB4-49E1-AD29-B84B382D764B}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU - Debug|x64 = Debug|x64 - Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU - Release|x64 = Release|x64 - Release|x86 = Release|x86 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Debug|Any CPU.Build.0 = Debug|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Debug|x64.ActiveCfg = Debug|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Debug|x64.Build.0 = Debug|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Debug|x86.ActiveCfg = Debug|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Debug|x86.Build.0 = Debug|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Release|Any CPU.ActiveCfg = Release|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Release|Any CPU.Build.0 = Release|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Release|x64.ActiveCfg = Release|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Release|x64.Build.0 = Release|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Release|x86.ActiveCfg = Release|Any CPU - {827D5D9D-228A-4659-ABAA-2B3B46E4E192}.Release|x86.Build.0 = Release|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Debug|Any CPU.Build.0 = Debug|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Debug|x64.ActiveCfg = Debug|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Debug|x64.Build.0 = Debug|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Debug|x86.ActiveCfg = Debug|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Debug|x86.Build.0 = Debug|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Release|Any CPU.ActiveCfg = Release|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Release|Any CPU.Build.0 = Release|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Release|x64.ActiveCfg = Release|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Release|x64.Build.0 = Release|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Release|x86.ActiveCfg = Release|Any CPU - {6193F9CE-3F9A-4069-9265-47F4E2440BF8}.Release|x86.Build.0 = Release|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Debug|x64.ActiveCfg = Debug|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Debug|x64.Build.0 = Debug|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Debug|x86.ActiveCfg = Debug|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Debug|x86.Build.0 = Debug|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Release|Any CPU.Build.0 = Release|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Release|x64.ActiveCfg = Release|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Release|x64.Build.0 = Release|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Release|x86.ActiveCfg = Release|Any CPU - {D3034A38-46C3-44B5-9AD3-7AD369CFBD62}.Release|x86.Build.0 = Release|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Debug|Any CPU.Build.0 = Debug|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Debug|x64.ActiveCfg = Debug|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Debug|x64.Build.0 = Debug|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Debug|x86.ActiveCfg = Debug|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Debug|x86.Build.0 = Debug|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Release|Any CPU.ActiveCfg = Release|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Release|Any CPU.Build.0 = Release|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Release|x64.ActiveCfg = Release|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Release|x64.Build.0 = Release|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Release|x86.ActiveCfg = Release|Any CPU - {8EA0C726-FE60-4EE7-A549-BEC861E985FE}.Release|x86.Build.0 = Release|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Debug|Any CPU.Build.0 = Debug|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Debug|x64.ActiveCfg = Debug|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Debug|x64.Build.0 = Debug|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Debug|x86.ActiveCfg = Debug|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Debug|x86.Build.0 = Debug|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Release|Any CPU.ActiveCfg = Release|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Release|Any CPU.Build.0 = Release|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Release|x64.ActiveCfg = Release|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Release|x64.Build.0 = Release|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Release|x86.ActiveCfg = Release|Any CPU - {7A9EB8DF-4E08-4739-B894-E54D7A6F8311}.Release|x86.Build.0 = Release|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Debug|Any CPU.Build.0 = Debug|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Debug|x64.ActiveCfg = Debug|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Debug|x64.Build.0 = Debug|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Debug|x86.ActiveCfg = Debug|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Debug|x86.Build.0 = Debug|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Release|Any CPU.ActiveCfg = Release|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Release|Any CPU.Build.0 = Release|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Release|x64.ActiveCfg = Release|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Release|x64.Build.0 = Release|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Release|x86.ActiveCfg = Release|Any CPU - {CD9D5ED3-3724-4AF6-8941-3395986E8D49}.Release|x86.Build.0 = Release|Any CPU + {C9D8E39F-55C3-43C2-93B6-8F00CEFAF786}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C9D8E39F-55C3-43C2-93B6-8F00CEFAF786}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C9D8E39F-55C3-43C2-93B6-8F00CEFAF786}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C9D8E39F-55C3-43C2-93B6-8F00CEFAF786}.Release|Any CPU.Build.0 = Release|Any CPU + {3EDD8420-0387-42B9-8430-D3F4300047A1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3EDD8420-0387-42B9-8430-D3F4300047A1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3EDD8420-0387-42B9-8430-D3F4300047A1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3EDD8420-0387-42B9-8430-D3F4300047A1}.Release|Any CPU.Build.0 = Release|Any CPU + {EB15DC7B-F1FF-4776-AA34-3260552A5A2C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {EB15DC7B-F1FF-4776-AA34-3260552A5A2C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {EB15DC7B-F1FF-4776-AA34-3260552A5A2C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {EB15DC7B-F1FF-4776-AA34-3260552A5A2C}.Release|Any CPU.Build.0 = Release|Any CPU + {51FC081F-09F5-411C-A2A8-6BB46FCB4BBB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {51FC081F-09F5-411C-A2A8-6BB46FCB4BBB}.Debug|Any CPU.Build.0 = Debug|Any CPU + {51FC081F-09F5-411C-A2A8-6BB46FCB4BBB}.Release|Any CPU.ActiveCfg = Release|Any CPU + {51FC081F-09F5-411C-A2A8-6BB46FCB4BBB}.Release|Any CPU.Build.0 = Release|Any CPU + {42BE450C-B2DE-4958-9F4A-320DFECFD7AE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {42BE450C-B2DE-4958-9F4A-320DFECFD7AE}.Debug|Any CPU.Build.0 = Debug|Any CPU + {42BE450C-B2DE-4958-9F4A-320DFECFD7AE}.Release|Any CPU.ActiveCfg = Release|Any CPU + {42BE450C-B2DE-4958-9F4A-320DFECFD7AE}.Release|Any CPU.Build.0 = Release|Any CPU + {15CFFEBB-F56F-41BB-845F-2A442E5C7523}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {15CFFEBB-F56F-41BB-845F-2A442E5C7523}.Debug|Any CPU.Build.0 = Debug|Any CPU + {15CFFEBB-F56F-41BB-845F-2A442E5C7523}.Release|Any CPU.ActiveCfg = Release|Any CPU + {15CFFEBB-F56F-41BB-845F-2A442E5C7523}.Release|Any CPU.Build.0 = Release|Any CPU + {0BFCE22D-2CB4-49E1-AD29-B84B382D764B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {0BFCE22D-2CB4-49E1-AD29-B84B382D764B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {0BFCE22D-2CB4-49E1-AD29-B84B382D764B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {0BFCE22D-2CB4-49E1-AD29-B84B382D764B}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection EndGlobal diff --git a/src/ConnectedKubernetes/MSSharedLibKey.snk b/src/ConnectedKubernetes/MSSharedLibKey.snk deleted file mode 100644 index 695f1b38774e839e5b90059bfb7f32df1dff4223..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 160 zcmV;R0AK$ABme*efB*oL000060ssI2Bme+XQ$aBR1ONa50098C{E+7Ye`kjtcRG*W zi8#m|)B?I?xgZ^2Sw5D;l4TxtPwG;3)3^j?qDHjEteSTF{rM+4WI`v zCD?tsZ^;k+S&r1&HRMb=j738S=;J$tCKNrc$@P|lZ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzConnectedKubernetes -InputObject [-DefaultProfile ] - [] -``` - -### List -``` -Get-AzConnectedKubernetes -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. - -## EXAMPLES - -### Example 1: Get all connected kubernetes under a subscription. -```powershell -Get-AzConnectedKubernetes -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -eastus azps_test_cluster_ahb azps_test_group -``` - -This command gets all connected kubernetes under a subscription. - -### Example 2: Get all connected kubernetes under the resource group. -```powershell -Get-AzConnectedKubernetes -ResourceGroupName azps_test_group -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -eastus azps_test_cluster_ahb azps_test_group -``` - -This command gets all connected kubernetes under the resource group. - -### Example 3: Get a connected kubernetes. -```powershell -Get-AzConnectedKubernetes -ResourceGroupName azps_test_group -Name azps_test_cluster -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command gets a connected kubernetes. - -### Example 4: Get a connected kubernetes by object. -```powershell -$conAks = Get-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Get-AzConnectedKubernetes -InputObject $conAks -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -This command gets a connected kubernetes by object. - -## PARAMETERS - -### -ClusterName -The name of the Kubernetes cluster on which get is called. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ClusterName ]`: The name of the Kubernetes cluster on which get is called. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - -## RELATED LINKS - diff --git a/src/ConnectedKubernetes/docs/Get-AzConnectedKubernetesUserCredential.md b/src/ConnectedKubernetes/docs/Get-AzConnectedKubernetesUserCredential.md deleted file mode 100644 index 43212265d335..000000000000 --- a/src/ConnectedKubernetes/docs/Get-AzConnectedKubernetesUserCredential.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: Az.ConnectedKubernetes -online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/get-azconnectedkubernetesusercredential -schema: 2.0.0 ---- - -# Get-AzConnectedKubernetesUserCredential - -## SYNOPSIS -Gets cluster user credentials of the connected cluster with a specified resource group and name. - -## SYNTAX - -### ListExpanded (Default) -``` -Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName - -AuthenticationMethod -ClientProxy [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### List -``` -Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName - -Property [-SubscriptionId ] [-DefaultProfile ] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Gets cluster user credentials of the connected cluster with a specified resource group and name. - -## EXAMPLES - -### Example 1: Gets cluster user credentials of the connected cluster with a specified resource group and name. -```powershell -Get-AzConnectedKubernetesUserCredential -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -AuthenticationMethod AAD -ClientProxy -``` - -```output -HybridConnectionConfigExpirationTime : 1635508790 -HybridConnectionConfigHybridConnectionName : microsoft.kubernetes/connectedclusters/8d3bccced1f3ad1d0e01b03e87d1c8f8a312df7ff028e642512a7999542e46fc/1635497990523092736 -HybridConnectionConfigRelay : azgnrelay-eastus-l1 -HybridConnectionConfigToken : SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.kubernetes%2Fconnectedclusters%2F8d3bccced1f3ad1d0e01b03e87d1c8f8a312df7ff028e642512a7999542e46fc%2F1635497990523092736%2F&sig=wrukC6KAxVFb%2FmsdaTwSv3ChHo0hvTWjf5A80IZs2P4%3D&se=1635509390&skn=sender20211026 -Kubeconfig : {{ - "name": "KubeConfig", - "value": "YXBpVm***G9wDQo=" - }} -``` - -Gets cluster user credentials of the connected cluster with a specified resource group and name. - -### Example 2: Gets cluster user credentials of the connected cluster with a specified resource group and name. -```powershell -Get-AzConnectedKubernetesUserCredential -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -AuthenticationMethod Token -ClientProxy:$false -``` - -```output -HybridConnectionConfigExpirationTime : -HybridConnectionConfigHybridConnectionName : -HybridConnectionConfigRelay : -HybridConnectionConfigToken : -Kubeconfig : {{ - "name": "KubeConfig", - "value": "YXBpVm***G9wDQo=" - }} -``` - -Gets cluster user credentials of the connected cluster with a specified resource group and name. - -## PARAMETERS - -### -AuthenticationMethod -The mode of client authentication. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AuthenticationMethod -Parameter Sets: ListExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientProxy -Boolean value to indicate whether the request is for client side proxy or not - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ListExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -The name of the Kubernetes cluster on which get is called. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -. -To construct, see NOTES section for PROPERTY properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IListClusterUserCredentialProperties -Parameter Sets: List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IListClusterUserCredentialProperties - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.ICredentialResults - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PROPERTY `: . - - `AuthenticationMethod `: The mode of client authentication. - - `ClientProxy `: Boolean value to indicate whether the request is for client side proxy or not - -## RELATED LINKS - diff --git a/src/ConnectedKubernetes/docs/New-AzConnectedKubernetes.md b/src/ConnectedKubernetes/docs/New-AzConnectedKubernetes.md deleted file mode 100644 index 0c2bf28dca13..000000000000 --- a/src/ConnectedKubernetes/docs/New-AzConnectedKubernetes.md +++ /dev/null @@ -1,563 +0,0 @@ ---- -external help file: -Module Name: Az.ConnectedKubernetes -online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/new-azconnectedkubernetes -schema: 2.0.0 ---- - -# New-AzConnectedKubernetes - -## SYNOPSIS -API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM). - -## SYNTAX - -``` -New-AzConnectedKubernetes -ClusterName -ResourceGroupName -Location - [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-OnboardingTimeout ] [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] - [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-KubeConfig ] [-KubeContext ] - [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM). - -## EXAMPLES - -### Example 1: Create a connected kubernetes. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command creates a connected kubernetes. - -### Example 2: Create a connected kubernetes with parameters kubeConfig and kubeContext. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command creates a connected kubernetes with parameters kubeConfig and kubeContext. - -### Example 3: Create a ConnectedKubernetes's AzureHybridBenefit. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -``` - -```output -I confirm I have an eligible Windows Server license with Azure Hybrid Benefit to apply this benefit to AKS on Azure Stack HCI or Windows Server. Visit https://aka.ms/ahb-aks for details. -[Y] Yes [N] No (default is "N"): Y - -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -Create a ConnectedKubernetes's AzureHybridBenefit. - -### Example 4: Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and create a connected kubernetes. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -AcceptEULA -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and create a connected kubernetes. - -### Example 5: Create a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy and Proxy. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -This command creates a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy and Proxy. - -### Example 6: Create a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy, Proxy and ProxyCredential. -```powershell -$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force -$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) -New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -This command creates a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy, Proxy and ProxyCredential. - -### Example 7: Create a connected kubernetes and disable auto upgrade of arc agents. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command creates a connected kubernetes and disable auto upgrade of arc agents. - -### Example 8: Create a connected kubernetes with custom onboarding timeout. -```powershell -New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command creates a connected kubernetes with custom onboarding timeout. - -## PARAMETERS - -### -AcceptEULA -Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureHybridBenefit -Indicates whether Azure Hybrid Benefit is opted in - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -The name of the Kubernetes cluster on which get is called. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerLogPath -Override the default container log path to enable fluent-bit logging. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgrade -Flag to disable auto upgrade of arc agents. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Distribution -The Kubernetes distribution running on this connected cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionVersion -The Kubernetes distribution version on this connected cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpProxy -The http URI of the proxy server for the kubernetes cluster to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsProxy -The https URI of the proxy server for the kubernetes cluster to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Infrastructure -The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KubeConfig -Path to the kube config file - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KubeContext -Kubconfig context from current machine - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The geo-location where the resource lives - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoProxy -The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnboardingTimeout -The time required (in seconds) for the arc-agent pods to be installed on the kubernetes cluster. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateLinkScopeResourceId -The resource id of the private link scope this connected cluster is assigned to, if any. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateLinkState -Property which describes the state of private link on a connected cluster resource. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvisioningState -Provisioning state of the connected cluster resource. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCert -The path to the certificate file for proxy or custom Certificate Authority. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster - -## NOTES - -ALIASES - -## RELATED LINKS - diff --git a/src/ConnectedKubernetes/docs/Remove-AzConnectedKubernetes.md b/src/ConnectedKubernetes/docs/Remove-AzConnectedKubernetes.md deleted file mode 100644 index 69854a4a6b4e..000000000000 --- a/src/ConnectedKubernetes/docs/Remove-AzConnectedKubernetes.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: -Module Name: Az.ConnectedKubernetes -online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/remove-azconnectedkubernetes -schema: 2.0.0 ---- - -# Remove-AzConnectedKubernetes - -## SYNOPSIS -Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM). - -## SYNTAX - -### Delete (Default) -``` -Remove-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-KubeConfig ] [-KubeContext ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzConnectedKubernetes -InputObject [-KubeConfig ] - [-KubeContext ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM). - -## EXAMPLES - -### Example 1: Remove a connected kubernetes. -```powershell -Remove-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -``` - -This command removes a connected kubernetes. - -### Example 2: Remove a connected kubernetes by object. -```powershell -Get-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group | Remove-AzConnectedKubernetes -``` - -This command removes a connected kubernetes by object. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -The name of the Kubernetes cluster on which get is called. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KubeConfig -Path to the kube config file - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KubeContext -Kubconfig context from current machine - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ClusterName ]`: The name of the Kubernetes cluster on which get is called. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - -## RELATED LINKS - diff --git a/src/ConnectedKubernetes/docs/Update-AzConnectedKubernetes.md b/src/ConnectedKubernetes/docs/Update-AzConnectedKubernetes.md deleted file mode 100644 index 7bd5ceca63ee..000000000000 --- a/src/ConnectedKubernetes/docs/Update-AzConnectedKubernetes.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: -Module Name: Az.ConnectedKubernetes -online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/update-azconnectedkubernetes -schema: 2.0.0 ---- - -# Update-AzConnectedKubernetes - -## SYNOPSIS -API to update certain properties of the connected cluster resource - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-AcceptEULA] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzConnectedKubernetes -InputObject [-AcceptEULA] - [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] - [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -API to update certain properties of the connected cluster resource - -## EXAMPLES - -### Example 1: Update a connected kubernetes. -```powershell -Update-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Tag @{'key'='1'} -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command updates a connected kubernetes. - -### Example 2: Update a connected kubernetes by object. -```powershell -Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group | Update-AzConnectedKubernetes -Tag @{'key'='2'} -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster azps_test_group -``` - -This command updates a connected kubernetes by object. - -### Example 3: Update a ConnectedKubernetes's AzureHybridBenefit. -```powershell -Update-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Tag @{'key'='1'} -AzureHybridBenefit 'True' -``` - -```output -I confirm I have an eligible Windows Server license with Azure Hybrid Benefit to apply this benefit to AKS on Azure Stack HCI or Windows Server. Visit https://aka.ms/ahb-aks for details. -[Y] Yes [N] No (default is "N"): y - -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -Update a ConnectedKubernetes's AzureHybridBenefit. - -### Example 4: Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and update a ConnectedKubernetes's AzureHybridBenefit. -```powershell -Update-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Tag @{'key'='1'} -AzureHybridBenefit 'True' -AcceptEULA -``` - -```output -Location Name ResourceGroupName --------- ---- ----------------- -eastus azps_test_cluster_ahb azps_test_group -``` - -Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and update a ConnectedKubernetes's AzureHybridBenefit. - -## PARAMETERS - -### -AcceptEULA -Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureHybridBenefit -Indicates whether Azure Hybrid Benefit is opted in - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -The name of the Kubernetes cluster on which get is called. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Distribution -Represents the distribution of the connected cluster - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionVersion -Represents the Kubernetes distribution version on this connected cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ClusterName ]`: The name of the Kubernetes cluster on which get is called. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - -## RELATED LINKS - diff --git a/src/ConnectedKubernetes/exports/New-AzConnectedKubernetes.ps1 b/src/ConnectedKubernetes/exports/New-AzConnectedKubernetes.ps1 index d2c45105a561..358b73d93cd3 100644 --- a/src/ConnectedKubernetes/exports/New-AzConnectedKubernetes.ps1 +++ b/src/ConnectedKubernetes/exports/New-AzConnectedKubernetes.ps1 @@ -27,6 +27,16 @@ New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' .Example New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -AcceptEULA +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" +.Example +$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force +$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 .Outputs Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster @@ -58,6 +68,48 @@ param( # The ID of the target subscription. ${SubscriptionId}, + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Uri] + # The http URI of the proxy server for the kubernetes cluster to use + ${HttpProxy}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Uri] + # The https URI of the proxy server for the kubernetes cluster to use + ${HttpsProxy}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.String] + # The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use + ${NoProxy}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.String] + # The path to the certificate file for proxy or custom Certificate Authority. + ${ProxyCert}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Int32] + # The time required (in seconds) for the arc-agent pods to be installed on the kubernetes cluster. + ${OnboardingTimeout}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Management.Automation.SwitchParameter] + # Flag to disable auto upgrade of arc agents. + ${DisableAutoUpgrade}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.String] + # Override the default container log path to enable fluent-bit logging. + ${ContainerLogPath}, + [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] @@ -177,14 +229,14 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Uri] - # The URI for the proxy server to use + # The URI of the proxy server for host os to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Management.Automation.PSCredential] - # Credentials for a proxy server to use for the remote call + # The credential of the proxy server for host os to use ${ProxyCredential}, [Parameter(DontShow)] diff --git a/src/ConnectedKubernetes/exports/ProxyCmdletDefinitions.ps1 b/src/ConnectedKubernetes/exports/ProxyCmdletDefinitions.ps1 index c3949005cf92..90ed54d0fa3b 100644 --- a/src/ConnectedKubernetes/exports/ProxyCmdletDefinitions.ps1 +++ b/src/ConnectedKubernetes/exports/ProxyCmdletDefinitions.ps1 @@ -418,6 +418,16 @@ New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' .Example New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -AcceptEULA +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" +.Example +$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force +$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 .Outputs Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster @@ -449,6 +459,48 @@ param( # The ID of the target subscription. ${SubscriptionId}, + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Uri] + # The http URI of the proxy server for the kubernetes cluster to use + ${HttpProxy}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Uri] + # The https URI of the proxy server for the kubernetes cluster to use + ${HttpsProxy}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.String] + # The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use + ${NoProxy}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.String] + # The path to the certificate file for proxy or custom Certificate Authority. + ${ProxyCert}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Int32] + # The time required (in seconds) for the arc-agent pods to be installed on the kubernetes cluster. + ${OnboardingTimeout}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.Management.Automation.SwitchParameter] + # Flag to disable auto upgrade of arc agents. + ${DisableAutoUpgrade}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [System.String] + # Override the default container log path to enable fluent-bit logging. + ${ContainerLogPath}, + [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] @@ -568,14 +620,14 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Uri] - # The URI for the proxy server to use + # The URI of the proxy server for host os to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Management.Automation.PSCredential] - # Credentials for a proxy server to use for the remote call + # The credential of the proxy server for host os to use ${ProxyCredential}, [Parameter(DontShow)] diff --git a/src/ConnectedKubernetes/exports/README.md b/src/ConnectedKubernetes/exports/README.md index db1e09eb1ab8..c6b2610251bd 100644 --- a/src/ConnectedKubernetes/exports/README.md +++ b/src/ConnectedKubernetes/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.ConnectedKubernetes`. No other cmdlets in this repository are directly exported. What that means is the `Az.ConnectedKubernetes` module will run [Export-ModuleMember](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/export-modulemember) on the cmldets in this directory. The cmdlets in this directory are generated at **build-time**. Do not put any custom code, files, cmdlets, etc. into this directory. Please use `..\custom` for all custom implementation. +This directory contains the cmdlets *exported by* `Az.ConnectedKubernetes`. No other cmdlets in this repository are directly exported. What that means is the `Az.ConnectedKubernetes` module will run [Export-ModuleMember](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/export-modulemember) on the cmldets in this directory. The cmdlets in this directory are generated at **build-time**. Do not put any custom code, files, cmdlets, etc. into this directory. Please use `..\custom` for all custom implementation. ## Info - Modifiable: no diff --git a/src/ConnectedKubernetes/generate-info.json b/src/ConnectedKubernetes/generate-info.json index 495562e70aae..ae2df273c1e9 100644 --- a/src/ConnectedKubernetes/generate-info.json +++ b/src/ConnectedKubernetes/generate-info.json @@ -1,8 +1,8 @@ { - "swagger_commit": "3ce1e043e2d0e57016437a3870f40e33da8a6397", + "swagger_commit": "b6cdb7f08d2a553d7a16996010511ec278ffbe4d", "node": "v14.15.5", "autorest": "`-- (empty)", - "autorest_core": "3.9.3", + "autorest_core": "3.9.4", "autorest_modelerfour": "4.15.414", "autorest_powershell": "3.0.498" } diff --git a/src/ConnectedKubernetes/help/New-AzConnectedKubernetes.md b/src/ConnectedKubernetes/help/New-AzConnectedKubernetes.md index 71330a3d191e..0c2bf28dca13 100644 --- a/src/ConnectedKubernetes/help/New-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/help/New-AzConnectedKubernetes.md @@ -14,8 +14,10 @@ API to register a new Kubernetes cluster and create a tracked resource in Azure ``` New-AzConnectedKubernetes -ClusterName -ResourceGroupName -Location - [-SubscriptionId ] [-AcceptEULA] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-KubeConfig ] [-KubeContext ] + [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] + [-OnboardingTimeout ] [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] + [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] + [-Infrastructure ] [-KubeConfig ] [-KubeContext ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] @@ -81,6 +83,60 @@ eastus azps_test_cluster_ahb azps_test_group Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and create a connected kubernetes. +### Example 5: Create a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy and Proxy. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +This command creates a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy and Proxy. + +### Example 6: Create a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy, Proxy and ProxyCredential. +```powershell +$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force +$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +This command creates a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy, Proxy and ProxyCredential. + +### Example 7: Create a connected kubernetes and disable auto upgrade of arc agents. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command creates a connected kubernetes and disable auto upgrade of arc agents. + +### Example 8: Create a connected kubernetes with custom onboarding timeout. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command creates a connected kubernetes with custom onboarding timeout. + ## PARAMETERS ### -AcceptEULA @@ -143,6 +199,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContainerLogPath +Override the default container log path to enable fluent-bit logging. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. @@ -158,6 +229,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DisableAutoUpgrade +Flag to disable auto upgrade of arc agents. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Distribution The Kubernetes distribution running on this connected cluster. @@ -188,6 +274,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HttpProxy +The http URI of the proxy server for the kubernetes cluster to use + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsProxy +The https URI of the proxy server for the kubernetes cluster to use + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Infrastructure The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. @@ -248,6 +364,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoProxy +The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -263,6 +394,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OnboardingTimeout +The time required (in seconds) for the arc-agent pods to be installed on the kubernetes cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PrivateLinkScopeResourceId The resource id of the private link scope this connected cluster is assigned to, if any. @@ -308,6 +454,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProxyCert +The path to the certificate file for proxy or custom Certificate Authority. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/ConnectedKubernetes/how-to.md b/src/ConnectedKubernetes/how-to.md index eb34578097b6..7bd16a08db0c 100644 --- a/src/ConnectedKubernetes/how-to.md +++ b/src/ConnectedKubernetes/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder. ## Packing `Az.ConnectedKubernetes` -To pack `Az.ConnectedKubernetes` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. +To pack `Az.ConnectedKubernetes` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.ConnectedKubernetes`. diff --git a/src/ConnectedKubernetes/internal/New-AzConnectedKubernetes.ps1 b/src/ConnectedKubernetes/internal/New-AzConnectedKubernetes.ps1 index db9e44e07293..740183d1c914 100644 --- a/src/ConnectedKubernetes/internal/New-AzConnectedKubernetes.ps1 +++ b/src/ConnectedKubernetes/internal/New-AzConnectedKubernetes.ps1 @@ -27,6 +27,16 @@ New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' .Example New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -AcceptEULA +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" +.Example +$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force +$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 .Outputs Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster diff --git a/src/ConnectedKubernetes/internal/ProxyCmdletDefinitions.ps1 b/src/ConnectedKubernetes/internal/ProxyCmdletDefinitions.ps1 index 94883d6a1adb..50236cf8551b 100644 --- a/src/ConnectedKubernetes/internal/ProxyCmdletDefinitions.ps1 +++ b/src/ConnectedKubernetes/internal/ProxyCmdletDefinitions.ps1 @@ -136,6 +136,16 @@ New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' .Example New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -AcceptEULA +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" +.Example +$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force +$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade +.Example +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 .Outputs Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster diff --git a/src/ConnectedKubernetes/internal/README.md b/src/ConnectedKubernetes/internal/README.md index 9dd3e314b708..ac51bce894b0 100644 --- a/src/ConnectedKubernetes/internal/README.md +++ b/src/ConnectedKubernetes/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.ConnectedKubernetes.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.ConnectedKubernetes`. Instead, this sub-module is imported by the `..\custom\Az.ConnectedKubernetes.custom.psm1` module, allowing you to use hidden cmdlets in your custom, exposed cmdlets. To call these cmdlets in your custom scripts, simply use [module-qualified calls](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_command_precedence?view=powershell-6#qualified-names). For example, `Az.ConnectedKubernetes.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.ConnectedKubernetes.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.ConnectedKubernetes`. Instead, this sub-module is imported by the `..\custom\Az.ConnectedKubernetes.custom.psm1` module, allowing you to use hidden cmdlets in your custom, exposed cmdlets. To call these cmdlets in your custom scripts, simply use [module-qualified calls](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_command_precedence?view=powershell-6#qualified-names). For example, `Az.ConnectedKubernetes.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose This allows you to include REST specifications for services that you *do not wish to expose from your module*, but simply want to call within custom cmdlets. For example, if you want to make a custom cmdlet that uses `Storage` services, you could include a simplified `Storage` REST specification that has only the operations you need. When you run the generator and build this module, note the generated `Storage` cmdlets. Then, in your readme configuration, use [cmdlet hiding](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md#cmdlet-hiding-exportation-suppression) on the `Storage` cmdlets and they will *only be exposed to the custom cmdlets* you want to write, and not be exported as part of `Az.ConnectedKubernetes`.