Azure Native v2 v2.90.0, Mar 27 25

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.getIoTRole

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

Using getIoTRole

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.

TypeScript
Python
Go
C#
Java
YAML

function getIoTRole(args: GetIoTRoleArgs, opts?: InvokeOptions): Promise<GetIoTRoleResult>
function getIoTRoleOutput(args: GetIoTRoleOutputArgs, opts?: InvokeOptions): Output<GetIoTRoleResult>

def get_io_t_role(device_name: Optional[str] = None,
                  name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIoTRoleResult
def get_io_t_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[GetIoTRoleResult]

func LookupIoTRole(ctx *Context, args *LookupIoTRoleArgs, opts ...InvokeOption) (*LookupIoTRoleResult, error)
func LookupIoTRoleOutput(ctx *Context, args *LookupIoTRoleOutputArgs, opts ...InvokeOption) LookupIoTRoleResultOutput

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

public static class GetIoTRole 
{
    public static Task<GetIoTRoleResult> InvokeAsync(GetIoTRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetIoTRoleResult> Invoke(GetIoTRoleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIoTRoleResult> getIoTRole(GetIoTRoleArgs args, InvokeOptions options)
public static Output<GetIoTRoleResult> getIoTRole(GetIoTRoleArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:databoxedge:getIoTRole
  arguments:
    # arguments dictionary

The following arguments are supported:

DeviceName string: The device name.
Name string: The role name.
ResourceGroupName string: The resource group name.

DeviceName string: The device name.
Name string: The role name.
ResourceGroupName string: The resource group name.

deviceName String: The device name.
name String: The role name.
resourceGroupName String: The resource group name.

deviceName string: The device name.
name string: The role name.
resourceGroupName string: The resource group name.

device_name str: The device name.
name str: The role name.
resource_group_name str: The resource group name.

deviceName String: The device name.
name String: The role name.
resourceGroupName String: The resource group name.

getIoTRole Result

The following output properties are available:

HostPlatform string: Host OS supported by the IoT role.
HostPlatformType string: Platform where the Iot runtime is hosted.
Id string: The path ID that uniquely identifies the object.
IoTDeviceDetails Pulumi.AzureNative.DataBoxEdge.Outputs.IoTDeviceInfoResponse: IoT device metadata to which data box edge device needs to be connected.
IoTEdgeDeviceDetails Pulumi.AzureNative.DataBoxEdge.Outputs.IoTDeviceInfoResponse: IoT edge device to which the IoT role needs to be configured.
Name string: The object name.
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.
ComputeResource Pulumi.AzureNative.DataBoxEdge.Outputs.ComputeResourceResponse: Resource allocation
IoTEdgeAgentInfo Pulumi.AzureNative.DataBoxEdge.Outputs.IoTEdgeAgentInfoResponse: Iot edge agent details to download the agent and bootstrap iot runtime.
ShareMappings List<Pulumi.AzureNative.DataBoxEdge.Outputs.MountPointMapResponse>: Mount points of shares in role(s).

HostPlatform string: Host OS supported by the IoT role.
HostPlatformType string: Platform where the Iot runtime is hosted.
Id string: The path ID that uniquely identifies the object.
IoTDeviceDetails IoTDeviceInfoResponse: IoT device metadata to which data box edge device needs to be connected.
IoTEdgeDeviceDetails IoTDeviceInfoResponse: IoT edge device to which the IoT role needs to be configured.
Name string: The object name.
RoleStatus string: Role status.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of Role
Type string: The hierarchical type of the object.
ComputeResource ComputeResourceResponse: Resource allocation
IoTEdgeAgentInfo IoTEdgeAgentInfoResponse: Iot edge agent details to download the agent and bootstrap iot runtime.
ShareMappings []MountPointMapResponse: Mount points of shares in role(s).

hostPlatform String: Host OS supported by the IoT role.
hostPlatformType String: Platform where the Iot runtime is hosted.
id String: The path ID that uniquely identifies the object.
ioTDeviceDetails IoTDeviceInfoResponse: IoT device metadata to which data box edge device needs to be connected.
ioTEdgeDeviceDetails IoTDeviceInfoResponse: IoT edge device to which the IoT role needs to be configured.
name String: The object name.
roleStatus String: Role status.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of Role
type String: The hierarchical type of the object.
computeResource ComputeResourceResponse: Resource allocation
ioTEdgeAgentInfo IoTEdgeAgentInfoResponse: Iot edge agent details to download the agent and bootstrap iot runtime.
shareMappings List<MountPointMapResponse>: Mount points of shares in role(s).

hostPlatform string: Host OS supported by the IoT role.
hostPlatformType string: Platform where the Iot runtime is hosted.
id string: The path ID that uniquely identifies the object.
ioTDeviceDetails IoTDeviceInfoResponse: IoT device metadata to which data box edge device needs to be connected.
ioTEdgeDeviceDetails IoTDeviceInfoResponse: IoT edge device to which the IoT role needs to be configured.
name string: The object name.
roleStatus string: Role status.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of Role
type string: The hierarchical type of the object.
computeResource ComputeResourceResponse: Resource allocation
ioTEdgeAgentInfo IoTEdgeAgentInfoResponse: Iot edge agent details to download the agent and bootstrap iot runtime.
shareMappings MountPointMapResponse[]: Mount points of shares in role(s).

host_platform str: Host OS supported by the IoT role.
host_platform_type str: Platform where the Iot runtime is hosted.
id str: The path ID that uniquely identifies the object.
io_t_device_details IoTDeviceInfoResponse: IoT device metadata to which data box edge device needs to be connected.
io_t_edge_device_details IoTDeviceInfoResponse: IoT edge device to which the IoT role needs to be configured.
name str: The object name.
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.
compute_resource ComputeResourceResponse: Resource allocation
io_t_edge_agent_info IoTEdgeAgentInfoResponse: Iot edge agent details to download the agent and bootstrap iot runtime.
share_mappings Sequence[MountPointMapResponse]: Mount points of shares in role(s).

hostPlatform String: Host OS supported by the IoT role.
hostPlatformType String: Platform where the Iot runtime is hosted.
id String: The path ID that uniquely identifies the object.
ioTDeviceDetails Property Map: IoT device metadata to which data box edge device needs to be connected.
ioTEdgeDeviceDetails Property Map: IoT edge device to which the IoT role needs to be configured.
name String: The object name.
roleStatus String: Role status.
systemData Property Map: Metadata pertaining to creation and last modification of Role
type String: The hierarchical type of the object.
computeResource Property Map: Resource allocation
ioTEdgeAgentInfo Property Map: Iot edge agent details to download the agent and bootstrap iot runtime.
shareMappings List<Property Map>: Mount points of shares in role(s).

Supporting Types

AsymmetricEncryptedSecretResponse

EncryptionAlgorithm string: The algorithm used to encrypt "Value".
Value string: The value of the secret.
EncryptionCertThumbprint string: Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

EncryptionAlgorithm string: The algorithm used to encrypt "Value".
Value string: The value of the secret.
EncryptionCertThumbprint string: Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

encryptionAlgorithm String: The algorithm used to encrypt "Value".
value String: The value of the secret.
encryptionCertThumbprint String: Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

encryptionAlgorithm string: The algorithm used to encrypt "Value".
value string: The value of the secret.
encryptionCertThumbprint string: Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

encryption_algorithm str: The algorithm used to encrypt "Value".
value str: The value of the secret.
encryption_cert_thumbprint str: Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

encryptionAlgorithm String: The algorithm used to encrypt "Value".
value String: The value of the secret.
encryptionCertThumbprint String: Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

AuthenticationResponse

SymmetricKey Pulumi.AzureNative.DataBoxEdge.Inputs.SymmetricKeyResponse: Symmetric key for authentication.

SymmetricKey SymmetricKeyResponse: Symmetric key for authentication.

symmetricKey SymmetricKeyResponse: Symmetric key for authentication.

symmetricKey SymmetricKeyResponse: Symmetric key for authentication.

symmetric_key SymmetricKeyResponse: Symmetric key for authentication.

symmetricKey Property Map: Symmetric key for authentication.

ComputeResourceResponse

MemoryInGB double: Memory in GB
ProcessorCount int: Processor count

MemoryInGB float64: Memory in GB
ProcessorCount int: Processor count

memoryInGB Double: Memory in GB
processorCount Integer: Processor count

memoryInGB number: Memory in GB
processorCount number: Processor count

memory_in_gb float: Memory in GB
processor_count int: Processor count

memoryInGB Number: Memory in GB
processorCount Number: Processor count

ImageRepositoryCredentialResponse

ImageRepositoryUrl string: Image repository url (e.g.: mcr.microsoft.com).
UserName string: Repository user name.
Password Pulumi.AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretResponse: Repository user password.

ImageRepositoryUrl string: Image repository url (e.g.: mcr.microsoft.com).
UserName string: Repository user name.
Password AsymmetricEncryptedSecretResponse: Repository user password.

imageRepositoryUrl String: Image repository url (e.g.: mcr.microsoft.com).
userName String: Repository user name.
password AsymmetricEncryptedSecretResponse: Repository user password.

imageRepositoryUrl string: Image repository url (e.g.: mcr.microsoft.com).
userName string: Repository user name.
password AsymmetricEncryptedSecretResponse: Repository user password.

image_repository_url str: Image repository url (e.g.: mcr.microsoft.com).
user_name str: Repository user name.
password AsymmetricEncryptedSecretResponse: Repository user password.

imageRepositoryUrl String: Image repository url (e.g.: mcr.microsoft.com).
userName String: Repository user name.
password Property Map: Repository user password.

IoTDeviceInfoResponse

DeviceId string: ID of the IoT device/edge device.
IoTHostHub string: Host name for the IoT hub associated to the device.
Authentication Pulumi.AzureNative.DataBoxEdge.Inputs.AuthenticationResponse: Encrypted IoT device/IoT edge device connection string.
IoTHostHubId string: Id for the IoT hub associated to the device.

DeviceId string: ID of the IoT device/edge device.
IoTHostHub string: Host name for the IoT hub associated to the device.
Authentication AuthenticationResponse: Encrypted IoT device/IoT edge device connection string.
IoTHostHubId string: Id for the IoT hub associated to the device.

deviceId String: ID of the IoT device/edge device.
ioTHostHub String: Host name for the IoT hub associated to the device.
authentication AuthenticationResponse: Encrypted IoT device/IoT edge device connection string.
ioTHostHubId String: Id for the IoT hub associated to the device.

deviceId string: ID of the IoT device/edge device.
ioTHostHub string: Host name for the IoT hub associated to the device.
authentication AuthenticationResponse: Encrypted IoT device/IoT edge device connection string.
ioTHostHubId string: Id for the IoT hub associated to the device.

device_id str: ID of the IoT device/edge device.
io_t_host_hub str: Host name for the IoT hub associated to the device.
authentication AuthenticationResponse: Encrypted IoT device/IoT edge device connection string.
io_t_host_hub_id str: Id for the IoT hub associated to the device.

deviceId String: ID of the IoT device/edge device.
ioTHostHub String: Host name for the IoT hub associated to the device.
authentication Property Map: Encrypted IoT device/IoT edge device connection string.
ioTHostHubId String: Id for the IoT hub associated to the device.

IoTEdgeAgentInfoResponse

ImageName string: Name of the IoT edge agent image.
Tag string: Image Tag.
ImageRepository Pulumi.AzureNative.DataBoxEdge.Inputs.ImageRepositoryCredentialResponse: Image repository details.

ImageName string: Name of the IoT edge agent image.
Tag string: Image Tag.
ImageRepository ImageRepositoryCredentialResponse: Image repository details.

imageName String: Name of the IoT edge agent image.
tag String: Image Tag.
imageRepository ImageRepositoryCredentialResponse: Image repository details.

imageName string: Name of the IoT edge agent image.
tag string: Image Tag.
imageRepository ImageRepositoryCredentialResponse: Image repository details.

image_name str: Name of the IoT edge agent image.
tag str: Image Tag.
image_repository ImageRepositoryCredentialResponse: Image repository details.

imageName String: Name of the IoT edge agent image.
tag String: Image Tag.
imageRepository Property Map: Image repository details.

MountPointMapResponse

MountPoint string: Mount point for the share.
MountType string: Mounting type.
RoleId string: ID of the role to which share is mounted.
RoleType string: Role type.
ShareId string: ID of the share mounted to the role VM.

MountPoint string: Mount point for the share.
MountType string: Mounting type.
RoleId string: ID of the role to which share is mounted.
RoleType string: Role type.
ShareId string: ID of the share mounted to the role VM.

mountPoint String: Mount point for the share.
mountType String: Mounting type.
roleId String: ID of the role to which share is mounted.
roleType String: Role type.
shareId String: ID of the share mounted to the role VM.

mountPoint string: Mount point for the share.
mountType string: Mounting type.
roleId string: ID of the role to which share is mounted.
roleType string: Role type.
shareId string: ID of the share mounted to the role VM.

mount_point str: Mount point for the share.
mount_type str: Mounting type.
role_id str: ID of the role to which share is mounted.
role_type str: Role type.
share_id str: ID of the share mounted to the role VM.

mountPoint String: Mount point for the share.
mountType String: Mounting type.
roleId String: ID of the role to which share is mounted.
roleType String: Role type.
shareId String: ID of the share mounted to the role VM.

SymmetricKeyResponse

ConnectionString Pulumi.AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretResponse: Connection string based on the symmetric key.

ConnectionString AsymmetricEncryptedSecretResponse: Connection string based on the symmetric key.

connectionString AsymmetricEncryptedSecretResponse: Connection string based on the symmetric key.

connectionString AsymmetricEncryptedSecretResponse: Connection string based on the symmetric key.

connection_string AsymmetricEncryptedSecretResponse: Connection string based on the symmetric key.

connectionString Property Map: Connection string based on the symmetric key.

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

pulumi/pulumi-azure-native

azure-native-v2.databoxedge.getIoTRole

On this page

On this page

Using getIoTRole

getIoTRole Result

Supporting Types

AsymmetricEncryptedSecretResponse

AuthenticationResponse

ComputeResourceResponse

ImageRepositoryCredentialResponse

IoTDeviceInfoResponse

IoTEdgeAgentInfoResponse

MountPointMapResponse

SymmetricKeyResponse

SystemDataResponse

Package Details

On this page

On this page