1. Packages
  2. Azure Native v2
  3. API Docs
  4. databoxedge
  5. getKubernetesRole
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.databoxedge.getKubernetesRole

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets a specific role by name. Azure REST API version: 2022-03-01.

Using getKubernetesRole

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKubernetesRole(args: GetKubernetesRoleArgs, opts?: InvokeOptions): Promise<GetKubernetesRoleResult>
function getKubernetesRoleOutput(args: GetKubernetesRoleOutputArgs, opts?: InvokeOptions): Output<GetKubernetesRoleResult>
Copy
def get_kubernetes_role(device_name: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetKubernetesRoleResult
def get_kubernetes_role_output(device_name: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesRoleResult]
Copy
func LookupKubernetesRole(ctx *Context, args *LookupKubernetesRoleArgs, opts ...InvokeOption) (*LookupKubernetesRoleResult, error)
func LookupKubernetesRoleOutput(ctx *Context, args *LookupKubernetesRoleOutputArgs, opts ...InvokeOption) LookupKubernetesRoleResultOutput
Copy

> Note: This function is named LookupKubernetesRole in the Go SDK.

public static class GetKubernetesRole 
{
    public static Task<GetKubernetesRoleResult> InvokeAsync(GetKubernetesRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesRoleResult> Invoke(GetKubernetesRoleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKubernetesRoleResult> getKubernetesRole(GetKubernetesRoleArgs args, InvokeOptions options)
public static Output<GetKubernetesRoleResult> getKubernetesRole(GetKubernetesRoleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databoxedge:getKubernetesRole
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
Name
This property is required.
Changes to this property will trigger replacement.
string
The role name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
Name
This property is required.
Changes to this property will trigger replacement.
string
The role name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
name
This property is required.
Changes to this property will trigger replacement.
String
The role name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
name
This property is required.
Changes to this property will trigger replacement.
string
The role name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
name
This property is required.
Changes to this property will trigger replacement.
str
The role name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
name
This property is required.
Changes to this property will trigger replacement.
String
The role name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.

getKubernetesRole Result

The following output properties are available:

HostPlatform string
Host OS supported by the Kubernetes role.
HostPlatformType string
Platform where the runtime is hosted.
Id string
The path ID that uniquely identifies the object.
KubernetesClusterInfo Pulumi.AzureNative.DataBoxEdge.Outputs.KubernetesClusterInfoResponse
Kubernetes cluster configuration
KubernetesRoleResources Pulumi.AzureNative.DataBoxEdge.Outputs.KubernetesRoleResourcesResponse
Kubernetes role resources
Name string
The object name.
ProvisioningState string
State of Kubernetes deployment
RoleStatus string
Role status.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of Role
Type string
The hierarchical type of the object.
HostPlatform string
Host OS supported by the Kubernetes role.
HostPlatformType string
Platform where the runtime is hosted.
Id string
The path ID that uniquely identifies the object.
KubernetesClusterInfo KubernetesClusterInfoResponse
Kubernetes cluster configuration
KubernetesRoleResources KubernetesRoleResourcesResponse
Kubernetes role resources
Name string
The object name.
ProvisioningState string
State of Kubernetes deployment
RoleStatus string
Role status.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of Role
Type string
The hierarchical type of the object.
hostPlatform String
Host OS supported by the Kubernetes role.
hostPlatformType String
Platform where the runtime is hosted.
id String
The path ID that uniquely identifies the object.
kubernetesClusterInfo KubernetesClusterInfoResponse
Kubernetes cluster configuration
kubernetesRoleResources KubernetesRoleResourcesResponse
Kubernetes role resources
name String
The object name.
provisioningState String
State of Kubernetes deployment
roleStatus String
Role status.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Role
type String
The hierarchical type of the object.
hostPlatform string
Host OS supported by the Kubernetes role.
hostPlatformType string
Platform where the runtime is hosted.
id string
The path ID that uniquely identifies the object.
kubernetesClusterInfo KubernetesClusterInfoResponse
Kubernetes cluster configuration
kubernetesRoleResources KubernetesRoleResourcesResponse
Kubernetes role resources
name string
The object name.
provisioningState string
State of Kubernetes deployment
roleStatus string
Role status.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Role
type string
The hierarchical type of the object.
host_platform str
Host OS supported by the Kubernetes role.
host_platform_type str
Platform where the runtime is hosted.
id str
The path ID that uniquely identifies the object.
kubernetes_cluster_info KubernetesClusterInfoResponse
Kubernetes cluster configuration
kubernetes_role_resources KubernetesRoleResourcesResponse
Kubernetes role resources
name str
The object name.
provisioning_state str
State of Kubernetes deployment
role_status str
Role status.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of Role
type str
The hierarchical type of the object.
hostPlatform String
Host OS supported by the Kubernetes role.
hostPlatformType String
Platform where the runtime is hosted.
id String
The path ID that uniquely identifies the object.
kubernetesClusterInfo Property Map
Kubernetes cluster configuration
kubernetesRoleResources Property Map
Kubernetes role resources
name String
The object name.
provisioningState String
State of Kubernetes deployment
roleStatus String
Role status.
systemData Property Map
Metadata pertaining to creation and last modification of Role
type String
The hierarchical type of the object.

Supporting Types

CniConfigResponse

PodSubnet This property is required. string
Pod Subnet
ServiceSubnet This property is required. string
Service subnet
Type This property is required. string
Cni type
Version This property is required. string
Cni version
PodSubnet This property is required. string
Pod Subnet
ServiceSubnet This property is required. string
Service subnet
Type This property is required. string
Cni type
Version This property is required. string
Cni version
podSubnet This property is required. String
Pod Subnet
serviceSubnet This property is required. String
Service subnet
type This property is required. String
Cni type
version This property is required. String
Cni version
podSubnet This property is required. string
Pod Subnet
serviceSubnet This property is required. string
Service subnet
type This property is required. string
Cni type
version This property is required. string
Cni version
pod_subnet This property is required. str
Pod Subnet
service_subnet This property is required. str
Service subnet
type This property is required. str
Cni type
version This property is required. str
Cni version
podSubnet This property is required. String
Pod Subnet
serviceSubnet This property is required. String
Service subnet
type This property is required. String
Cni type
version This property is required. String
Cni version

EtcdInfoResponse

Type This property is required. string
Etcd type
Version This property is required. string
Etcd version
Type This property is required. string
Etcd type
Version This property is required. string
Etcd version
type This property is required. String
Etcd type
version This property is required. String
Etcd version
type This property is required. string
Etcd type
version This property is required. string
Etcd version
type This property is required. str
Etcd type
version This property is required. str
Etcd version
type This property is required. String
Etcd type
version This property is required. String
Etcd version

KubernetesClusterInfoResponse

EtcdInfo This property is required. Pulumi.AzureNative.DataBoxEdge.Inputs.EtcdInfoResponse
Etcd configuration
Nodes This property is required. List<Pulumi.AzureNative.DataBoxEdge.Inputs.NodeInfoResponse>
Kubernetes cluster nodes
Version This property is required. string
Kubernetes cluster version
EtcdInfo This property is required. EtcdInfoResponse
Etcd configuration
Nodes This property is required. []NodeInfoResponse
Kubernetes cluster nodes
Version This property is required. string
Kubernetes cluster version
etcdInfo This property is required. EtcdInfoResponse
Etcd configuration
nodes This property is required. List<NodeInfoResponse>
Kubernetes cluster nodes
version This property is required. String
Kubernetes cluster version
etcdInfo This property is required. EtcdInfoResponse
Etcd configuration
nodes This property is required. NodeInfoResponse[]
Kubernetes cluster nodes
version This property is required. string
Kubernetes cluster version
etcd_info This property is required. EtcdInfoResponse
Etcd configuration
nodes This property is required. Sequence[NodeInfoResponse]
Kubernetes cluster nodes
version This property is required. str
Kubernetes cluster version
etcdInfo This property is required. Property Map
Etcd configuration
nodes This property is required. List<Property Map>
Kubernetes cluster nodes
version This property is required. String
Kubernetes cluster version

KubernetesIPConfigurationResponse

Port This property is required. string
Port of the Kubernetes node.
IpAddress string
IP address of the Kubernetes node.
Port This property is required. string
Port of the Kubernetes node.
IpAddress string
IP address of the Kubernetes node.
port This property is required. String
Port of the Kubernetes node.
ipAddress String
IP address of the Kubernetes node.
port This property is required. string
Port of the Kubernetes node.
ipAddress string
IP address of the Kubernetes node.
port This property is required. str
Port of the Kubernetes node.
ip_address str
IP address of the Kubernetes node.
port This property is required. String
Port of the Kubernetes node.
ipAddress String
IP address of the Kubernetes node.

KubernetesRoleComputeResponse

MemoryInBytes This property is required. double
Memory in bytes
ProcessorCount This property is required. int
Processor count
VmProfile This property is required. string
VM profile
MemoryInBytes This property is required. float64
Memory in bytes
ProcessorCount This property is required. int
Processor count
VmProfile This property is required. string
VM profile
memoryInBytes This property is required. Double
Memory in bytes
processorCount This property is required. Integer
Processor count
vmProfile This property is required. String
VM profile
memoryInBytes This property is required. number
Memory in bytes
processorCount This property is required. number
Processor count
vmProfile This property is required. string
VM profile
memory_in_bytes This property is required. float
Memory in bytes
processor_count This property is required. int
Processor count
vm_profile This property is required. str
VM profile
memoryInBytes This property is required. Number
Memory in bytes
processorCount This property is required. Number
Processor count
vmProfile This property is required. String
VM profile

KubernetesRoleNetworkResponse

CniConfig This property is required. Pulumi.AzureNative.DataBoxEdge.Inputs.CniConfigResponse
Cni configuration
LoadBalancerConfig This property is required. Pulumi.AzureNative.DataBoxEdge.Inputs.LoadBalancerConfigResponse
Load balancer configuration
CniConfig This property is required. CniConfigResponse
Cni configuration
LoadBalancerConfig This property is required. LoadBalancerConfigResponse
Load balancer configuration
cniConfig This property is required. CniConfigResponse
Cni configuration
loadBalancerConfig This property is required. LoadBalancerConfigResponse
Load balancer configuration
cniConfig This property is required. CniConfigResponse
Cni configuration
loadBalancerConfig This property is required. LoadBalancerConfigResponse
Load balancer configuration
cni_config This property is required. CniConfigResponse
Cni configuration
load_balancer_config This property is required. LoadBalancerConfigResponse
Load balancer configuration
cniConfig This property is required. Property Map
Cni configuration
loadBalancerConfig This property is required. Property Map
Load balancer configuration

KubernetesRoleResourcesResponse

Compute This property is required. Pulumi.AzureNative.DataBoxEdge.Inputs.KubernetesRoleComputeResponse
Kubernetes role compute resource
Network This property is required. Pulumi.AzureNative.DataBoxEdge.Inputs.KubernetesRoleNetworkResponse
Kubernetes role network resource
Storage Pulumi.AzureNative.DataBoxEdge.Inputs.KubernetesRoleStorageResponse
Kubernetes role storage resource
Compute This property is required. KubernetesRoleComputeResponse
Kubernetes role compute resource
Network This property is required. KubernetesRoleNetworkResponse
Kubernetes role network resource
Storage KubernetesRoleStorageResponse
Kubernetes role storage resource
compute This property is required. KubernetesRoleComputeResponse
Kubernetes role compute resource
network This property is required. KubernetesRoleNetworkResponse
Kubernetes role network resource
storage KubernetesRoleStorageResponse
Kubernetes role storage resource
compute This property is required. KubernetesRoleComputeResponse
Kubernetes role compute resource
network This property is required. KubernetesRoleNetworkResponse
Kubernetes role network resource
storage KubernetesRoleStorageResponse
Kubernetes role storage resource
compute This property is required. KubernetesRoleComputeResponse
Kubernetes role compute resource
network This property is required. KubernetesRoleNetworkResponse
Kubernetes role network resource
storage KubernetesRoleStorageResponse
Kubernetes role storage resource
compute This property is required. Property Map
Kubernetes role compute resource
network This property is required. Property Map
Kubernetes role network resource
storage Property Map
Kubernetes role storage resource

KubernetesRoleStorageClassInfoResponse

Name This property is required. string
Storage class name.
PosixCompliant This property is required. string
If provisioned storage is posix compliant.
Type This property is required. string
Storage class type.
Name This property is required. string
Storage class name.
PosixCompliant This property is required. string
If provisioned storage is posix compliant.
Type This property is required. string
Storage class type.
name This property is required. String
Storage class name.
posixCompliant This property is required. String
If provisioned storage is posix compliant.
type This property is required. String
Storage class type.
name This property is required. string
Storage class name.
posixCompliant This property is required. string
If provisioned storage is posix compliant.
type This property is required. string
Storage class type.
name This property is required. str
Storage class name.
posix_compliant This property is required. str
If provisioned storage is posix compliant.
type This property is required. str
Storage class type.
name This property is required. String
Storage class name.
posixCompliant This property is required. String
If provisioned storage is posix compliant.
type This property is required. String
Storage class type.

KubernetesRoleStorageResponse

StorageClasses This property is required. []KubernetesRoleStorageClassInfoResponse
Kubernetes storage class info.
Endpoints []MountPointMapResponse
Mount points of shares in role(s).
storageClasses This property is required. List<KubernetesRoleStorageClassInfoResponse>
Kubernetes storage class info.
endpoints List<MountPointMapResponse>
Mount points of shares in role(s).
storageClasses This property is required. KubernetesRoleStorageClassInfoResponse[]
Kubernetes storage class info.
endpoints MountPointMapResponse[]
Mount points of shares in role(s).
storage_classes This property is required. Sequence[KubernetesRoleStorageClassInfoResponse]
Kubernetes storage class info.
endpoints Sequence[MountPointMapResponse]
Mount points of shares in role(s).
storageClasses This property is required. List<Property Map>
Kubernetes storage class info.
endpoints List<Property Map>
Mount points of shares in role(s).

LoadBalancerConfigResponse

Type This property is required. string
Load balancer type
Version This property is required. string
Load balancer version
Type This property is required. string
Load balancer type
Version This property is required. string
Load balancer version
type This property is required. String
Load balancer type
version This property is required. String
Load balancer version
type This property is required. string
Load balancer type
version This property is required. string
Load balancer version
type This property is required. str
Load balancer type
version This property is required. str
Load balancer version
type This property is required. String
Load balancer type
version This property is required. String
Load balancer version

MountPointMapResponse

MountPoint This property is required. string
Mount point for the share.
MountType This property is required. string
Mounting type.
RoleId This property is required. string
ID of the role to which share is mounted.
RoleType This property is required. string
Role type.
ShareId This property is required. string
ID of the share mounted to the role VM.
MountPoint This property is required. string
Mount point for the share.
MountType This property is required. string
Mounting type.
RoleId This property is required. string
ID of the role to which share is mounted.
RoleType This property is required. string
Role type.
ShareId This property is required. string
ID of the share mounted to the role VM.
mountPoint This property is required. String
Mount point for the share.
mountType This property is required. String
Mounting type.
roleId This property is required. String
ID of the role to which share is mounted.
roleType This property is required. String
Role type.
shareId This property is required. String
ID of the share mounted to the role VM.
mountPoint This property is required. string
Mount point for the share.
mountType This property is required. string
Mounting type.
roleId This property is required. string
ID of the role to which share is mounted.
roleType This property is required. string
Role type.
shareId This property is required. string
ID of the share mounted to the role VM.
mount_point This property is required. str
Mount point for the share.
mount_type This property is required. str
Mounting type.
role_id This property is required. str
ID of the role to which share is mounted.
role_type This property is required. str
Role type.
share_id This property is required. str
ID of the share mounted to the role VM.
mountPoint This property is required. String
Mount point for the share.
mountType This property is required. String
Mounting type.
roleId This property is required. String
ID of the role to which share is mounted.
roleType This property is required. String
Role type.
shareId This property is required. String
ID of the share mounted to the role VM.

NodeInfoResponse

Name This property is required. string
Node name.
Type This property is required. string
Node type - Master/Worker
IpConfiguration List<Pulumi.AzureNative.DataBoxEdge.Inputs.KubernetesIPConfigurationResponse>
IP Configuration of the Kubernetes node.
Name This property is required. string
Node name.
Type This property is required. string
Node type - Master/Worker
IpConfiguration []KubernetesIPConfigurationResponse
IP Configuration of the Kubernetes node.
name This property is required. String
Node name.
type This property is required. String
Node type - Master/Worker
ipConfiguration List<KubernetesIPConfigurationResponse>
IP Configuration of the Kubernetes node.
name This property is required. string
Node name.
type This property is required. string
Node type - Master/Worker
ipConfiguration KubernetesIPConfigurationResponse[]
IP Configuration of the Kubernetes node.
name This property is required. str
Node name.
type This property is required. str
Node type - Master/Worker
ip_configuration Sequence[KubernetesIPConfigurationResponse]
IP Configuration of the Kubernetes node.
name This property is required. String
Node name.
type This property is required. String
Node type - Master/Worker
ipConfiguration List<Property Map>
IP Configuration of the Kubernetes node.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi