This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
azure-native.databoxedge.getIoTRole
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
Gets a specific role by name. Azure REST API version: 2022-03-01.
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:databoxedge:getIoTRole
arguments:
# arguments dictionary
The following arguments are supported:
- Device
Name string - The device name.
- Name string
- The role name.
- Resource
Group stringName - The resource group name.
- Device
Name string - The device name.
- Name string
- The role name.
- Resource
Group stringName - The resource group name.
- device
Name String - The device name.
- name String
- The role name.
- resource
Group StringName - The resource group name.
- device
Name string - The device name.
- name string
- The role name.
- resource
Group stringName - The resource group name.
- device_
name str - The device name.
- name str
- The role name.
- resource_
group_ strname - The resource group name.
- device
Name String - The device name.
- name String
- The role name.
- resource
Group StringName - The resource group name.
getIoTRole Result
The following output properties are available:
- Host
Platform string - Host OS supported by the IoT role.
- Host
Platform stringType - Platform where the Iot runtime is hosted.
- Id string
- The path ID that uniquely identifies the object.
- Io
TDevice Pulumi.Details Azure Native. Data Box Edge. Outputs. Io TDevice Info Response - IoT device metadata to which data box edge device needs to be connected.
- Io
TEdge Pulumi.Device Details Azure Native. Data Box Edge. Outputs. Io TDevice Info Response - IoT edge device to which the IoT role needs to be configured.
- Name string
- The object name.
- Role
Status string - Role status.
- System
Data Pulumi.Azure Native. Data Box Edge. Outputs. System Data Response - Metadata pertaining to creation and last modification of Role
- Type string
- The hierarchical type of the object.
- Compute
Resource Pulumi.Azure Native. Data Box Edge. Outputs. Compute Resource Response - Resource allocation
- Io
TEdge Pulumi.Agent Info Azure Native. Data Box Edge. Outputs. Io TEdge Agent Info Response - Iot edge agent details to download the agent and bootstrap iot runtime.
- List<Pulumi.
Azure Native. Data Box Edge. Outputs. Mount Point Map Response> - Mount points of shares in role(s).
- Host
Platform string - Host OS supported by the IoT role.
- Host
Platform stringType - Platform where the Iot runtime is hosted.
- Id string
- The path ID that uniquely identifies the object.
- Io
TDevice IoDetails TDevice Info Response - IoT device metadata to which data box edge device needs to be connected.
- Io
TEdge IoDevice Details TDevice Info Response - IoT edge device to which the IoT role needs to be configured.
- Name string
- The object name.
- Role
Status string - Role status.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of Role
- Type string
- The hierarchical type of the object.
- Compute
Resource ComputeResource Response - Resource allocation
- Io
TEdge IoAgent Info TEdge Agent Info Response - Iot edge agent details to download the agent and bootstrap iot runtime.
- []Mount
Point Map Response - Mount points of shares in role(s).
- host
Platform String - Host OS supported by the IoT role.
- host
Platform StringType - Platform where the Iot runtime is hosted.
- id String
- The path ID that uniquely identifies the object.
- io
TDevice IoDetails TDevice Info Response - IoT device metadata to which data box edge device needs to be connected.
- io
TEdge IoDevice Details TDevice Info Response - IoT edge device to which the IoT role needs to be configured.
- name String
- The object name.
- role
Status String - Role status.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of Role
- type String
- The hierarchical type of the object.
- compute
Resource ComputeResource Response - Resource allocation
- io
TEdge IoAgent Info TEdge Agent Info Response - Iot edge agent details to download the agent and bootstrap iot runtime.
- List<Mount
Point Map Response> - Mount points of shares in role(s).
- host
Platform string - Host OS supported by the IoT role.
- host
Platform stringType - Platform where the Iot runtime is hosted.
- id string
- The path ID that uniquely identifies the object.
- io
TDevice IoDetails TDevice Info Response - IoT device metadata to which data box edge device needs to be connected.
- io
TEdge IoDevice Details TDevice Info Response - IoT edge device to which the IoT role needs to be configured.
- name string
- The object name.
- role
Status string - Role status.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of Role
- type string
- The hierarchical type of the object.
- compute
Resource ComputeResource Response - Resource allocation
- io
TEdge IoAgent Info TEdge Agent Info Response - Iot edge agent details to download the agent and bootstrap iot runtime.
- Mount
Point Map Response[] - Mount points of shares in role(s).
- host_
platform str - Host OS supported by the IoT role.
- host_
platform_ strtype - Platform where the Iot runtime is hosted.
- id str
- The path ID that uniquely identifies the object.
- io_
t_ Iodevice_ details TDevice Info Response - IoT device metadata to which data box edge device needs to be connected.
- io_
t_ Ioedge_ device_ details TDevice Info Response - IoT edge device to which the IoT role needs to be configured.
- name str
- The object name.
- role_
status str - Role status.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of Role
- type str
- The hierarchical type of the object.
- compute_
resource ComputeResource Response - Resource allocation
- io_
t_ Ioedge_ agent_ info TEdge Agent Info Response - Iot edge agent details to download the agent and bootstrap iot runtime.
- Sequence[Mount
Point Map Response] - Mount points of shares in role(s).
- host
Platform String - Host OS supported by the IoT role.
- host
Platform StringType - Platform where the Iot runtime is hosted.
- id String
- The path ID that uniquely identifies the object.
- io
TDevice Property MapDetails - IoT device metadata to which data box edge device needs to be connected.
- io
TEdge Property MapDevice Details - IoT edge device to which the IoT role needs to be configured.
- name String
- The object name.
- role
Status String - Role status.
- system
Data Property Map - Metadata pertaining to creation and last modification of Role
- type String
- The hierarchical type of the object.
- compute
Resource Property Map - Resource allocation
- io
TEdge Property MapAgent Info - Iot edge agent details to download the agent and bootstrap iot runtime.
- List<Property Map>
- Mount points of shares in role(s).
Supporting Types
AsymmetricEncryptedSecretResponse
- Encryption
Algorithm string - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- Encryption
Algorithm string - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm string - The algorithm used to encrypt "Value".
- value string
- The value of the secret.
- encryption
Cert stringThumbprint - 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_ strthumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
AuthenticationResponse
- Symmetric
Key Pulumi.Azure Native. Data Box Edge. Inputs. Symmetric Key Response - Symmetric key for authentication.
- Symmetric
Key SymmetricKey Response - Symmetric key for authentication.
- symmetric
Key SymmetricKey Response - Symmetric key for authentication.
- symmetric
Key SymmetricKey Response - Symmetric key for authentication.
- symmetric_
key SymmetricKey Response - Symmetric key for authentication.
- symmetric
Key Property Map - Symmetric key for authentication.
ComputeResourceResponse
- Memory
In doubleGB - Memory in GB
- Processor
Count int - Processor count
- Memory
In float64GB - Memory in GB
- Processor
Count int - Processor count
- memory
In DoubleGB - Memory in GB
- processor
Count Integer - Processor count
- memory
In numberGB - Memory in GB
- processor
Count number - Processor count
- memory_
in_ floatgb - Memory in GB
- processor_
count int - Processor count
- memory
In NumberGB - Memory in GB
- processor
Count Number - Processor count
ImageRepositoryCredentialResponse
- Image
Repository stringUrl - Image repository url (e.g.: mcr.microsoft.com).
- User
Name string - Repository user name.
- Password
Pulumi.
Azure Native. Data Box Edge. Inputs. Asymmetric Encrypted Secret Response - Repository user password.
- Image
Repository stringUrl - Image repository url (e.g.: mcr.microsoft.com).
- User
Name string - Repository user name.
- Password
Asymmetric
Encrypted Secret Response - Repository user password.
- image
Repository StringUrl - Image repository url (e.g.: mcr.microsoft.com).
- user
Name String - Repository user name.
- password
Asymmetric
Encrypted Secret Response - Repository user password.
- image
Repository stringUrl - Image repository url (e.g.: mcr.microsoft.com).
- user
Name string - Repository user name.
- password
Asymmetric
Encrypted Secret Response - Repository user password.
- image_
repository_ strurl - Image repository url (e.g.: mcr.microsoft.com).
- user_
name str - Repository user name.
- password
Asymmetric
Encrypted Secret Response - Repository user password.
- image
Repository StringUrl - Image repository url (e.g.: mcr.microsoft.com).
- user
Name String - Repository user name.
- password Property Map
- Repository user password.
IoTDeviceInfoResponse
- Device
Id string - ID of the IoT device/edge device.
- Io
THost stringHub - Host name for the IoT hub associated to the device.
- Authentication
Pulumi.
Azure Native. Data Box Edge. Inputs. Authentication Response - Encrypted IoT device/IoT edge device connection string.
- Io
THost stringHub Id - Id for the IoT hub associated to the device.
- Device
Id string - ID of the IoT device/edge device.
- Io
THost stringHub - Host name for the IoT hub associated to the device.
- Authentication
Authentication
Response - Encrypted IoT device/IoT edge device connection string.
- Io
THost stringHub Id - Id for the IoT hub associated to the device.
- device
Id String - ID of the IoT device/edge device.
- io
THost StringHub - Host name for the IoT hub associated to the device.
- authentication
Authentication
Response - Encrypted IoT device/IoT edge device connection string.
- io
THost StringHub Id - Id for the IoT hub associated to the device.
- device
Id string - ID of the IoT device/edge device.
- io
THost stringHub - Host name for the IoT hub associated to the device.
- authentication
Authentication
Response - Encrypted IoT device/IoT edge device connection string.
- io
THost stringHub Id - Id for the IoT hub associated to the device.
- device_
id str - ID of the IoT device/edge device.
- io_
t_ strhost_ hub - Host name for the IoT hub associated to the device.
- authentication
Authentication
Response - Encrypted IoT device/IoT edge device connection string.
- io_
t_ strhost_ hub_ id - Id for the IoT hub associated to the device.
- device
Id String - ID of the IoT device/edge device.
- io
THost StringHub - Host name for the IoT hub associated to the device.
- authentication Property Map
- Encrypted IoT device/IoT edge device connection string.
- io
THost StringHub Id - Id for the IoT hub associated to the device.
IoTEdgeAgentInfoResponse
- Image
Name string - Name of the IoT edge agent image.
- Tag string
- Image Tag.
- Image
Repository Pulumi.Azure Native. Data Box Edge. Inputs. Image Repository Credential Response - Image repository details.
- Image
Name string - Name of the IoT edge agent image.
- Tag string
- Image Tag.
- Image
Repository ImageRepository Credential Response - Image repository details.
- image
Name String - Name of the IoT edge agent image.
- tag String
- Image Tag.
- image
Repository ImageRepository Credential Response - Image repository details.
- image
Name string - Name of the IoT edge agent image.
- tag string
- Image Tag.
- image
Repository ImageRepository Credential Response - Image repository details.
- image_
name str - Name of the IoT edge agent image.
- tag str
- Image Tag.
- image_
repository ImageRepository Credential Response - Image repository details.
- image
Name String - Name of the IoT edge agent image.
- tag String
- Image Tag.
- image
Repository Property Map - Image repository details.
MountPointMapResponse
- Mount
Point string - Mount point for the share.
- Mount
Type string - Mounting type.
- Role
Id string - ID of the role to which share is mounted.
- Role
Type string - Role type.
- string
- ID of the share mounted to the role VM.
- Mount
Point string - Mount point for the share.
- Mount
Type string - Mounting type.
- Role
Id string - ID of the role to which share is mounted.
- Role
Type string - Role type.
- string
- ID of the share mounted to the role VM.
- mount
Point String - Mount point for the share.
- mount
Type String - Mounting type.
- role
Id String - ID of the role to which share is mounted.
- role
Type String - Role type.
- String
- ID of the share mounted to the role VM.
- mount
Point string - Mount point for the share.
- mount
Type string - Mounting type.
- role
Id string - ID of the role to which share is mounted.
- role
Type string - Role type.
- 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.
- str
- ID of the share mounted to the role VM.
- mount
Point String - Mount point for the share.
- mount
Type String - Mounting type.
- role
Id String - ID of the role to which share is mounted.
- role
Type String - Role type.
- String
- ID of the share mounted to the role VM.
SymmetricKeyResponse
- Connection
String Pulumi.Azure Native. Data Box Edge. Inputs. Asymmetric Encrypted Secret Response - Connection string based on the symmetric key.
- Connection
String AsymmetricEncrypted Secret Response - Connection string based on the symmetric key.
- connection
String AsymmetricEncrypted Secret Response - Connection string based on the symmetric key.
- connection
String AsymmetricEncrypted Secret Response - Connection string based on the symmetric key.
- connection_
string AsymmetricEncrypted Secret Response - Connection string based on the symmetric key.
- connection
String Property Map - Connection string based on the symmetric key.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi