1. Packages
  2. Azure Native
  3. API Docs
  4. azuresphere
  5. listCatalogDevices
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.azuresphere.listCatalogDevices

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Lists devices for catalog.

Uses Azure REST API version 2024-04-01.

Other available API versions: 2022-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azuresphere [ApiVersion]. See the version guide for details.

Using listCatalogDevices

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 listCatalogDevices(args: ListCatalogDevicesArgs, opts?: InvokeOptions): Promise<ListCatalogDevicesResult>
function listCatalogDevicesOutput(args: ListCatalogDevicesOutputArgs, opts?: InvokeOptions): Output<ListCatalogDevicesResult>
Copy
def list_catalog_devices(catalog_name: Optional[str] = None,
                         filter: Optional[str] = None,
                         maxpagesize: Optional[int] = None,
                         resource_group_name: Optional[str] = None,
                         skip: Optional[int] = None,
                         top: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> ListCatalogDevicesResult
def list_catalog_devices_output(catalog_name: Optional[pulumi.Input[str]] = None,
                         filter: Optional[pulumi.Input[str]] = None,
                         maxpagesize: Optional[pulumi.Input[int]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         skip: Optional[pulumi.Input[int]] = None,
                         top: Optional[pulumi.Input[int]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[ListCatalogDevicesResult]
Copy
func ListCatalogDevices(ctx *Context, args *ListCatalogDevicesArgs, opts ...InvokeOption) (*ListCatalogDevicesResult, error)
func ListCatalogDevicesOutput(ctx *Context, args *ListCatalogDevicesOutputArgs, opts ...InvokeOption) ListCatalogDevicesResultOutput
Copy

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

public static class ListCatalogDevices 
{
    public static Task<ListCatalogDevicesResult> InvokeAsync(ListCatalogDevicesArgs args, InvokeOptions? opts = null)
    public static Output<ListCatalogDevicesResult> Invoke(ListCatalogDevicesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListCatalogDevicesResult> listCatalogDevices(ListCatalogDevicesArgs args, InvokeOptions options)
public static Output<ListCatalogDevicesResult> listCatalogDevices(ListCatalogDevicesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azuresphere:listCatalogDevices
  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
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Filter string
Filter the result list using the given expression
Maxpagesize int
The maximum number of result items per page.
Skip int
The number of result items to skip.
Top int
The number of result items to return.
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Filter string
Filter the result list using the given expression
Maxpagesize int
The maximum number of result items per page.
Skip int
The number of result items to skip.
Top int
The number of result items to return.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
filter String
Filter the result list using the given expression
maxpagesize Integer
The maximum number of result items per page.
skip Integer
The number of result items to skip.
top Integer
The number of result items to return.
catalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
filter string
Filter the result list using the given expression
maxpagesize number
The maximum number of result items per page.
skip number
The number of result items to skip.
top number
The number of result items to return.
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
Name of catalog
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.
filter str
Filter the result list using the given expression
maxpagesize int
The maximum number of result items per page.
skip int
The number of result items to skip.
top int
The number of result items to return.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
filter String
Filter the result list using the given expression
maxpagesize Number
The maximum number of result items per page.
skip Number
The number of result items to skip.
top Number
The number of result items to return.

listCatalogDevices Result

The following output properties are available:

Value List<Pulumi.AzureNative.AzureSphere.Outputs.DeviceResponse>
The Device items on this page
NextLink string
The link to the next page of items
Value []DeviceResponse
The Device items on this page
NextLink string
The link to the next page of items
value List<DeviceResponse>
The Device items on this page
nextLink String
The link to the next page of items
value DeviceResponse[]
The Device items on this page
nextLink string
The link to the next page of items
value Sequence[DeviceResponse]
The Device items on this page
next_link str
The link to the next page of items
value List<Property Map>
The Device items on this page
nextLink String
The link to the next page of items

Supporting Types

DeviceResponse

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

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
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi