Microsoft.Kubernetes (preview:2025-12-01)

2025/09/24 • 1 updated methods

ConnectedCluster_Update (updated)
Description :  API to update certain properties of the connected cluster resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedCluster_Update",
  "$responses": {
    "@added_99308c48022f499e82bc97ffe3b89067": {
      "202": [
        {
          "#name": "location",
          "Description": "The Location header contains the URL where the status of the long running operation can be checked.",
          "Type": "string"
        },
        {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Kubernetes cluster on which get is called. ,
Required: True ,
}
string ,
ConnectedClusterPatch:
{
Description: Parameters supplied to update Connected Cluster. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Describes the connected cluster resource properties that can be updated during PATCH operation. ,
Required: False ,
}
{
distribution:
{
Description: Represents the distribution of the connected cluster ,
Required: False ,
}
string ,
distributionVersion:
{
Description: Represents the Kubernetes distribution version on this connected cluster. ,
Required: False ,
}
string ,
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
gateway:
{
Description: Indicates whether Gateway is enabled for the connected cluster resource ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether the gateway for arc router connectivity is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the connected cluster resource properties. ,
Required: True ,
}
{
agentPublicKeyCertificate:
{
Description: Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. ,
Required: True ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version of the connected cluster resource ,
Required: False ,
}
string ,
totalNodeCount:
{
Description: Number of nodes present in the connected cluster resource ,
Format: int32 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: Number of CPU cores present in the connected cluster resource ,
Format: int32 ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of the agent running on the connected cluster resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the connected cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
distribution:
{
Description: The Kubernetes distribution running on this connected cluster. ,
Required: False ,
}
string ,
distributionVersion:
{
Description: The Kubernetes distribution version on this connected cluster. ,
Required: False ,
}
string ,
infrastructure:
{
Description: The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. ,
Required: False ,
}
string ,
offering:
{
Description: Connected cluster offering ,
Required: False ,
}
string ,
managedIdentityCertificateExpirationTime:
{
Description: Expiration time of the managed identity certificate ,
Format: date-time ,
Required: False ,
}
string ,
lastConnectivityTime:
{
Description: Time representing the last instance when heart beat was received from the cluster ,
Format: date-time ,
Required: False ,
}
string ,
connectivityStatus:
{
Description: Represents the connectivity status of the connected cluster. ,
Enum:
{
Connecting: No description available. ,
Connected: No description available. ,
Offline: No description available. ,
Expired: No description available. ,
AgentNotInstalled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkState:
{
Description: Property which describes the state of private link on a connected cluster resource. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateLinkScopeResourceId:
{
Description: This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any. ,
Required: False ,
}
string ,
azureHybridBenefit:
{
Description: Indicates whether Azure Hybrid Benefit is opted in ,
Enum:
{
True: No description available. ,
False: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
aadProfile:
{
Description: AAD profile for the connected cluster. ,
Required: False ,
}
{
enableAzureRBAC:
{
Description: Whether to enable Azure RBAC for Kubernetes authorization. ,
Required: False ,
}
boolean ,
adminGroupObjectIDs:
{
Description: The list of AAD group object IDs that will have admin role of the cluster. ,
Required: False ,
}
[
string ,
]
,
tenantID:
{
Description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ,
Required: False ,
}
string ,
}
,
arcAgentProfile:
{
Description: Arc agentry configuration for the provisioned cluster. ,
Required: False ,
}
{
desiredAgentVersion:
{
Description: Version of the Arc agents to be installed on the cluster resource ,
Required: False ,
}
string ,
agentAutoUpgrade:
{
Description: Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
systemComponents:
{
Description: List of system extensions that are installed on the cluster resource. ,
Required: False ,
}
[
{
type:
{
Description: Type of the system extension ,
Required: False ,
}
string ,
userSpecifiedVersion:
{
Description: Version of the system extension to be installed on the cluster resource. ,
Required: False ,
}
string ,
majorVersion:
{
Description: Major Version of the system extension that is currently installed on the cluster resource. ,
Format: int32 ,
Required: False ,
}
integer ,
currentVersion:
{
Description: Version of the system extension that is currently installed on the cluster resource. ,
Required: False ,
}
string ,
}
,
]
,
agentErrors:
{
Description: List of arc agentry and system components errors on the cluster resource. ,
Required: False ,
}
[
{
message:
{
Description: Agent error message. ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the error message. ,
Required: False ,
}
string ,
component:
{
Description: Agent component where error message occured. ,
Required: False ,
}
string ,
time:
{
Description: The timestamp of error occured (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
agentState:
{
Description: Represents the current state of the Arc agentry and its dependent components. ,
Required: False ,
}
string ,
}
,
securityProfile:
{
Description: Security profile for the connected cluster. ,
Required: False ,
}
{
workloadIdentity:
{
Description: The workload identity feature webhook. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable or disable the workload identity Webhook ,
Required: False ,
}
boolean ,
}
,
}
,
oidcIssuerProfile:
{
Description: Open ID Connect (OIDC) Issuer Profile for the connected cluster. ,
Required: False ,
}
{
enabled:
{
Description: Whether to enable oidc issuer for workload identity integration. ,
Required: False ,
}
boolean ,
issuerUrl:
{
Description: The issuer url for hybrid clusters connected to Arc used for the workload identity feature. ,
Required: False ,
}
string ,
selfHostedIssuerUrl:
{
Description: The issuer url for public cloud clusters - AKS, EKS, GKE - used for the workload identity feature. ,
Required: False ,
}
string ,
}
,
gateway:
{
Description: Details of the gateway used by the Arc router for connectivity. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether the gateway for arc router connectivity is enabled. ,
Required: False ,
}
boolean ,
}
,
arcAgentryConfigurations:
{
Description: Configuration settings for customizing the behavior of the connected cluster. ,
Required: False ,
}
[
{
feature:
{
Description: Specifies the name of the feature for the configuration setting. ,
Required: False ,
}
string ,
settings:
{
Description: The configuration settings for the feature that do not contain any sensitive or secret information. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The configuration settings for the feature that contain any sensitive or secret information. ,
Required: False ,
}
object ,
}
,
]
,
miscellaneousProperties:
{
Description: More properties related to the Connected Cluster ,
Required: False ,
}
object ,
}
,
identity:
{
Description: The identity of the connected cluster. ,
Required: True ,
}
{
principalId:
{
Description: The principal id of connected cluster identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
kind:
{
Description: The kind of connected cluster. ,
Enum:
{
ProvisionedCluster: No description available. ,
AWS: No description available. ,
GCP: Represents a connected cluster hosted on Google Cloud Platform (GCP) ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}