1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getIoTAddon
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.20.0 published on Wednesday, Nov 29, 2023 by Pulumi

azure-native.databoxedge.getIoTAddon

Explore with Pulumi AI

azure-native logo
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.20.0 published on Wednesday, Nov 29, 2023 by Pulumi

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

    Using getIoTAddon

    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 getIoTAddon(args: GetIoTAddonArgs, opts?: InvokeOptions): Promise<GetIoTAddonResult>
    function getIoTAddonOutput(args: GetIoTAddonOutputArgs, opts?: InvokeOptions): Output<GetIoTAddonResult>
    def get_io_t_addon(addon_name: Optional[str] = None,
                       device_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       role_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIoTAddonResult
    def get_io_t_addon_output(addon_name: Optional[pulumi.Input[str]] = None,
                       device_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       role_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIoTAddonResult]
    func LookupIoTAddon(ctx *Context, args *LookupIoTAddonArgs, opts ...InvokeOption) (*LookupIoTAddonResult, error)
    func LookupIoTAddonOutput(ctx *Context, args *LookupIoTAddonOutputArgs, opts ...InvokeOption) LookupIoTAddonResultOutput

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

    public static class GetIoTAddon 
    {
        public static Task<GetIoTAddonResult> InvokeAsync(GetIoTAddonArgs args, InvokeOptions? opts = null)
        public static Output<GetIoTAddonResult> Invoke(GetIoTAddonInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIoTAddonResult> getIoTAddon(GetIoTAddonArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:databoxedge:getIoTAddon
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AddonName string

    The addon name.

    DeviceName string

    The device name.

    ResourceGroupName string

    The resource group name.

    RoleName string

    The role name.

    AddonName string

    The addon name.

    DeviceName string

    The device name.

    ResourceGroupName string

    The resource group name.

    RoleName string

    The role name.

    addonName String

    The addon name.

    deviceName String

    The device name.

    resourceGroupName String

    The resource group name.

    roleName String

    The role name.

    addonName string

    The addon name.

    deviceName string

    The device name.

    resourceGroupName string

    The resource group name.

    roleName string

    The role name.

    addon_name str

    The addon name.

    device_name str

    The device name.

    resource_group_name str

    The resource group name.

    role_name str

    The role name.

    addonName String

    The addon name.

    deviceName String

    The device name.

    resourceGroupName String

    The resource group name.

    roleName String

    The role name.

    getIoTAddon Result

    The following output properties are available:

    HostPlatform string

    Host OS supported by the IoT addon.

    HostPlatformType string

    Platform where the runtime is hosted.

    Id string

    The path ID that uniquely identifies the object.

    IoTDeviceDetails Pulumi.AzureNative.DataBoxEdge.Outputs.IoTDeviceInfoResponse

    IoT device metadata to which appliance needs to be connected.

    IoTEdgeDeviceDetails Pulumi.AzureNative.DataBoxEdge.Outputs.IoTDeviceInfoResponse

    IoT edge device to which the IoT Addon needs to be configured.

    Name string

    The object name.

    ProvisioningState string

    Addon Provisioning State

    SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse

    Metadata pertaining to creation and last modification of Addon

    Type string

    The hierarchical type of the object.

    Version string

    Version of IoT running on the appliance.

    HostPlatform string

    Host OS supported by the IoT addon.

    HostPlatformType string

    Platform where the runtime is hosted.

    Id string

    The path ID that uniquely identifies the object.

    IoTDeviceDetails IoTDeviceInfoResponse

    IoT device metadata to which appliance needs to be connected.

    IoTEdgeDeviceDetails IoTDeviceInfoResponse

    IoT edge device to which the IoT Addon needs to be configured.

    Name string

    The object name.

    ProvisioningState string

    Addon Provisioning State

    SystemData SystemDataResponse

    Metadata pertaining to creation and last modification of Addon

    Type string

    The hierarchical type of the object.

    Version string

    Version of IoT running on the appliance.

    hostPlatform String

    Host OS supported by the IoT addon.

    hostPlatformType String

    Platform where the runtime is hosted.

    id String

    The path ID that uniquely identifies the object.

    ioTDeviceDetails IoTDeviceInfoResponse

    IoT device metadata to which appliance needs to be connected.

    ioTEdgeDeviceDetails IoTDeviceInfoResponse

    IoT edge device to which the IoT Addon needs to be configured.

    name String

    The object name.

    provisioningState String

    Addon Provisioning State

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of Addon

    type String

    The hierarchical type of the object.

    version String

    Version of IoT running on the appliance.

    hostPlatform string

    Host OS supported by the IoT addon.

    hostPlatformType string

    Platform where the runtime is hosted.

    id string

    The path ID that uniquely identifies the object.

    ioTDeviceDetails IoTDeviceInfoResponse

    IoT device metadata to which appliance needs to be connected.

    ioTEdgeDeviceDetails IoTDeviceInfoResponse

    IoT edge device to which the IoT Addon needs to be configured.

    name string

    The object name.

    provisioningState string

    Addon Provisioning State

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of Addon

    type string

    The hierarchical type of the object.

    version string

    Version of IoT running on the appliance.

    host_platform str

    Host OS supported by the IoT addon.

    host_platform_type str

    Platform where the runtime is hosted.

    id str

    The path ID that uniquely identifies the object.

    io_t_device_details IoTDeviceInfoResponse

    IoT device metadata to which appliance needs to be connected.

    io_t_edge_device_details IoTDeviceInfoResponse

    IoT edge device to which the IoT Addon needs to be configured.

    name str

    The object name.

    provisioning_state str

    Addon Provisioning State

    system_data SystemDataResponse

    Metadata pertaining to creation and last modification of Addon

    type str

    The hierarchical type of the object.

    version str

    Version of IoT running on the appliance.

    hostPlatform String

    Host OS supported by the IoT addon.

    hostPlatformType String

    Platform where the runtime is hosted.

    id String

    The path ID that uniquely identifies the object.

    ioTDeviceDetails Property Map

    IoT device metadata to which appliance needs to be connected.

    ioTEdgeDeviceDetails Property Map

    IoT edge device to which the IoT Addon needs to be configured.

    name String

    The object name.

    provisioningState String

    Addon Provisioning State

    systemData Property Map

    Metadata pertaining to creation and last modification of Addon

    type String

    The hierarchical type of the object.

    version String

    Version of IoT running on the appliance.

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

    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.

    SymmetricKeyResponse

    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.20.0 published on Wednesday, Nov 29, 2023 by Pulumi