@pulumi/azure-native/databoxedge/getIoTRole.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets a specific role by name.
 *
 * Uses Azure REST API version 2023-07-01.
 */
export declare function getIoTRole(args: GetIoTRoleArgs, opts?: pulumi.InvokeOptions): Promise<GetIoTRoleResult>;
export interface GetIoTRoleArgs {
    /**
     * The device name.
     */
    deviceName: string;
    /**
     * The role name.
     */
    name: string;
    /**
     * The resource group name.
     */
    resourceGroupName: string;
}
/**
 * Compute role.
 */
export interface GetIoTRoleResult {
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * Resource allocation
     */
    readonly computeResource?: outputs.databoxedge.ComputeResourceResponse;
    /**
     * Host OS supported by the IoT role.
     */
    readonly hostPlatform: string;
    /**
     * Platform where the Iot runtime is hosted.
     */
    readonly hostPlatformType: string;
    /**
     * The path ID that uniquely identifies the object.
     */
    readonly id: string;
    /**
     * IoT device metadata to which data box edge device needs to be connected.
     */
    readonly ioTDeviceDetails: outputs.databoxedge.IoTDeviceInfoResponse;
    /**
     * Iot edge agent details to download the agent and bootstrap iot runtime.
     */
    readonly ioTEdgeAgentInfo?: outputs.databoxedge.IoTEdgeAgentInfoResponse;
    /**
     * IoT edge device to which the IoT role needs to be configured.
     */
    readonly ioTEdgeDeviceDetails: outputs.databoxedge.IoTDeviceInfoResponse;
    /**
     * Role type.
     * Expected value is 'IOT'.
     */
    readonly kind: "IOT";
    /**
     * The object name.
     */
    readonly name: string;
    /**
     * Role status.
     */
    readonly roleStatus: string;
    /**
     * Mount points of shares in role(s).
     */
    readonly shareMappings?: outputs.databoxedge.MountPointMapResponse[];
    /**
     * Metadata pertaining to creation and last modification of Role
     */
    readonly systemData: outputs.databoxedge.SystemDataResponse;
    /**
     * The hierarchical type of the object.
     */
    readonly type: string;
}
/**
 * Gets a specific role by name.
 *
 * Uses Azure REST API version 2023-07-01.
 */
export declare function getIoTRoleOutput(args: GetIoTRoleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetIoTRoleResult>;
export interface GetIoTRoleOutputArgs {
    /**
     * The device name.
     */
    deviceName: pulumi.Input<string>;
    /**
     * The role name.
     */
    name: pulumi.Input<string>;
    /**
     * The resource group name.
     */
    resourceGroupName: pulumi.Input<string>;
}