Share via


IConnectedCluster Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.ConnectedClusterTypeConverter))]
public interface IConnectedCluster : Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20240715Preview.ConnectedClusterTypeConverter))>]
type IConnectedCluster = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
Public Interface IConnectedCluster
Implements ITrackedResource
Derived
Attributes
Implements

Properties

AadProfileAdminGroupObjectID

The list of AAD group object IDs that will have admin role of the cluster.

AadProfileEnableAzureRbac

Whether to enable Azure RBAC for Kubernetes authorization.

AadProfileTenantId

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

AgentPublicKeyCertificate

Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.

AgentVersion

Version of the agent running on the connected cluster resource

ArcAgentProfileAgentAutoUpgrade

Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.

ArcAgentProfileAgentError

List of arc agentry and system components errors on the cluster resource.

ArcAgentProfileAgentState

Represents the current state of the Arc agentry and its dependent components.

ArcAgentProfileDesiredAgentVersion

Version of the Arc agents to be installed on the cluster resource

ArcAgentProfileSystemComponent

List of system extensions that are installed on the cluster resource.

ArcAgentryConfiguration

Configuration settings for customizing the behavior of the connected cluster.

AzureHybridBenefit

Indicates whether Azure Hybrid Benefit is opted in

ConnectivityStatus

Represents the connectivity status of the connected cluster.

Distribution

The Kubernetes distribution running on this connected cluster.

DistributionVersion

The Kubernetes distribution version on this connected cluster.

GatewayEnabled

Indicates whether the gateway for arc router connectivity is enabled.

GatewayResourceId

The resource ID of the gateway used for the Arc router feature.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Inherited from IResource)
IdentityPrincipalId

The principal id of connected cluster identity. This property will only be provided for a system assigned identity.

IdentityTenantId

The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.

IdentityType

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.

Infrastructure

The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.

Kind

The kind of connected cluster.

KubernetesVersion

The Kubernetes version of the connected cluster resource

LastConnectivityTime

Time representing the last instance when heart beat was received from the cluster

Location

The geo-location where the resource lives

(Inherited from ITrackedResource)
ManagedIdentityCertificateExpirationTime

Expiration time of the managed identity certificate

MiscellaneousProperty

More properties related to the Connected Cluster

Name

The name of the resource

(Inherited from IResource)
Offering

Connected cluster offering

OidcIssuerProfileEnabled

Whether to enable oidc issuer for workload identity integration.

OidcIssuerProfileIssuerUrl

The issuer url for hybrid clusters connected to Arc used for the workload identity feature.

OidcIssuerProfileSelfHostedIssuerUrl

The issuer url for public cloud clusters - AKS, EKS, GKE - used for the workload identity feature.

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.

PrivateLinkState

Property which describes the state of private link on a connected cluster resource.

ProvisioningState

Provisioning state of the connected cluster resource.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource modification (UTC).

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

(Inherited from ITrackedResource)
TotalCoreCount

Number of CPU cores present in the connected cluster resource

TotalNodeCount

Number of nodes present in the connected cluster resource

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

(Inherited from IResource)
WorkloadIdentityEnabled

Whether to enable or disable the workload identity Webhook

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to