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

2025/07/29 • 8 new methods

Operations_Get (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Kubernetes/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of connected cluster API operations. ,
Required: True ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of connected cluster API operations. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_ListBySubscription (new)
Description :  API to enumerate registered connected K8s clusters under a Subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Kubernetes/connectedClusters
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ConnectedCluster items on this page ,
Required: True ,
}
[
{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_ListByResourceGroup (new)
Description :  API to enumerate registered connected K8s clusters under a Resource Group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ConnectedCluster items on this page ,
Required: True ,
}
[
{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_Get (new)
Description :  Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
Reference :  Link ¶

⚼ Request

GET:  /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 ,
}

⚐ Response (200)

{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_CreateOrReplace (new)
Description :  API to register a new Kubernetes cluster and create or replace a connected cluster tracked resource in Azure Resource Manager (ARM).
Reference :  Link ¶

⚼ Request

PUT:  /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 ,
ConnectedCluster:
{
Description: Parameters supplied to Create a Connected Cluster. ,
Required: True ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents a connected cluster. ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_Update (new)
Description :  API to update certain properties of the connected cluster resource
Reference :  Link ¶

⚼ 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 ,
}
,
}
,
}

⚐ Response (200)

{
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_Delete (new)
Description :  Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
Reference :  Link ¶

⚼ Request

DELETE:  /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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedCluster_ListClusterUserCredential (new)
Description :  Gets cluster user credentials of the connected cluster with a specified resource group and name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}/listClusterUserCredential
{
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 ,
Properties:
{
Description: ListClusterUserCredential properties ,
Required: True ,
}
{
authenticationMethod:
{
Description: The mode of client authentication. ,
Enum:
{
Token: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
clientProxy:
{
Description: Boolean value to indicate whether the request is for client side proxy or not ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (200)

{
hybridConnectionConfig:
{
Description: Contains the REP (rendezvous endpoint) and “Sender” access token. ,
Required: False ,
}
{
expirationTime:
{
Description: Timestamp when this token will be expired. ,
Format: int64 ,
Required: False ,
}
integer ,
hybridConnectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
relay:
{
Description: Name of the relay. ,
Required: False ,
}
string ,
token:
{
Description: Sender access token ,
Required: False ,
}
string ,
relayTid:
{
Description: TenantID of the relay ,
Required: False ,
}
string ,
relayType:
{
Description: Type of relay ,
Required: False ,
}
string ,
}
,
kubeconfigs:
{
Description: Base64-encoded Kubernetes configuration file. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Required: False ,
}
string ,
value:
{
Description: Base64-encoded Kubernetes configuration file. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}