KubernetesRole interface

Package:

@azure/arm-databoxedge

The limited preview of Kubernetes Cluster Management from the Azure supports:

1. Using a simple turn-key option in Azure Portal, deploy a Kubernetes cluster on your Azure Stack Edge device.
2. Configure Kubernetes cluster running on your device with Arc enabled Kubernetes with a click of a button in the Azure Portal. Azure Arc enables organizations to view, manage, and govern their on-premises Kubernetes clusters using the Azure Portal, command line tools, and APIs.
3. Easily configure Persistent Volumes using SMB and NFS shares for storing container data. For more information, refer to the document here: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8-Cloud-Management-20210323.pdf Or Demo: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8S-Cloud-Management-20210323.mp4 By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/

Extends

Role

Properties

hostPlatform	Host OS supported by the Kubernetes role.
hostPlatformType	Platform where the runtime is hosted.
kind	Role type.
kubernetesClusterInfo	Kubernetes cluster configuration
kubernetesRoleResources	Kubernetes role resources
provisioningState	State of Kubernetes deployment
roleStatus	Role status.

Inherited Properties

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

Property Details

hostPlatform

Host OS supported by the Kubernetes role.

hostPlatform?: string

Property Value

string

hostPlatformType

Platform where the runtime is hosted.

hostPlatformType?: string

Property Value

string

kind

Role type.

kind: "Kubernetes"

Property Value

"Kubernetes"

kubernetesClusterInfo

Kubernetes cluster configuration

kubernetesClusterInfo?: KubernetesClusterInfo

Property Value

KubernetesClusterInfo

kubernetesRoleResources

Kubernetes role resources

kubernetesRoleResources?: KubernetesRoleResources

Property Value

KubernetesRoleResources

provisioningState

State of Kubernetes deployment

provisioningState?: string

Property Value

string

roleStatus

Role status.

roleStatus?: string

Property Value

string

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 Role.id

name

The name of the resource

name?: string

Property Value

string

Inherited From Role.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From Role.systemData

type

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

type?: string

Property Value

string

Inherited From Role.type