1. Packages
  2. Azure Native
  3. API Docs
  4. azuresphere
  5. listCatalogDeviceGroups
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.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.azuresphere.listCatalogDeviceGroups

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.0.1 published on Monday, Apr 7, 2025 by Pulumi

List the device groups for the 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 listCatalogDeviceGroups

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 listCatalogDeviceGroups(args: ListCatalogDeviceGroupsArgs, opts?: InvokeOptions): Promise<ListCatalogDeviceGroupsResult>
function listCatalogDeviceGroupsOutput(args: ListCatalogDeviceGroupsOutputArgs, opts?: InvokeOptions): Output<ListCatalogDeviceGroupsResult>
Copy
def list_catalog_device_groups(catalog_name: Optional[str] = None,
                               device_group_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) -> ListCatalogDeviceGroupsResult
def list_catalog_device_groups_output(catalog_name: Optional[pulumi.Input[str]] = None,
                               device_group_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[ListCatalogDeviceGroupsResult]
Copy
func ListCatalogDeviceGroups(ctx *Context, args *ListCatalogDeviceGroupsArgs, opts ...InvokeOption) (*ListCatalogDeviceGroupsResult, error)
func ListCatalogDeviceGroupsOutput(ctx *Context, args *ListCatalogDeviceGroupsOutputArgs, opts ...InvokeOption) ListCatalogDeviceGroupsResultOutput
Copy

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

public static class ListCatalogDeviceGroups 
{
    public static Task<ListCatalogDeviceGroupsResult> InvokeAsync(ListCatalogDeviceGroupsArgs args, InvokeOptions? opts = null)
    public static Output<ListCatalogDeviceGroupsResult> Invoke(ListCatalogDeviceGroupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListCatalogDeviceGroupsResult> listCatalogDeviceGroups(ListCatalogDeviceGroupsArgs args, InvokeOptions options)
public static Output<ListCatalogDeviceGroupsResult> listCatalogDeviceGroups(ListCatalogDeviceGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azuresphere:listCatalogDeviceGroups
  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.
DeviceGroupName string
Device Group name.
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.
DeviceGroupName string
Device Group name.
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.
deviceGroupName String
Device Group name.
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.
deviceGroupName string
Device Group name.
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.
device_group_name str
Device Group name.
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.
deviceGroupName String
Device Group name.
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.

listCatalogDeviceGroups Result

The following output properties are available:

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

Supporting Types

DeviceGroupResponse

HasDeployment This property is required. bool
Deployment status for the device group.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
AllowCrashDumpsCollection string
Flag to define if the user allows for crash dump collection.
Description string
Description of the device group.
OsFeedType string
Operating system feed type of the device group.
RegionalDataBoundary string
Regional data boundary for the device group.
UpdatePolicy string
Update policy of the device group.
HasDeployment This property is required. bool
Deployment status for the device group.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
AllowCrashDumpsCollection string
Flag to define if the user allows for crash dump collection.
Description string
Description of the device group.
OsFeedType string
Operating system feed type of the device group.
RegionalDataBoundary string
Regional data boundary for the device group.
UpdatePolicy string
Update policy of the device group.
hasDeployment This property is required. Boolean
Deployment status for the device group.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
allowCrashDumpsCollection String
Flag to define if the user allows for crash dump collection.
description String
Description of the device group.
osFeedType String
Operating system feed type of the device group.
regionalDataBoundary String
Regional data boundary for the device group.
updatePolicy String
Update policy of the device group.
hasDeployment This property is required. boolean
Deployment status for the device group.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
allowCrashDumpsCollection string
Flag to define if the user allows for crash dump collection.
description string
Description of the device group.
osFeedType string
Operating system feed type of the device group.
regionalDataBoundary string
Regional data boundary for the device group.
updatePolicy string
Update policy of the device group.
has_deployment This property is required. bool
Deployment status for the device group.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
allow_crash_dumps_collection str
Flag to define if the user allows for crash dump collection.
description str
Description of the device group.
os_feed_type str
Operating system feed type of the device group.
regional_data_boundary str
Regional data boundary for the device group.
update_policy str
Update policy of the device group.
hasDeployment This property is required. Boolean
Deployment status for the device group.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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"
allowCrashDumpsCollection String
Flag to define if the user allows for crash dump collection.
description String
Description of the device group.
osFeedType String
Operating system feed type of the device group.
regionalDataBoundary String
Regional data boundary for the device group.
updatePolicy String
Update policy of the device group.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi