Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azuresphere
  5. getDevice
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.azuresphere.getDevice

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
pulumi/pulumi-azure-native

Get a Device. Use ‘.unassigned’ or ‘.default’ for the device group and product names when a device does not belong to a device group and product. Azure REST API version: 2022-09-01-preview.

Other available API versions: 2024-04-01.

Using getDevice

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 getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>
function getDeviceOutput(args: GetDeviceOutputArgs, opts?: InvokeOptions): Output<GetDeviceResult>
Copy
def get_device(catalog_name: Optional[str] = None,
               device_group_name: Optional[str] = None,
               device_name: Optional[str] = None,
               product_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(catalog_name: Optional[pulumi.Input[str]] = None,
               device_group_name: Optional[pulumi.Input[str]] = None,
               device_name: Optional[pulumi.Input[str]] = None,
               product_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]
Copy
func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput
Copy

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

public static class GetDevice 
{
    public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceResult> Invoke(GetDeviceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
public static Output<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azuresphere:getDevice
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
DeviceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of device group.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
Device name
ProductName
This property is required.
Changes to this property will trigger replacement.
string
Name of product.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
DeviceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of device group.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
Device name
ProductName
This property is required.
Changes to this property will trigger replacement.
string
Name of product.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
deviceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of device group.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
Device name
productName
This property is required.
Changes to this property will trigger replacement.
String
Name of product.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
deviceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of device group.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
Device name
productName
This property is required.
Changes to this property will trigger replacement.
string
Name of product.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
Name of catalog
device_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of device group.
device_name
This property is required.
Changes to this property will trigger replacement.
str
Device name
product_name
This property is required.
Changes to this property will trigger replacement.
str
Name of product.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
deviceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of device group.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
Device name
productName
This property is required.
Changes to this property will trigger replacement.
String
Name of product.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getDevice Result

The following output properties are available:

ChipSku string
SKU of the chip
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastAvailableOsVersion string
OS version available for installation when update requested
LastInstalledOsVersion string
OS version running on device when update requested
LastOsUpdateUtc string
Time when update requested and new OS version available
LastUpdateRequestUtc string
Time when update was last requested
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
SystemData Pulumi.AzureNative.AzureSphere.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DeviceId string
Device ID
ChipSku string
SKU of the chip
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastAvailableOsVersion string
OS version available for installation when update requested
LastInstalledOsVersion string
OS version running on device when update requested
LastOsUpdateUtc string
Time when update requested and new OS version available
LastUpdateRequestUtc string
Time when update was last requested
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DeviceId string
Device ID
chipSku String
SKU of the chip
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastAvailableOsVersion String
OS version available for installation when update requested
lastInstalledOsVersion String
OS version running on device when update requested
lastOsUpdateUtc String
Time when update requested and new OS version available
lastUpdateRequestUtc String
Time when update was last requested
name String
The name of the resource
provisioningState String
The status of the last operation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deviceId String
Device ID
chipSku string
SKU of the chip
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastAvailableOsVersion string
OS version available for installation when update requested
lastInstalledOsVersion string
OS version running on device when update requested
lastOsUpdateUtc string
Time when update requested and new OS version available
lastUpdateRequestUtc string
Time when update was last requested
name string
The name of the resource
provisioningState string
The status of the last operation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deviceId string
Device ID
chip_sku str
SKU of the chip
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_available_os_version str
OS version available for installation when update requested
last_installed_os_version str
OS version running on device when update requested
last_os_update_utc str
Time when update requested and new OS version available
last_update_request_utc str
Time when update was last requested
name str
The name of the resource
provisioning_state str
The status of the last operation.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
device_id str
Device ID
chipSku String
SKU of the chip
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastAvailableOsVersion String
OS version available for installation when update requested
lastInstalledOsVersion String
OS version running on device when update requested
lastOsUpdateUtc String
Time when update requested and new OS version available
lastUpdateRequestUtc String
Time when update was last requested
name String
The name of the resource
provisioningState String
The status of the last operation.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deviceId String
Device ID

Supporting Types

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