@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Compute role.
*
* Uses Azure REST API version 2023-07-01. In version 2.x of the Azure Native provider, it used API version 2022-03-01.
*/
export declare class IoTRole extends pulumi.CustomResource {
/**
* Get an existing IoTRole resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): IoTRole;
/**
* Returns true if the given object is an instance of IoTRole. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is IoTRole;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Resource allocation
*/
readonly computeResource: pulumi.Output<outputs.databoxedge.ComputeResourceResponse | undefined>;
/**
* Host OS supported by the IoT role.
*/
readonly hostPlatform: pulumi.Output<string>;
/**
* Platform where the Iot runtime is hosted.
*/
readonly hostPlatformType: pulumi.Output<string>;
/**
* IoT device metadata to which data box edge device needs to be connected.
*/
readonly ioTDeviceDetails: pulumi.Output<outputs.databoxedge.IoTDeviceInfoResponse>;
/**
* Iot edge agent details to download the agent and bootstrap iot runtime.
*/
readonly ioTEdgeAgentInfo: pulumi.Output<outputs.databoxedge.IoTEdgeAgentInfoResponse | undefined>;
/**
* IoT edge device to which the IoT role needs to be configured.
*/
readonly ioTEdgeDeviceDetails: pulumi.Output<outputs.databoxedge.IoTDeviceInfoResponse>;
/**
* Role type.
* Expected value is 'IOT'.
*/
readonly kind: pulumi.Output<"IOT">;
/**
* The object name.
*/
readonly name: pulumi.Output<string>;
/**
* Role status.
*/
readonly roleStatus: pulumi.Output<string>;
/**
* Mount points of shares in role(s).
*/
readonly shareMappings: pulumi.Output<outputs.databoxedge.MountPointMapResponse[] | undefined>;
/**
* Metadata pertaining to creation and last modification of Role
*/
readonly systemData: pulumi.Output<outputs.databoxedge.SystemDataResponse>;
/**
* The hierarchical type of the object.
*/
readonly type: pulumi.Output<string>;
/**
* Create a IoTRole resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: IoTRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a IoTRole resource.
*/
export interface IoTRoleArgs {
/**
* Resource allocation
*/
computeResource?: pulumi.Input<inputs.databoxedge.ComputeResourceArgs>;
/**
* The device name.
*/
deviceName: pulumi.Input<string>;
/**
* Host OS supported by the IoT role.
*/
hostPlatform: pulumi.Input<string | enums.databoxedge.PlatformType>;
/**
* IoT device metadata to which data box edge device needs to be connected.
*/
ioTDeviceDetails: pulumi.Input<inputs.databoxedge.IoTDeviceInfoArgs>;
/**
* Iot edge agent details to download the agent and bootstrap iot runtime.
*/
ioTEdgeAgentInfo?: pulumi.Input<inputs.databoxedge.IoTEdgeAgentInfoArgs>;
/**
* IoT edge device to which the IoT role needs to be configured.
*/
ioTEdgeDeviceDetails: pulumi.Input<inputs.databoxedge.IoTDeviceInfoArgs>;
/**
* Role type.
* Expected value is 'IOT'.
*/
kind: pulumi.Input<"IOT">;
/**
* The role name.
*/
name?: pulumi.Input<string>;
/**
* The resource group name.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Role status.
*/
roleStatus: pulumi.Input<string | enums.databoxedge.RoleStatus>;
/**
* Mount points of shares in role(s).
*/
shareMappings?: pulumi.Input<pulumi.Input<inputs.databoxedge.MountPointMapArgs>[]>;
}