ConnectedCluster interface

Package:

@azure/arm-hybridkubernetes

Represents a connected cluster.

Extends

TrackedResource

Properties

aadProfile	AAD profile for the connected cluster.
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
arcAgentProfile	Arc agentry configuration for the provisioned cluster.
arcAgentryConfigurations	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.
gateway	Details of the gateway used by the Arc router for connectivity.
identity	The identity of 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
managedIdentityCertificateExpirationTime	Expiration time of the managed identity certificate
miscellaneousProperties	More properties related to the Connected Cluster
offering	Connected cluster offering
oidcIssuerProfile	Open ID Connect (OIDC) Issuer Profile for the connected cluster.
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.
securityProfile	Security profile for the connected cluster.
totalCoreCount	Number of CPU cores present in the connected cluster resource
totalNodeCount	Number of nodes present in the connected cluster resource

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

aadProfile

AAD profile for the connected cluster.

aadProfile?: AadProfile

Property Value

AadProfile

agentPublicKeyCertificate

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

agentPublicKeyCertificate: string

Property Value

string

agentVersion

Version of the agent running on the connected cluster resource

agentVersion?: string

Property Value

string

arcAgentProfile

Arc agentry configuration for the provisioned cluster.

arcAgentProfile?: ArcAgentProfile

Property Value

ArcAgentProfile

arcAgentryConfigurations

Configuration settings for customizing the behavior of the connected cluster.

arcAgentryConfigurations?: ArcAgentryConfigurations[]

Property Value

ArcAgentryConfigurations[]

azureHybridBenefit

Indicates whether Azure Hybrid Benefit is opted in

azureHybridBenefit?: string

Property Value

string

connectivityStatus

Represents the connectivity status of the connected cluster.

connectivityStatus?: string

Property Value

string

distribution

The Kubernetes distribution running on this connected cluster.

distribution?: string

Property Value

string

distributionVersion

The Kubernetes distribution version on this connected cluster.

distributionVersion?: string

Property Value

string

gateway

Details of the gateway used by the Arc router for connectivity.

gateway?: Gateway

Property Value

Gateway

identity

The identity of the connected cluster.

identity: ConnectedClusterIdentity

Property Value

ConnectedClusterIdentity

infrastructure

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

infrastructure?: string

Property Value

string

kind

The kind of connected cluster.

kind?: string

Property Value

string

kubernetesVersion

The Kubernetes version of the connected cluster resource

kubernetesVersion?: string

Property Value

string

lastConnectivityTime

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

lastConnectivityTime?: Date

Property Value

Date

managedIdentityCertificateExpirationTime

Expiration time of the managed identity certificate

managedIdentityCertificateExpirationTime?: Date

Property Value

Date

miscellaneousProperties

More properties related to the Connected Cluster

miscellaneousProperties?: Record<string, string>

Property Value

Record<string, string>

offering

Connected cluster offering

offering?: string

Property Value

string

oidcIssuerProfile

Open ID Connect (OIDC) Issuer Profile for the connected cluster.

oidcIssuerProfile?: OidcIssuerProfile

Property Value

OidcIssuerProfile

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.

privateLinkScopeResourceId?: string

Property Value

string

privateLinkState

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

privateLinkState?: string

Property Value

string

provisioningState

Provisioning state of the connected cluster resource.

provisioningState?: string

Property Value

string

securityProfile

Security profile for the connected cluster.

securityProfile?: SecurityProfile

Property Value

SecurityProfile

totalCoreCount

Number of CPU cores present in the connected cluster resource

totalCoreCount?: number

Property Value

number

totalNodeCount

Number of nodes present in the connected cluster resource

totalNodeCount?: number

Property Value

number

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type