From 9203dc38232542cf039cec9bc495c3475baf5d11 Mon Sep 17 00:00:00 2001 From: Jinpei Li Date: Sun, 13 Apr 2025 17:31:50 +0800 Subject: [PATCH] Az.ConnectedKubernetes update generation tool version: autorest.powershell v3->v4 --- .../Properties/AssemblyInfo.cs | 32 ++ .../ConnectedKubernetes.Autorest/README.md | 14 +- .../custom/New-AzConnectedKubernetes.ps1 | 91 ++++- .../custom/Set-AzConnectedKubernetes.ps1 | 120 +++--- .../custom/Update-AzConnectedKubernetes.ps1 | 56 ++- .../custom/helpers/UtilsHelper.ps1 | 4 +- .../docs/Az.ConnectedKubernetes.md | 2 +- .../docs/Get-AzConnectedKubernetes.md | 3 +- ...Get-AzConnectedKubernetesUserCredential.md | 56 ++- .../docs/New-AzConnectedKubernetes.md | 163 +++++++- .../docs/Set-AzConnectedKubernetes.md | 341 ++++++++++------- .../docs/Update-AzConnectedKubernetes.md | 75 +++- .../generate-info.json | 2 +- .../resources/README.md | 11 + .../ConnectedKubernetes.sln | 89 ++++- .../Az.ConnectedKubernetes.psd1 | 12 +- .../ConnectedKubernetes/ChangeLog.md | 1 + .../help/Get-AzConnectedKubernetes.md | 3 +- ...Get-AzConnectedKubernetesUserCredential.md | 57 ++- .../help/New-AzConnectedKubernetes.md | 166 +++++++- .../help/Set-AzConnectedKubernetes.md | 353 +++++++++++------- .../help/Update-AzConnectedKubernetes.md | 77 +++- 22 files changed, 1264 insertions(+), 464 deletions(-) create mode 100644 src/ConnectedKubernetes/ConnectedKubernetes.Autorest/Properties/AssemblyInfo.cs create mode 100644 src/ConnectedKubernetes/ConnectedKubernetes.Autorest/resources/README.md diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/Properties/AssemblyInfo.cs b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..22e6f3365e1c --- /dev/null +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,32 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - ConnectedKubernetes")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.14.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.14.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] + + + + + + diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/README.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/README.md index fbe518c45ada..8f27e90ee067 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/README.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/README.md @@ -54,21 +54,17 @@ title: ConnectedKubernetes module-version: 0.1.0 subject-prefix: $(service-name) -identity-correction-for-post: true -resourcegroup-append: true -nested-object-to-string: true - -# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option -use-extension: - "@autorest/powershell": "3.x" - directive: - where: subject: ^ConnectedCluster(.*) set: subject: $1 - where: - variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ + variant: ^(Create|Update)(?!.*?(Expanded)) + subject-prefix: ConnectedKubernetes + remove: true + - where: + variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$ subject-prefix: ConnectedKubernetes remove: true - where: diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/New-AzConnectedKubernetes.ps1 b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/New-AzConnectedKubernetes.ps1 index 39f567be07e7..1abfeeaeaa01 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/New-AzConnectedKubernetes.ps1 +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/New-AzConnectedKubernetes.ps1 @@ -28,13 +28,13 @@ New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps New-AzConnectedKubernetes -ClusterName azps_test_cluster1 -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 .Outputs -Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster .Link https://learn.microsoft.com/powershell/module/az.connectedkubernetes/new-azconnectedkubernetes #> function New-AzConnectedKubernetes { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster])] - [CmdletBinding(DefaultParameterSetName = 'CreateExpanded', SupportsShouldProcess, PositionalBinding = $false, ConfirmImpact = 'Medium')] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster])] + [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Justification = 'Code published before this issue was identified')] param( @@ -54,7 +54,7 @@ function New-AzConnectedKubernetes { [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.DefaultInfo(Script = '(Get-AzContext).Subscription.Id')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The ID of the target subscription. ${SubscriptionId}, @@ -77,6 +77,46 @@ function New-AzConnectedKubernetes { # The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use ${NoProxy}, + [Parameter()] + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String[]] + # The list of AAD group object IDs that will have admin role of the cluster. + ${AadProfileAdminGroupObjectID}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.Management.Automation.SwitchParameter] + # Whether to enable Azure RBAC for Kubernetes authorization. + ${AadProfileEnableAzureRbac}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String] + # The AAD tenant ID to use for authentication. + # If not specified, will use the tenant of the deployment subscription. + ${AadProfileTenantId}, + + [Parameter()] + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IAgentError[]] + # List of arc agentry and system components errors on the cluster resource. + ${ArcAgentProfileAgentError}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String] + # Version of the Arc agents to be installed on the cluster resource + ${ArcAgentProfileDesiredAgentVersion}, + + [Parameter()] + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ISystemComponent[]] + # List of system extensions that are installed on the cluster resource. + ${ArcAgentProfileSystemComponent}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] [System.String] @@ -121,9 +161,9 @@ function New-AzConnectedKubernetes { ${Location}, [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit])] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("True", "False", "NotApplicable")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit] + [System.String] # Indicates whether Azure Hybrid Benefit is opted in ${AzureHybridBenefit}, @@ -138,36 +178,56 @@ function New-AzConnectedKubernetes { [System.String] # The Kubernetes distribution version on this connected cluster. ${DistributionVersion}, - + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.Management.Automation.SwitchParameter] + # Determines whether to enable a system-assigned identity for the resource. + ${EnableSystemAssignedIdentity}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.Management.Automation.SwitchParameter] + # Indicates whether the gateway for arc router connectivity is enabled. + ${GatewayEnabled}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] # The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. ${Infrastructure}, + [Parameter(ParameterSetName='CreateExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("ProvisionedCluster")] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String] + # The kind of connected cluster. + ${Kind}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] + # This is populated only if privateLinkState is enabled. # The resource id of the private link scope this connected cluster is assigned to, if any. ${PrivateLinkScopeResourceId}, [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState])] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("Enabled", "Disabled")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState] + [System.String] # Property which describes the state of private link on a connected cluster resource. ${PrivateLinkState}, [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState])] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState] + [System.String] # Provisioning state of the connected cluster resource. ${ProvisioningState}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.Info(PossibleTypes = ([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20.ITrackedResourceTags]))] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ITrackedResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, @@ -206,7 +266,8 @@ function New-AzConnectedKubernetes { [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Azure')] [System.Management.Automation.PSObject] - # The credentials, account, tenant, and subscription used for communication with Azure. + # The DefaultProfile parameter is not functional. + # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ${DefaultProfile}, [Parameter()] @@ -244,14 +305,14 @@ function New-AzConnectedKubernetes { [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Uri] - # The URI of the proxy server for host os to use + # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Management.Automation.PSCredential] - # The credential of the proxy server for host os to use + # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Set-AzConnectedKubernetes.ps1 b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Set-AzConnectedKubernetes.ps1 index 6d343784b778..8e88e3222bd9 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Set-AzConnectedKubernetes.ps1 +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Set-AzConnectedKubernetes.ps1 @@ -28,7 +28,7 @@ Set-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps Set-AzConnectedKubernetes -ClusterName azps_test_cluster1 -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -DisableGateway .Outputs -Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster .Notes COMPLEX PARAMETER PROPERTIES @@ -79,8 +79,8 @@ INPUTOBJECT : https://learn.microsoft.com/powershell/module/az.connectedkubernetes/set-azconnectedkubernetes #> function Set-AzConnectedKubernetes { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster])] - [CmdletBinding(DefaultParameterSetName = 'SetExpanded', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster])] + [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Justification = 'Code published before this issue was identified')] param( @@ -114,68 +114,81 @@ function Set-AzConnectedKubernetes { [Parameter(ParameterSetName = 'SetDisableGateway', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName = 'SetEnableGateway', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster] ${InputObject}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.DefaultInfo(Script = '(Get-AzContext).Subscription.Id')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The ID of the target subscription. ${SubscriptionId}, + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.Nullable[System.Boolean]] + # Determines whether to enable a system-assigned identity for the resource. + ${EnableSystemAssignedIdentity}, + [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] - [System.Uri] - # The http URI of the proxy server for the kubernetes cluster to use - ${HttpProxy}, + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String[]] + # The list of AAD group object IDs that will have admin role of the cluster. + ${AadProfileAdminGroupObjectID}, [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] - [System.Uri] - # The https URI of the proxy server for the kubernetes cluster to use - ${HttpsProxy}, + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.Management.Automation.SwitchParameter] + # Whether to enable Azure RBAC for Kubernetes authorization. + ${AadProfileEnableAzureRbac}, [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] - # The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use - ${NoProxy}, + # The AAD tenant ID to use for authentication. + # If not specified, will use the tenant of the deployment subscription. + ${AadProfileTenantId}, [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("Enabled", "Disabled")] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] - # The path to the certificate file for proxy or custom Certificate Authority. - ${ProxyCert}, + # Indicates whether the Arc agents on the be upgraded automatically to the latest version. + # Defaults to Enabled. + ${ArcAgentProfileAgentAutoUpgrade}, [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] - [System.Management.Automation.SwitchParameter] - # Flag to disable auto upgrade of arc agents. - ${DisableAutoUpgrade}, + [AllowEmptyCollection()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IAgentError[]] + # List of arc agentry and system components errors on the cluster resource. + ${ArcAgentProfileAgentError}, [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] - # Override the default container log path to enable fluent-bit logging. - ${ContainerLogPath}, + # Version of the Arc agents to be installed on the cluster resource + ${ArcAgentProfileDesiredAgentVersion}, - [Parameter(HelpMessage = "Path to the kube config file")] + [Parameter()] + [AllowEmptyCollection()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [System.String] - # Path to the kube config file - ${KubeConfig}, + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ISystemComponent[]] + # List of system extensions that are installed on the cluster resource. + ${ArcAgentProfileSystemComponent}, - [Parameter(HelpMessage = "Kubconfig context from current machine")] + [Parameter()] + [AllowEmptyCollection()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [System.String] - # Kubconfig context from current machine - ${KubeContext}, + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IArcAgentryConfigurations[]] + # Configuration settings for customizing the behavior of the connected cluster. + ${ArcAgentryConfiguration}, [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit])] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("True", "False", "NotApplicable")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit] + [System.String] # Indicates whether Azure Hybrid Benefit is opted in ${AzureHybridBenefit}, @@ -191,35 +204,49 @@ function Set-AzConnectedKubernetes { # The Kubernetes distribution version on this connected cluster. ${DistributionVersion}, + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.Management.Automation.SwitchParameter] + # Indicates whether the gateway for arc router connectivity is enabled. + ${GatewayEnabled}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] # The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. ${Infrastructure}, + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("ProvisionedCluster")] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String] + # The kind of connected cluster. + ${Kind}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] + # This is populated only if privateLinkState is enabled. # The resource id of the private link scope this connected cluster is assigned to, if any. ${PrivateLinkScopeResourceId}, [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState])] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("Enabled", "Disabled")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState] + [System.String] # Property which describes the state of private link on a connected cluster resource. ${PrivateLinkState}, [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState])] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState] + [System.String] # Provisioning state of the connected cluster resource. ${ProvisioningState}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.Info(PossibleTypes = ([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20.ITrackedResourceTags]))] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ITrackedResourceTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, @@ -245,7 +272,7 @@ function Set-AzConnectedKubernetes { [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.Management.Automation.SwitchParameter] - # Enable the workload identity Webhook + # Whether to enable or disable the workload identity Webhook ${WorkloadIdentityEnabled}, [Parameter()] @@ -258,7 +285,8 @@ function Set-AzConnectedKubernetes { [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Azure')] [System.Management.Automation.PSObject] - # The credentials, account, tenant, and subscription used for communication with Azure. + # The DefaultProfile parameter is not functional. + # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ${DefaultProfile}, [Parameter()] @@ -296,14 +324,14 @@ function Set-AzConnectedKubernetes { [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Uri] - # The URI of the proxy server for host os to use + # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Runtime')] [System.Management.Automation.PSCredential] - # The credential of the proxy server for host os to use + # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] @@ -838,7 +866,7 @@ function Set-AzConnectedKubernetes { function Merge-MaybeNullInput { [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.DoNotExportAttribute()] param( - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster] $InputObject, [System.Collections.Generic.Dictionary[system.String, System.Object]] $LclPSBoundParameters diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Update-AzConnectedKubernetes.ps1 b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Update-AzConnectedKubernetes.ps1 index 8eef8b124fb9..16d4976ab200 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Update-AzConnectedKubernetes.ps1 +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/Update-AzConnectedKubernetes.ps1 @@ -28,7 +28,7 @@ Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps .Inputs Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity .Outputs -Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster .Notes COMPLEX PARAMETER PROPERTIES @@ -43,41 +43,47 @@ INPUTOBJECT : Identity Parameter https://learn.microsoft.com/powershell/module/az.connectedkubernetes/update-azconnectedkubernetes #> function Update-AzConnectedKubernetes { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster])] - [CmdletBinding(DefaultParameterSetName = 'UpdateExpanded', PositionalBinding = $false, ConfirmImpact = 'Medium', SupportsShouldProcess)] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster])] + [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( - [Parameter(ParameterSetName = 'UpdateExpanded', Mandatory)] + [Parameter(ParameterSetName='UpdateExpanded', Mandatory)] + [Parameter(ParameterSetName='UpdateViaJsonFilePath', Mandatory)] + [Parameter(ParameterSetName='UpdateViaJsonString', Mandatory)] [Alias('Name')] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] [System.String] # The name of the Kubernetes cluster on which get is called. ${ClusterName}, - [Parameter(ParameterSetName = 'UpdateExpanded', Mandatory)] + [Parameter(ParameterSetName='UpdateExpanded', Mandatory)] + [Parameter(ParameterSetName='UpdateViaJsonFilePath', Mandatory)] + [Parameter(ParameterSetName='UpdateViaJsonString', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] [System.String] # The name of the resource group. # The name is case insensitive. ${ResourceGroupName}, - [Parameter(ParameterSetName = 'UpdateExpanded')] + [Parameter(ParameterSetName='UpdateExpanded')] + [Parameter(ParameterSetName='UpdateViaJsonFilePath')] + [Parameter(ParameterSetName='UpdateViaJsonString')] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.DefaultInfo(Script = '(Get-AzContext).Subscription.Id')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The ID of the target subscription. ${SubscriptionId}, - [Parameter(ParameterSetName = 'UpdateViaIdentityExpanded', Mandatory, ValueFromPipeline)] + [Parameter(ParameterSetName='UpdateViaIdentityExpanded', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity] # Identity Parameter - # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, - [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit])] + [Parameter(ParameterSetName='UpdateExpanded')] + [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.PSArgumentCompleterAttribute("True", "False", "NotApplicable")] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit] + [System.String] # Indicates whether Azure Hybrid Benefit is opted in ${AzureHybridBenefit}, @@ -86,31 +92,47 @@ function Update-AzConnectedKubernetes { # Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided ${AcceptEULA}, - [Parameter()] + [Parameter(ParameterSetName='UpdateExpanded')] + [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] # Represents the distribution of the connected cluster ${Distribution}, - [Parameter()] + [Parameter(ParameterSetName='UpdateExpanded')] + [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] [System.String] # Represents the Kubernetes distribution version on this connected cluster. ${DistributionVersion}, - [Parameter()] + [Parameter(ParameterSetName='UpdateExpanded')] + [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.Info(PossibleTypes = ([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedClusterPatchTags]))] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedClusterPatchTags]))] [System.Collections.Hashtable] # Resource tags. ${Tag}, + [Parameter(ParameterSetName='UpdateViaJsonFilePath', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String] + # Path of Json file supplied to the Update operation + ${JsonFilePath}, + + [Parameter(ParameterSetName='UpdateViaJsonString', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Body')] + [System.String] + # Json string supplied to the Update operation + ${JsonString}, + [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Category('Azure')] [System.Management.Automation.PSObject] - # The credentials, account, tenant, and subscription used for communication with Azure. + # The DefaultProfile parameter is not functional. + # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ${DefaultProfile}, [Parameter(DontShow)] diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/helpers/UtilsHelper.ps1 b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/helpers/UtilsHelper.ps1 index fdd89f98d39e..cb91fa964a8a 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/helpers/UtilsHelper.ps1 +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/custom/helpers/UtilsHelper.ps1 @@ -43,7 +43,7 @@ function ConvertTo-ArcAgentryConfiguration { if ($CCRP) { # This ensures that when a new feature is implemented, only the ConfigDP # needs to change and not the Powershell script (or az CLI). - $arcAgentryConfigs = New-Object System.Collections.Generic.List[Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.ArcAgentryConfigurations] + $arcAgentryConfigs = New-Object System.Collections.Generic.List[Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ArcAgentryConfigurations] $combinedKeys = $ConfigurationSetting.Keys } else { @@ -64,7 +64,7 @@ function ConvertTo-ArcAgentryConfiguration { $settings = @{} } if ($CCRP) { - $ArcAgentryConfiguration = [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.ArcAgentryConfigurations]@{ + $ArcAgentryConfiguration = [Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ArcAgentryConfigurations]@{ Feature = $feature Setting = $settings } diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Az.ConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Az.ConnectedKubernetes.md index 95cdb2819574..52bb47bd62de 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Az.ConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Az.ConnectedKubernetes.md @@ -1,6 +1,6 @@ --- Module Name: Az.ConnectedKubernetes -Module Guid: efbb1325-5081-4947-8508-ab47abbf6e76 +Module Guid: 5b973386-ae22-4e1f-84d7-369b3bd2c6cb Download Help Link: https://learn.microsoft.com/powershell/module/az.connectedkubernetes Help Version: 1.0.0.0 Locale: en-US diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetes.md index 38fdc9424858..3161fbee513b 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetes.md @@ -130,7 +130,6 @@ 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 @@ -184,7 +183,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetesUserCredential.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetesUserCredential.md index c196862be489..55b67e1cfcae 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetesUserCredential.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Get-AzConnectedKubernetesUserCredential.md @@ -15,8 +15,8 @@ Gets cluster user credentials of the connected cluster with a specified resource ### ListExpanded (Default) ``` Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName - -AuthenticationMethod -ClientProxy [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + -AuthenticationMethod -ClientProxy [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] ``` ### List @@ -26,6 +26,19 @@ Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName [-Confirm] [-WhatIf] [] ``` +### ListViaJsonFilePath +``` +Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ListViaJsonString +``` +Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Gets cluster user credentials of the connected cluster with a specified resource group and name. @@ -73,7 +86,7 @@ Gets cluster user credentials of the connected cluster with a specified resource The mode of client authentication. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AuthenticationMethod +Type: System.String Parameter Sets: ListExpanded Aliases: @@ -130,12 +143,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +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.Api20240715Preview.IListClusterUserCredentialProperties +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IListClusterUserCredentialProperties Parameter Sets: List Aliases: @@ -213,11 +255,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IListClusterUserCredentialProperties +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IListClusterUserCredentialProperties ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.ICredentialResults +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ICredentialResults ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/New-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/New-AzConnectedKubernetes.md index 14ebf3b6111d..313f0de80396 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/New-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/New-AzConnectedKubernetes.md @@ -15,12 +15,15 @@ API to register a new Kubernetes cluster and create a tracked resource in Azure ``` New-AzConnectedKubernetes -ClusterName -ResourceGroupName -Location [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-OnboardingTimeout ] [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] - [-AzureHybridBenefit ] [-CustomLocationsOid ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-KubeConfig ] [-KubeContext ] - [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] + [-OnboardingTimeout ] [-ProxyCert ] [-SubscriptionId ] + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-AcceptEULA] [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] [-AzureHybridBenefit ] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] + [-EnableSystemAssignedIdentity] [-GatewayEnabled] [-Infrastructure ] [-Kind ] + [-KubeConfig ] [-KubeContext ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] [-GatewayResourceId ] [-NoWait] [-Confirm] [-WhatIf] [] @@ -142,6 +145,52 @@ This command creates a connected kubernetes with custom onboarding timeout. ## PARAMETERS +### -AadProfileAdminGroupObjectID +The list of AAD group object IDs that will have admin role of the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadProfileEnableAzureRbac +Whether to enable Azure RBAC for Kubernetes authorization. + +```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 +``` + +### -AadProfileTenantId +The AAD tenant ID to use for authentication. +If not specified, will use the tenant of the deployment subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AcceptEULA Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided @@ -157,6 +206,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ArcAgentProfileAgentError +List of arc agentry and system components errors on the cluster resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IAgentError[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcAgentProfileDesiredAgentVersion +Version of the Arc agents to be installed on the cluster resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcAgentProfileSystemComponent +List of system extensions that are installed on the cluster resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ISystemComponent[] +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 @@ -176,7 +270,7 @@ Accept wildcard characters: False Indicates whether Azure Hybrid Benefit is opted in ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit +Type: System.String Parameter Sets: (All) Aliases: @@ -263,7 +357,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -322,6 +417,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```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 +``` + +### -GatewayEnabled +Indicates whether the gateway for arc router connectivity is enabled. + +```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 +``` + ### -GatewayResourceId Arc Gateway resource Id @@ -382,6 +507,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Kind +The kind of 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 +``` + ### -KubeConfig Path to the kube config file @@ -503,6 +643,7 @@ Accept wildcard characters: False ``` ### -PrivateLinkScopeResourceId +This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any. ```yaml @@ -521,7 +662,7 @@ Accept wildcard characters: False Property which describes the state of private link on a connected cluster resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState +Type: System.String Parameter Sets: (All) Aliases: @@ -536,7 +677,7 @@ Accept wildcard characters: False Provisioning state of the connected cluster resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState +Type: System.String Parameter Sets: (All) Aliases: @@ -661,7 +802,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Set-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Set-AzConnectedKubernetes.md index 1146bdcf0a68..bccb42c36894 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Set-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Set-AzConnectedKubernetes.md @@ -14,84 +14,98 @@ API to set properties of the connected cluster resource ### SetExpanded (Default) ``` -Set-AzConnectedKubernetes -ClusterName -ResourceGroupName -Location - [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] [-AzureHybridBenefit ] +Set-AzConnectedKubernetes -ClusterName -ResourceGroupName + -EnableSystemAssignedIdentity -Location [-SubscriptionId ] + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-AcceptEULA] [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] - [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-KubeConfig ] [-KubeContext ] [-OidcIssuerProfileEnabled] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] + [-Infrastructure ] [-Kind ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### Set ``` -Set-AzConnectedKubernetes -InputObject [-ContainerLogPath ] [-DisableAutoUpgrade] - [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] [-ProxyCert ] [-SubscriptionId ] - [-AcceptEULA] [-AzureHybridBenefit ] [-ConfigurationProtectedSetting ] - [-ConfigurationSetting ] [-CustomLocationsOid ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-KubeConfig ] [-KubeContext ] - [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] +Set-AzConnectedKubernetes -EnableSystemAssignedIdentity -InputObject + [-SubscriptionId ] [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] + [-AadProfileTenantId ] [-AcceptEULA] [-ArcAgentProfileAgentAutoUpgrade ] + [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] + [-Infrastructure ] [-Kind ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### SetDisableGateway ``` -Set-AzConnectedKubernetes -DisableGateway -InputObject [-ContainerLogPath ] - [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] [-ProxyCert ] - [-SubscriptionId ] [-AcceptEULA] [-AzureHybridBenefit ] +Set-AzConnectedKubernetes -DisableGateway -EnableSystemAssignedIdentity + -InputObject [-SubscriptionId ] [-AadProfileAdminGroupObjectID ] + [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] [-AcceptEULA] + [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] - [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-KubeConfig ] [-KubeContext ] [-OidcIssuerProfileEnabled] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] + [-Infrastructure ] [-Kind ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### SetEnableGateway ``` -Set-AzConnectedKubernetes -GatewayResourceId -InputObject - [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] [-AzureHybridBenefit ] +Set-AzConnectedKubernetes -EnableSystemAssignedIdentity -GatewayResourceId + -InputObject [-SubscriptionId ] [-AadProfileAdminGroupObjectID ] + [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] [-AcceptEULA] + [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] - [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-KubeConfig ] [-KubeContext ] [-OidcIssuerProfileEnabled] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] + [-Infrastructure ] [-Kind ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### SetExpandedDisableGateway ``` -Set-AzConnectedKubernetes -ClusterName -ResourceGroupName -DisableGateway -Location - [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] [-AzureHybridBenefit ] +Set-AzConnectedKubernetes -ClusterName -ResourceGroupName -DisableGateway + -EnableSystemAssignedIdentity -Location [-SubscriptionId ] + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-AcceptEULA] [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] - [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-KubeConfig ] [-KubeContext ] [-OidcIssuerProfileEnabled] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] + [-Infrastructure ] [-Kind ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### SetExpandedEnableGateway ``` -Set-AzConnectedKubernetes -ClusterName -ResourceGroupName -GatewayResourceId - -Location [-ContainerLogPath ] [-DisableAutoUpgrade] [-HttpProxy ] [-HttpsProxy ] - [-NoProxy ] [-ProxyCert ] [-SubscriptionId ] [-AcceptEULA] - [-AzureHybridBenefit ] [-ConfigurationProtectedSetting ] - [-ConfigurationSetting ] [-CustomLocationsOid ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-KubeConfig ] [-KubeContext ] - [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] +Set-AzConnectedKubernetes -ClusterName -ResourceGroupName + -EnableSystemAssignedIdentity -GatewayResourceId -Location + [-SubscriptionId ] [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] + [-AadProfileTenantId ] [-AcceptEULA] [-ArcAgentProfileAgentAutoUpgrade ] + [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-ConfigurationProtectedSetting ] [-ConfigurationSetting ] + [-CustomLocationsOid ] [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] + [-Infrastructure ] [-Kind ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-PrivateLinkScopeResourceId ] + [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] [-WorkloadIdentityEnabled] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` @@ -197,11 +211,11 @@ This command disables workload identity of a connected kubernetes cluster ## PARAMETERS -### -AcceptEULA -Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided +### -AadProfileAdminGroupObjectID +The list of AAD group object IDs that will have admin role of the cluster. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: System.String[] Parameter Sets: (All) Aliases: @@ -212,8 +226,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Run the command as a job +### -AadProfileEnableAzureRbac +Whether to enable Azure RBAC for Kubernetes authorization. ```yaml Type: System.Management.Automation.SwitchParameter @@ -227,11 +241,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AzureHybridBenefit -Indicates whether Azure Hybrid Benefit is opted in +### -AadProfileTenantId +The AAD tenant ID to use for authentication. +If not specified, will use the tenant of the deployment subscription. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit +Type: System.String Parameter Sets: (All) Aliases: @@ -242,26 +257,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClusterName -The name of the Kubernetes cluster on which get is called. +### -AcceptEULA +Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided ```yaml -Type: System.String -Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway -Aliases: Name +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfigurationProtectedSetting -Arc Agentry System Protected Configuration +### -ArcAgentProfileAgentAutoUpgrade +Indicates whether the Arc agents on the be upgraded automatically to the latest version. +Defaults to Enabled. ```yaml -Type: System.Collections.Hashtable +Type: System.String Parameter Sets: (All) Aliases: @@ -272,11 +288,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfigurationSetting -Arc Agentry System Configuration +### -ArcAgentProfileAgentError +List of arc agentry and system components errors on the cluster resource. ```yaml -Type: System.Collections.Hashtable +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IAgentError[] Parameter Sets: (All) Aliases: @@ -287,8 +303,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ContainerLogPath -Override the default container log path to enable fluent-bit logging. +### -ArcAgentProfileDesiredAgentVersion +Version of the Arc agents to be installed on the cluster resource ```yaml Type: System.String @@ -302,11 +318,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomLocationsOid -OID of 'custom-locations' app. +### -ArcAgentProfileSystemComponent +List of system extensions that are installed on the cluster resource. ```yaml -Type: System.String +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ISystemComponent[] Parameter Sets: (All) Aliases: @@ -317,13 +333,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +### -ArcAgentryConfiguration +Configuration settings for customizing the behavior of the connected cluster. ```yaml -Type: System.Management.Automation.PSObject +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IArcAgentryConfigurations[] Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential +Aliases: Required: False Position: Named @@ -332,8 +348,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAutoUpgrade -Flag to disable auto upgrade of arc agents. +### -AsJob +Run the command as a job ```yaml Type: System.Management.Automation.SwitchParameter @@ -347,26 +363,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableGateway - +### -AzureHybridBenefit +Indicates whether Azure Hybrid Benefit is opted in ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetDisableGateway, SetExpandedDisableGateway +Type: System.String +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Distribution -The Kubernetes distribution running on this connected cluster. +### -ClusterName +The name of the Kubernetes cluster on which get is called. ```yaml Type: System.String +Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Arc Agentry System Protected Configuration + +```yaml +Type: System.Collections.Hashtable Parameter Sets: (All) Aliases: @@ -377,11 +408,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionVersion -The Kubernetes distribution version on this connected cluster. +### -ConfigurationSetting +Arc Agentry System Configuration ```yaml -Type: System.String +Type: System.Collections.Hashtable Parameter Sets: (All) Aliases: @@ -392,28 +423,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayResourceId -Arc Gateway resource Id, providing this will enable the gateway +### -CustomLocationsOid +OID of 'custom-locations' app. ```yaml Type: System.String -Parameter Sets: SetEnableGateway, SetExpandedEnableGateway +Parameter Sets: (All) Aliases: -Required: True +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 +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: System.Uri +Type: System.Management.Automation.PSObject Parameter Sets: (All) -Aliases: +Aliases: AzureRMContext, AzureCredential Required: False Position: Named @@ -422,11 +454,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpsProxy -The https URI of the proxy server for the kubernetes cluster to use +### -DisableGateway + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetDisableGateway, SetExpandedDisableGateway +Aliases: + +Required: True +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.Uri +Type: System.String Parameter Sets: (All) Aliases: @@ -437,8 +484,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Infrastructure -The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. +### -DistributionVersion +The Kubernetes distribution version on this connected cluster. ```yaml Type: System.String @@ -452,26 +499,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster -Parameter Sets: Set, SetDisableGateway, SetEnableGateway +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -KubeConfig -Path to the kube config file +### -GatewayEnabled +Indicates whether the gateway for arc router connectivity is enabled. ```yaml -Type: System.String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -482,8 +529,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KubeContext -Kubconfig context from current machine +### -GatewayResourceId +Arc Gateway resource Id, providing this will enable the gateway + +```yaml +Type: System.String +Parameter Sets: SetEnableGateway, SetExpandedEnableGateway +Aliases: + +Required: True +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 @@ -497,23 +559,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Location -The geo-location where the resource lives +### -InputObject + ```yaml -Type: System.String -Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster +Parameter Sets: Set, SetDisableGateway, SetEnableGateway Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) 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 +### -Kind +The kind of connected cluster. ```yaml Type: System.String @@ -527,6 +589,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -573,6 +650,7 @@ Accept wildcard characters: False ``` ### -PrivateLinkScopeResourceId +This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any. ```yaml @@ -591,7 +669,7 @@ Accept wildcard characters: False Property which describes the state of private link on a connected cluster resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState +Type: System.String Parameter Sets: (All) Aliases: @@ -605,21 +683,6 @@ 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) @@ -679,7 +742,7 @@ Accept wildcard characters: False ``` ### -WorkloadIdentityEnabled -Enable the workload identity Webhook +Whether to enable or disable the workload identity Webhook ```yaml Type: System.Management.Automation.SwitchParameter @@ -729,11 +792,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Update-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Update-AzConnectedKubernetes.md index 663f33147f31..add54e290bc9 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Update-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/docs/Update-AzConnectedKubernetes.md @@ -15,16 +15,29 @@ API to update certain properties of the connected cluster resource ### UpdateExpanded (Default) ``` Update-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-AcceptEULA] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] + [-AcceptEULA] [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedKubernetes -InputObject [-AcceptEULA] - [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] - [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzConnectedKubernetes -ClusterName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-AcceptEULA] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Update-AzConnectedKubernetes -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-AcceptEULA] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] ``` ## DESCRIPTION @@ -108,8 +121,8 @@ Accept wildcard characters: False Indicates whether Azure Hybrid Benefit is opted in ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -124,7 +137,7 @@ The name of the Kubernetes cluster on which get is called. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Name Required: True @@ -135,7 +148,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -154,7 +168,7 @@ Represents the distribution of the connected cluster ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -169,7 +183,7 @@ Represents the Kubernetes distribution version on this connected cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -181,7 +195,6 @@ 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 @@ -195,13 +208,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +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: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -216,7 +259,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -231,7 +274,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -281,7 +324,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/generate-info.json b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/generate-info.json index cc5eb60bd359..c8253cebc8ca 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/generate-info.json +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "24497465-e141-4709-bc7e-6d0fb8c455b8" + "generate_Id": "f29daa0d-6315-4b6d-bde7-fcfac0b81b46" } diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/resources/README.md b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/resources/README.md new file mode 100644 index 000000000000..937f07f8fec2 --- /dev/null +++ b/src/ConnectedKubernetes/ConnectedKubernetes.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/ConnectedKubernetes/ConnectedKubernetes.sln b/src/ConnectedKubernetes/ConnectedKubernetes.sln index 00f5bc2b8e6e..48f8e9fe0cf9 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes.sln +++ b/src/ConnectedKubernetes/ConnectedKubernetes.sln @@ -1,4 +1,4 @@ - + Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.0.31903.59 @@ -19,49 +19,119 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accoun EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConnectedKubernetes", "ConnectedKubernetes\ConnectedKubernetes.csproj", "{5BCE9349-D102-48DA-A4CA-58A17607C0B6}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ConnectedKubernetes", "..\..\generated\ConnectedKubernetes\ConnectedKubernetes.Autorest\Az.ConnectedKubernetes.csproj", "{7FC1D43F-F44E-4264-959C-ACA587A60530}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ConnectedKubernetes.Autorest", "ConnectedKubernetes.Autorest", "{8028566A-0C0A-6B49-A1C1-5FB7248E1121}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ConnectedKubernetes", "..\..\generated\ConnectedKubernetes\ConnectedKubernetes.Autorest\Az.ConnectedKubernetes.csproj", "{AD32D372-1D36-4F29-ACA2-772374C75EC5}" 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 - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE + Release|x64 = Release|x64 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {55F04735-EF13-45D3-AD65-59AA13B75569}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {55F04735-EF13-45D3-AD65-59AA13B75569}.Debug|Any CPU.Build.0 = Debug|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Debug|x64.ActiveCfg = Debug|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Debug|x64.Build.0 = Debug|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Debug|x86.ActiveCfg = Debug|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Debug|x86.Build.0 = Debug|Any CPU {55F04735-EF13-45D3-AD65-59AA13B75569}.Release|Any CPU.ActiveCfg = Release|Any CPU {55F04735-EF13-45D3-AD65-59AA13B75569}.Release|Any CPU.Build.0 = Release|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Release|x64.ActiveCfg = Release|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Release|x64.Build.0 = Release|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Release|x86.ActiveCfg = Release|Any CPU + {55F04735-EF13-45D3-AD65-59AA13B75569}.Release|x86.Build.0 = Release|Any CPU {E5DF101F-21C3-4835-847B-8AD78BF42604}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {E5DF101F-21C3-4835-847B-8AD78BF42604}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Debug|x64.ActiveCfg = Debug|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Debug|x64.Build.0 = Debug|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Debug|x86.ActiveCfg = Debug|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Debug|x86.Build.0 = Debug|Any CPU {E5DF101F-21C3-4835-847B-8AD78BF42604}.Release|Any CPU.ActiveCfg = Release|Any CPU {E5DF101F-21C3-4835-847B-8AD78BF42604}.Release|Any CPU.Build.0 = Release|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Release|x64.ActiveCfg = Release|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Release|x64.Build.0 = Release|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Release|x86.ActiveCfg = Release|Any CPU + {E5DF101F-21C3-4835-847B-8AD78BF42604}.Release|x86.Build.0 = Release|Any CPU {58A70274-3BC4-4645-813C-31AA672F05C4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {58A70274-3BC4-4645-813C-31AA672F05C4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Debug|x64.ActiveCfg = Debug|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Debug|x64.Build.0 = Debug|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Debug|x86.ActiveCfg = Debug|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Debug|x86.Build.0 = Debug|Any CPU {58A70274-3BC4-4645-813C-31AA672F05C4}.Release|Any CPU.ActiveCfg = Release|Any CPU {58A70274-3BC4-4645-813C-31AA672F05C4}.Release|Any CPU.Build.0 = Release|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Release|x64.ActiveCfg = Release|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Release|x64.Build.0 = Release|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Release|x86.ActiveCfg = Release|Any CPU + {58A70274-3BC4-4645-813C-31AA672F05C4}.Release|x86.Build.0 = Release|Any CPU {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Debug|x64.ActiveCfg = Debug|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Debug|x64.Build.0 = Debug|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Debug|x86.ActiveCfg = Debug|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Debug|x86.Build.0 = Debug|Any CPU {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Release|Any CPU.ActiveCfg = Release|Any CPU {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Release|Any CPU.Build.0 = Release|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Release|x64.ActiveCfg = Release|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Release|x64.Build.0 = Release|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Release|x86.ActiveCfg = Release|Any CPU + {097E5DD2-9557-4BE0-8B5E-935D85F545C9}.Release|x86.Build.0 = Release|Any CPU {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Debug|Any CPU.Build.0 = Debug|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Debug|x64.ActiveCfg = Debug|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Debug|x64.Build.0 = Debug|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Debug|x86.ActiveCfg = Debug|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Debug|x86.Build.0 = Debug|Any CPU {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Release|Any CPU.ActiveCfg = Release|Any CPU {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Release|Any CPU.Build.0 = Release|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Release|x64.ActiveCfg = Release|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Release|x64.Build.0 = Release|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Release|x86.ActiveCfg = Release|Any CPU + {26A6E1C0-EFEE-4205-9711-5011F2A24BA3}.Release|x86.Build.0 = Release|Any CPU {D668ECB4-A954-41F5-806D-449B28BEB81D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {D668ECB4-A954-41F5-806D-449B28BEB81D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Debug|x64.ActiveCfg = Debug|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Debug|x64.Build.0 = Debug|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Debug|x86.ActiveCfg = Debug|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Debug|x86.Build.0 = Debug|Any CPU {D668ECB4-A954-41F5-806D-449B28BEB81D}.Release|Any CPU.ActiveCfg = Release|Any CPU {D668ECB4-A954-41F5-806D-449B28BEB81D}.Release|Any CPU.Build.0 = Release|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Release|x64.ActiveCfg = Release|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Release|x64.Build.0 = Release|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Release|x86.ActiveCfg = Release|Any CPU + {D668ECB4-A954-41F5-806D-449B28BEB81D}.Release|x86.Build.0 = Release|Any CPU {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Debug|x64.ActiveCfg = Debug|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Debug|x64.Build.0 = Debug|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Debug|x86.ActiveCfg = Debug|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Debug|x86.Build.0 = Debug|Any CPU {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Release|Any CPU.ActiveCfg = Release|Any CPU {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Release|Any CPU.Build.0 = Release|Any CPU - {7FC1D43F-F44E-4264-959C-ACA587A60530}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {7FC1D43F-F44E-4264-959C-ACA587A60530}.Debug|Any CPU.Build.0 = Debug|Any CPU - {7FC1D43F-F44E-4264-959C-ACA587A60530}.Release|Any CPU.ActiveCfg = Release|Any CPU - {7FC1D43F-F44E-4264-959C-ACA587A60530}.Release|Any CPU.Build.0 = Release|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Release|x64.ActiveCfg = Release|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Release|x64.Build.0 = Release|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Release|x86.ActiveCfg = Release|Any CPU + {5BCE9349-D102-48DA-A4CA-58A17607C0B6}.Release|x86.Build.0 = Release|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Debug|x64.ActiveCfg = Debug|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Debug|x64.Build.0 = Debug|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Debug|x86.ActiveCfg = Debug|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Debug|x86.Build.0 = Debug|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Release|Any CPU.Build.0 = Release|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Release|x64.ActiveCfg = Release|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Release|x64.Build.0 = Release|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Release|x86.ActiveCfg = Release|Any CPU + {AD32D372-1D36-4F29-ACA2-772374C75EC5}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE EndGlobalSection GlobalSection(NestedProjects) = preSolution {55F04735-EF13-45D3-AD65-59AA13B75569} = {097FF7BE-1162-47A2-AF4D-F15D32F731F2} @@ -70,5 +140,6 @@ Global {097E5DD2-9557-4BE0-8B5E-935D85F545C9} = {097FF7BE-1162-47A2-AF4D-F15D32F731F2} {26A6E1C0-EFEE-4205-9711-5011F2A24BA3} = {097FF7BE-1162-47A2-AF4D-F15D32F731F2} {D668ECB4-A954-41F5-806D-449B28BEB81D} = {097FF7BE-1162-47A2-AF4D-F15D32F731F2} + {AD32D372-1D36-4F29-ACA2-772374C75EC5} = {8028566A-0C0A-6B49-A1C1-5FB7248E1121} EndGlobalSection EndGlobal diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 b/src/ConnectedKubernetes/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 index 49e2af1888c5..20d8df782f7f 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 +++ b/src/ConnectedKubernetes/ConnectedKubernetes/Az.ConnectedKubernetes.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 1/9/2025 +# Generated on: 2025-04-13 # @{ @@ -51,17 +51,17 @@ DotNetFrameworkVersion = '4.7.2' # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.0.1'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.1.0'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'ConnectedKubernetes.Autorest/bin/Az.ConnectedKubernetes.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = @@ -100,7 +100,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','ConnectedKubernetes' + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'ConnectedKubernetes' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -125,7 +125,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/ChangeLog.md b/src/ConnectedKubernetes/ConnectedKubernetes/ChangeLog.md index aa0605aa89a1..9c81d50e088b 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/ChangeLog.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes/ChangeLog.md @@ -18,6 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release +* Introduced various new features by upgrading code generator. Please see detail [here](https://github.com/Azure/azure-powershell/blob/main/documentation/Autorest-powershell-v4-new-features.md). ## Version 0.14.0 * Upgraded nuget package to signed package. diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetes.md index e71eac216058..3511e13a7300 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetes.md @@ -131,7 +131,6 @@ 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 @@ -185,7 +184,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetesUserCredential.md b/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetesUserCredential.md index 29236a32fb92..382634b3ecac 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetesUserCredential.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes/help/Get-AzConnectedKubernetesUserCredential.md @@ -15,8 +15,8 @@ Gets cluster user credentials of the connected cluster with a specified resource ### ListExpanded (Default) ``` Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName - [-SubscriptionId ] -AuthenticationMethod [-ClientProxy] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] -AuthenticationMethod [-ClientProxy] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### List @@ -26,6 +26,20 @@ Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName [-WhatIf] [-Confirm] [] ``` +### ListViaJsonFilePath +``` +Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ListViaJsonString +``` +Get-AzConnectedKubernetesUserCredential -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION Gets cluster user credentials of the connected cluster with a specified resource group and name. @@ -73,7 +87,7 @@ Gets cluster user credentials of the connected cluster with a specified resource The mode of client authentication. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AuthenticationMethod +Type: System.String Parameter Sets: ListExpanded Aliases: @@ -130,12 +144,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +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.Api20240715Preview.IListClusterUserCredentialProperties +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IListClusterUserCredentialProperties Parameter Sets: List Aliases: @@ -213,11 +256,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IListClusterUserCredentialProperties +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IListClusterUserCredentialProperties ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.ICredentialResults +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ICredentialResults ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/help/New-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes/help/New-AzConnectedKubernetes.md index 8b20dcb33233..7763782def67 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/help/New-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes/help/New-AzConnectedKubernetes.md @@ -15,13 +15,17 @@ API to register a new Kubernetes cluster and create a tracked resource in Azure ``` New-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] [-ProxyCert ] [-OnboardingTimeout ] - [-DisableAutoUpgrade] [-ContainerLogPath ] -Location [-KubeConfig ] - [-KubeContext ] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-WorkloadIdentityEnabled] [-AcceptEULA] [-DefaultProfile ] [-AsJob] [-NoWait] - [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] [-GatewayResourceId ] + [-DisableAutoUpgrade] [-ContainerLogPath ] -Location + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] [-KubeConfig ] [-KubeContext ] + [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] + [-EnableSystemAssignedIdentity] [-GatewayEnabled] [-Infrastructure ] [-Kind ] + [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] [-ProvisioningState ] + [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ConfigurationSetting ] + [-ConfigurationProtectedSetting ] [-GatewayResourceId ] [-WhatIf] [-Confirm] [] ``` @@ -141,6 +145,52 @@ This command creates a connected kubernetes with custom onboarding timeout. ## PARAMETERS +### -AadProfileAdminGroupObjectID +The list of AAD group object IDs that will have admin role of the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadProfileEnableAzureRbac +Whether to enable Azure RBAC for Kubernetes authorization. + +```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 +``` + +### -AadProfileTenantId +The AAD tenant ID to use for authentication. +If not specified, will use the tenant of the deployment subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AcceptEULA Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided @@ -156,6 +206,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ArcAgentProfileAgentError +List of arc agentry and system components errors on the cluster resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IAgentError[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcAgentProfileDesiredAgentVersion +Version of the Arc agents to be installed on the cluster resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcAgentProfileSystemComponent +List of system extensions that are installed on the cluster resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ISystemComponent[] +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 @@ -175,7 +270,7 @@ Accept wildcard characters: False Indicates whether Azure Hybrid Benefit is opted in ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit +Type: System.String Parameter Sets: (All) Aliases: @@ -262,7 +357,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -321,6 +417,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```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 +``` + +### -GatewayEnabled +Indicates whether the gateway for arc router connectivity is enabled. + +```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 +``` + ### -GatewayResourceId Arc Gateway resource Id @@ -381,6 +507,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Kind +The kind of 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 +``` + ### -KubeConfig Path to the kube config file @@ -502,6 +643,7 @@ Accept wildcard characters: False ``` ### -PrivateLinkScopeResourceId +This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any. ```yaml @@ -520,7 +662,7 @@ Accept wildcard characters: False Property which describes the state of private link on a connected cluster resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState +Type: System.String Parameter Sets: (All) Aliases: @@ -535,7 +677,7 @@ Accept wildcard characters: False Provisioning state of the connected cluster resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState +Type: System.String Parameter Sets: (All) Aliases: @@ -660,7 +802,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/help/Set-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes/help/Set-AzConnectedKubernetes.md index 5ef253245f6f..a794d92bb58b 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/help/Set-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes/help/Set-AzConnectedKubernetes.md @@ -15,84 +15,99 @@ API to set properties of the connected cluster resource ### SetExpanded (Default) ``` Set-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] [-ProxyCert ] [-DisableAutoUpgrade] - [-ContainerLogPath ] -Location [-KubeConfig ] [-KubeContext ] - [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] - [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] - [-AcceptEULA] [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -EnableSystemAssignedIdentity -Location [-AadProfileAdminGroupObjectID ] + [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] [-ArcAgentProfileAgentAutoUpgrade ] + [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] [-Infrastructure ] + [-Kind ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] + [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### SetExpandedDisableGateway ``` Set-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] [-ProxyCert ] [-DisableAutoUpgrade] - [-ContainerLogPath ] -Location [-KubeConfig ] [-KubeContext ] - [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] - [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] - [-AcceptEULA] [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] - [-DisableGateway] [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + -EnableSystemAssignedIdentity -Location [-AadProfileAdminGroupObjectID ] + [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] [-ArcAgentProfileAgentAutoUpgrade ] + [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] [-Infrastructure ] + [-Kind ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] + [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] [-DisableGateway] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` ### SetExpandedEnableGateway ``` Set-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] [-ProxyCert ] [-DisableAutoUpgrade] - [-ContainerLogPath ] -Location [-KubeConfig ] [-KubeContext ] - [-AzureHybridBenefit ] [-Distribution ] [-DistributionVersion ] - [-Infrastructure ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] - [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] - [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] - [-AcceptEULA] [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] - -GatewayResourceId [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + -EnableSystemAssignedIdentity -Location [-AadProfileAdminGroupObjectID ] + [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] [-ArcAgentProfileAgentAutoUpgrade ] + [-ArcAgentProfileAgentError ] [-ArcAgentProfileDesiredAgentVersion ] + [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] [-Infrastructure ] + [-Kind ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] + [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] -GatewayResourceId + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` ### SetEnableGateway ``` -Set-AzConnectedKubernetes [-SubscriptionId ] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-ProxyCert ] [-DisableAutoUpgrade] [-ContainerLogPath ] [-KubeConfig ] - [-KubeContext ] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-WorkloadIdentityEnabled] [-AcceptEULA] [-ConfigurationSetting ] - [-ConfigurationProtectedSetting ] -GatewayResourceId -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] +Set-AzConnectedKubernetes [-SubscriptionId ] -EnableSystemAssignedIdentity + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] [-Infrastructure ] + [-Kind ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] + [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] -GatewayResourceId + -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### SetDisableGateway ``` -Set-AzConnectedKubernetes [-SubscriptionId ] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-ProxyCert ] [-DisableAutoUpgrade] [-ContainerLogPath ] [-KubeConfig ] - [-KubeContext ] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-WorkloadIdentityEnabled] [-AcceptEULA] [-ConfigurationSetting ] - [-ConfigurationProtectedSetting ] [-DisableGateway] -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] +Set-AzConnectedKubernetes [-SubscriptionId ] -EnableSystemAssignedIdentity + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] [-Infrastructure ] + [-Kind ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] + [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] [-DisableGateway] + -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### Set ``` -Set-AzConnectedKubernetes [-SubscriptionId ] [-HttpProxy ] [-HttpsProxy ] [-NoProxy ] - [-ProxyCert ] [-DisableAutoUpgrade] [-ContainerLogPath ] [-KubeConfig ] - [-KubeContext ] [-AzureHybridBenefit ] [-Distribution ] - [-DistributionVersion ] [-Infrastructure ] [-PrivateLinkScopeResourceId ] - [-PrivateLinkState ] [-ProvisioningState ] [-Tag ] - [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] [-OidcIssuerProfileSelfHostedIssuerUrl ] - [-WorkloadIdentityEnabled] [-AcceptEULA] [-ConfigurationSetting ] - [-ConfigurationProtectedSetting ] -InputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +Set-AzConnectedKubernetes [-SubscriptionId ] -EnableSystemAssignedIdentity + [-AadProfileAdminGroupObjectID ] [-AadProfileEnableAzureRbac] [-AadProfileTenantId ] + [-ArcAgentProfileAgentAutoUpgrade ] [-ArcAgentProfileAgentError ] + [-ArcAgentProfileDesiredAgentVersion ] [-ArcAgentProfileSystemComponent ] + [-ArcAgentryConfiguration ] [-AzureHybridBenefit ] + [-Distribution ] [-DistributionVersion ] [-GatewayEnabled] [-Infrastructure ] + [-Kind ] [-PrivateLinkScopeResourceId ] [-PrivateLinkState ] + [-ProvisioningState ] [-Tag ] [-CustomLocationsOid ] [-OidcIssuerProfileEnabled] + [-OidcIssuerProfileSelfHostedIssuerUrl ] [-WorkloadIdentityEnabled] [-AcceptEULA] + [-ConfigurationSetting ] [-ConfigurationProtectedSetting ] + -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -195,11 +210,11 @@ This command disables workload identity of a connected kubernetes cluster ## PARAMETERS -### -AcceptEULA -Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided +### -AadProfileAdminGroupObjectID +The list of AAD group object IDs that will have admin role of the cluster. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: System.String[] Parameter Sets: (All) Aliases: @@ -210,8 +225,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -Run the command as a job +### -AadProfileEnableAzureRbac +Whether to enable Azure RBAC for Kubernetes authorization. ```yaml Type: System.Management.Automation.SwitchParameter @@ -225,11 +240,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AzureHybridBenefit -Indicates whether Azure Hybrid Benefit is opted in +### -AadProfileTenantId +The AAD tenant ID to use for authentication. +If not specified, will use the tenant of the deployment subscription. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit +Type: System.String Parameter Sets: (All) Aliases: @@ -240,26 +256,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClusterName -The name of the Kubernetes cluster on which get is called. +### -AcceptEULA +Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided ```yaml -Type: System.String -Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway -Aliases: Name +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfigurationProtectedSetting -Arc Agentry System Protected Configuration +### -ArcAgentProfileAgentAutoUpgrade +Indicates whether the Arc agents on the be upgraded automatically to the latest version. +Defaults to Enabled. ```yaml -Type: System.Collections.Hashtable +Type: System.String Parameter Sets: (All) Aliases: @@ -270,11 +287,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfigurationSetting -Arc Agentry System Configuration +### -ArcAgentProfileAgentError +List of arc agentry and system components errors on the cluster resource. ```yaml -Type: System.Collections.Hashtable +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IAgentError[] Parameter Sets: (All) Aliases: @@ -285,8 +302,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ContainerLogPath -Override the default container log path to enable fluent-bit logging. +### -ArcAgentProfileDesiredAgentVersion +Version of the Arc agents to be installed on the cluster resource ```yaml Type: System.String @@ -300,11 +317,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomLocationsOid -OID of 'custom-locations' app. +### -ArcAgentProfileSystemComponent +List of system extensions that are installed on the cluster resource. ```yaml -Type: System.String +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.ISystemComponent[] Parameter Sets: (All) Aliases: @@ -315,13 +332,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +### -ArcAgentryConfiguration +Configuration settings for customizing the behavior of the connected cluster. ```yaml -Type: System.Management.Automation.PSObject +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IArcAgentryConfigurations[] Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential +Aliases: Required: False Position: Named @@ -330,8 +347,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAutoUpgrade -Flag to disable auto upgrade of arc agents. +### -AsJob +Run the command as a job ```yaml Type: System.Management.Automation.SwitchParameter @@ -345,25 +362,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableGateway +### -AzureHybridBenefit +Indicates whether Azure Hybrid Benefit is opted in ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpandedDisableGateway, SetDisableGateway +Type: System.String +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Distribution -The Kubernetes distribution running on this connected cluster. +### -ClusterName +The name of the Kubernetes cluster on which get is called. ```yaml Type: System.String +Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Arc Agentry System Protected Configuration + +```yaml +Type: System.Collections.Hashtable Parameter Sets: (All) Aliases: @@ -374,11 +407,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionVersion -The Kubernetes distribution version on this connected cluster. +### -ConfigurationSetting +Arc Agentry System Configuration ```yaml -Type: System.String +Type: System.Collections.Hashtable Parameter Sets: (All) Aliases: @@ -389,28 +422,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayResourceId -Arc Gateway resource Id, providing this will enable the gateway +### -CustomLocationsOid +OID of 'custom-locations' app. ```yaml Type: System.String -Parameter Sets: SetExpandedEnableGateway, SetEnableGateway +Parameter Sets: (All) Aliases: -Required: True +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 +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: System.Uri +Type: System.Management.Automation.PSObject Parameter Sets: (All) -Aliases: +Aliases: AzureRMContext, AzureCredential Required: False Position: Named @@ -419,11 +453,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpsProxy -The https URI of the proxy server for the kubernetes cluster to use +### -DisableGateway ```yaml -Type: System.Uri +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpandedDisableGateway, SetDisableGateway +Aliases: + +Required: True +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: @@ -434,8 +482,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Infrastructure -The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. +### -DistributionVersion +The Kubernetes distribution version on this connected cluster. ```yaml Type: System.String @@ -449,26 +497,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster -Parameter Sets: SetEnableGateway, SetDisableGateway, Set +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -KubeConfig -Path to the kube config file +### -GatewayEnabled +Indicates whether the gateway for arc router connectivity is enabled. ```yaml -Type: System.String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -479,8 +527,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KubeContext -Kubconfig context from current machine +### -GatewayResourceId +Arc Gateway resource Id, providing this will enable the gateway + +```yaml +Type: System.String +Parameter Sets: SetExpandedEnableGateway, SetEnableGateway +Aliases: + +Required: True +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 @@ -494,23 +557,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Location -The geo-location where the resource lives +### -InputObject ```yaml -Type: System.String -Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster +Parameter Sets: SetEnableGateway, SetDisableGateway, Set Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) 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 +### -Kind +The kind of connected cluster. ```yaml Type: System.String @@ -524,6 +586,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetExpandedDisableGateway, SetExpandedEnableGateway +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -570,6 +647,7 @@ Accept wildcard characters: False ``` ### -PrivateLinkScopeResourceId +This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any. ```yaml @@ -588,7 +666,7 @@ Accept wildcard characters: False Property which describes the state of private link on a connected cluster resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState +Type: System.String Parameter Sets: (All) Aliases: @@ -602,21 +680,6 @@ 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) @@ -676,7 +739,7 @@ Accept wildcard characters: False ``` ### -WorkloadIdentityEnabled -Enable the workload identity Webhook +Whether to enable or disable the workload identity Webhook ```yaml Type: System.Management.Automation.SwitchParameter @@ -726,11 +789,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES diff --git a/src/ConnectedKubernetes/ConnectedKubernetes/help/Update-AzConnectedKubernetes.md b/src/ConnectedKubernetes/ConnectedKubernetes/help/Update-AzConnectedKubernetes.md index 4ee40c351d11..a9b31a798c1f 100644 --- a/src/ConnectedKubernetes/ConnectedKubernetes/help/Update-AzConnectedKubernetes.md +++ b/src/ConnectedKubernetes/ConnectedKubernetes/help/Update-AzConnectedKubernetes.md @@ -15,17 +15,30 @@ API to update certain properties of the connected cluster resource ### UpdateExpanded (Default) ``` Update-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] - [-AzureHybridBenefit ] [-AcceptEULA] [-Distribution ] - [-DistributionVersion ] [-Tag ] [-DefaultProfile ] + [-AzureHybridBenefit ] [-AcceptEULA] [-Distribution ] [-DistributionVersion ] + [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] + [-AcceptEULA] -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` +### UpdateViaJsonString +``` +Update-AzConnectedKubernetes -ClusterName -ResourceGroupName [-SubscriptionId ] + [-AcceptEULA] -JsonString [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + ### UpdateViaIdentityExpanded ``` -Update-AzConnectedKubernetes -InputObject - [-AzureHybridBenefit ] [-AcceptEULA] [-Distribution ] - [-DistributionVersion ] [-Tag ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] +Update-AzConnectedKubernetes -InputObject [-AzureHybridBenefit ] + [-AcceptEULA] [-Distribution ] [-DistributionVersion ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -109,8 +122,8 @@ Accept wildcard characters: False Indicates whether Azure Hybrid Benefit is opted in ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -125,7 +138,7 @@ The name of the Kubernetes cluster on which get is called. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Name Required: True @@ -136,7 +149,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -155,7 +169,7 @@ Represents the distribution of the connected cluster ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -170,7 +184,7 @@ Represents the Kubernetes distribution version on this connected cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -182,7 +196,6 @@ 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 @@ -196,13 +209,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +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: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -217,7 +260,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -232,7 +275,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -282,7 +325,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.IConnectedCluster +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedCluster ## NOTES