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

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

An device group resource belonging to a product resource. Azure REST API version: 2022-09-01-preview. Prior API version in Azure Native 1.x: 2022-09-01-preview.

Other available API versions: 2024-04-01.

Example Usage

DeviceGroups_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var deviceGroup = new AzureNative.AzureSphere.DeviceGroup("deviceGroup", new()
    {
        CatalogName = "MyCatalog1",
        Description = "Description for MyDeviceGroup1",
        DeviceGroupName = "MyDeviceGroup1",
        OsFeedType = AzureNative.AzureSphere.OSFeedType.Retail,
        ProductName = "MyProduct1",
        ResourceGroupName = "MyResourceGroup1",
        UpdatePolicy = AzureNative.AzureSphere.UpdatePolicy.UpdateAll,
    });

});
Copy
package main

import (
	azuresphere "github.com/pulumi/pulumi-azure-native-sdk/azuresphere/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuresphere.NewDeviceGroup(ctx, "deviceGroup", &azuresphere.DeviceGroupArgs{
			CatalogName:       pulumi.String("MyCatalog1"),
			Description:       pulumi.String("Description for MyDeviceGroup1"),
			DeviceGroupName:   pulumi.String("MyDeviceGroup1"),
			OsFeedType:        pulumi.String(azuresphere.OSFeedTypeRetail),
			ProductName:       pulumi.String("MyProduct1"),
			ResourceGroupName: pulumi.String("MyResourceGroup1"),
			UpdatePolicy:      pulumi.String(azuresphere.UpdatePolicyUpdateAll),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azuresphere.DeviceGroup;
import com.pulumi.azurenative.azuresphere.DeviceGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var deviceGroup = new DeviceGroup("deviceGroup", DeviceGroupArgs.builder()
            .catalogName("MyCatalog1")
            .description("Description for MyDeviceGroup1")
            .deviceGroupName("MyDeviceGroup1")
            .osFeedType("Retail")
            .productName("MyProduct1")
            .resourceGroupName("MyResourceGroup1")
            .updatePolicy("UpdateAll")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const deviceGroup = new azure_native.azuresphere.DeviceGroup("deviceGroup", {
    catalogName: "MyCatalog1",
    description: "Description for MyDeviceGroup1",
    deviceGroupName: "MyDeviceGroup1",
    osFeedType: azure_native.azuresphere.OSFeedType.Retail,
    productName: "MyProduct1",
    resourceGroupName: "MyResourceGroup1",
    updatePolicy: azure_native.azuresphere.UpdatePolicy.UpdateAll,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

device_group = azure_native.azuresphere.DeviceGroup("deviceGroup",
    catalog_name="MyCatalog1",
    description="Description for MyDeviceGroup1",
    device_group_name="MyDeviceGroup1",
    os_feed_type=azure_native.azuresphere.OSFeedType.RETAIL,
    product_name="MyProduct1",
    resource_group_name="MyResourceGroup1",
    update_policy=azure_native.azuresphere.UpdatePolicy.UPDATE_ALL)
Copy
resources:
  deviceGroup:
    type: azure-native:azuresphere:DeviceGroup
    properties:
      catalogName: MyCatalog1
      description: Description for MyDeviceGroup1
      deviceGroupName: MyDeviceGroup1
      osFeedType: Retail
      productName: MyProduct1
      resourceGroupName: MyResourceGroup1
      updatePolicy: UpdateAll
Copy

Create DeviceGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DeviceGroup(name: string, args: DeviceGroupArgs, opts?: CustomResourceOptions);
@overload
def DeviceGroup(resource_name: str,
                args: DeviceGroupArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def DeviceGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                catalog_name: Optional[str] = None,
                product_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                allow_crash_dumps_collection: Optional[Union[str, AllowCrashDumpCollection]] = None,
                description: Optional[str] = None,
                device_group_name: Optional[str] = None,
                os_feed_type: Optional[Union[str, OSFeedType]] = None,
                regional_data_boundary: Optional[Union[str, RegionalDataBoundary]] = None,
                update_policy: Optional[Union[str, UpdatePolicy]] = None)
func NewDeviceGroup(ctx *Context, name string, args DeviceGroupArgs, opts ...ResourceOption) (*DeviceGroup, error)
public DeviceGroup(string name, DeviceGroupArgs args, CustomResourceOptions? opts = null)
public DeviceGroup(String name, DeviceGroupArgs args)
public DeviceGroup(String name, DeviceGroupArgs args, CustomResourceOptions options)

type: azure-native:azuresphere:DeviceGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var deviceGroupResource = new AzureNative.Azuresphere.DeviceGroup("deviceGroupResource", new()
{
    CatalogName = "string",
    ProductName = "string",
    ResourceGroupName = "string",
    AllowCrashDumpsCollection = "string",
    Description = "string",
    DeviceGroupName = "string",
    OsFeedType = "string",
    RegionalDataBoundary = "string",
    UpdatePolicy = "string",
});
Copy
example, err := azuresphere.NewDeviceGroup(ctx, "deviceGroupResource", &azuresphere.DeviceGroupArgs{
	CatalogName:               "string",
	ProductName:               "string",
	ResourceGroupName:         "string",
	AllowCrashDumpsCollection: "string",
	Description:               "string",
	DeviceGroupName:           "string",
	OsFeedType:                "string",
	RegionalDataBoundary:      "string",
	UpdatePolicy:              "string",
})
Copy
var deviceGroupResource = new DeviceGroup("deviceGroupResource", DeviceGroupArgs.builder()
    .catalogName("string")
    .productName("string")
    .resourceGroupName("string")
    .allowCrashDumpsCollection("string")
    .description("string")
    .deviceGroupName("string")
    .osFeedType("string")
    .regionalDataBoundary("string")
    .updatePolicy("string")
    .build());
Copy
device_group_resource = azure_native.azuresphere.DeviceGroup("deviceGroupResource",
    catalog_name=string,
    product_name=string,
    resource_group_name=string,
    allow_crash_dumps_collection=string,
    description=string,
    device_group_name=string,
    os_feed_type=string,
    regional_data_boundary=string,
    update_policy=string)
Copy
const deviceGroupResource = new azure_native.azuresphere.DeviceGroup("deviceGroupResource", {
    catalogName: "string",
    productName: "string",
    resourceGroupName: "string",
    allowCrashDumpsCollection: "string",
    description: "string",
    deviceGroupName: "string",
    osFeedType: "string",
    regionalDataBoundary: "string",
    updatePolicy: "string",
});
Copy
type: azure-native:azuresphere:DeviceGroup
properties:
    allowCrashDumpsCollection: string
    catalogName: string
    description: string
    deviceGroupName: string
    osFeedType: string
    productName: string
    regionalDataBoundary: string
    resourceGroupName: string
    updatePolicy: string
Copy

DeviceGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DeviceGroup resource accepts the following input properties:

CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
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.
AllowCrashDumpsCollection string | Pulumi.AzureNative.AzureSphere.AllowCrashDumpCollection
Flag to define if the user allows for crash dump collection.
Description string
Description of the device group.
DeviceGroupName Changes to this property will trigger replacement. string
Name of device group.
OsFeedType string | Pulumi.AzureNative.AzureSphere.OSFeedType
Operating system feed type of the device group.
RegionalDataBoundary Changes to this property will trigger replacement. string | Pulumi.AzureNative.AzureSphere.RegionalDataBoundary
Regional data boundary for the device group.
UpdatePolicy string | Pulumi.AzureNative.AzureSphere.UpdatePolicy
Update policy of the device group.
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
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.
AllowCrashDumpsCollection string | AllowCrashDumpCollection
Flag to define if the user allows for crash dump collection.
Description string
Description of the device group.
DeviceGroupName Changes to this property will trigger replacement. string
Name of device group.
OsFeedType string | OSFeedType
Operating system feed type of the device group.
RegionalDataBoundary Changes to this property will trigger replacement. string | RegionalDataBoundary
Regional data boundary for the device group.
UpdatePolicy string | UpdatePolicy
Update policy of the device group.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
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.
allowCrashDumpsCollection String | AllowCrashDumpCollection
Flag to define if the user allows for crash dump collection.
description String
Description of the device group.
deviceGroupName Changes to this property will trigger replacement. String
Name of device group.
osFeedType String | OSFeedType
Operating system feed type of the device group.
regionalDataBoundary Changes to this property will trigger replacement. String | RegionalDataBoundary
Regional data boundary for the device group.
updatePolicy String | UpdatePolicy
Update policy of the device group.
catalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
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.
allowCrashDumpsCollection string | AllowCrashDumpCollection
Flag to define if the user allows for crash dump collection.
description string
Description of the device group.
deviceGroupName Changes to this property will trigger replacement. string
Name of device group.
osFeedType string | OSFeedType
Operating system feed type of the device group.
regionalDataBoundary Changes to this property will trigger replacement. string | RegionalDataBoundary
Regional data boundary for the device group.
updatePolicy string | UpdatePolicy
Update policy of the device group.
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
Name of catalog
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.
allow_crash_dumps_collection str | AllowCrashDumpCollection
Flag to define if the user allows for crash dump collection.
description str
Description of the device group.
device_group_name Changes to this property will trigger replacement. str
Name of device group.
os_feed_type str | OSFeedType
Operating system feed type of the device group.
regional_data_boundary Changes to this property will trigger replacement. str | RegionalDataBoundary
Regional data boundary for the device group.
update_policy str | UpdatePolicy
Update policy of the device group.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
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.
allowCrashDumpsCollection String | "Enabled" | "Disabled"
Flag to define if the user allows for crash dump collection.
description String
Description of the device group.
deviceGroupName Changes to this property will trigger replacement. String
Name of device group.
osFeedType String | "Retail" | "RetailEval"
Operating system feed type of the device group.
regionalDataBoundary Changes to this property will trigger replacement. String | "None" | "EU"
Regional data boundary for the device group.
updatePolicy String | "UpdateAll" | "No3rdPartyAppUpdates"
Update policy of the device group.

Outputs

All input properties are implicitly available as output properties. Additionally, the DeviceGroup resource produces the following output properties:

HasDeployment bool
Deployment status for the device group.
Id string
The provider-assigned unique ID for this managed resource.
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"
HasDeployment bool
Deployment status for the device group.
Id string
The provider-assigned unique ID for this managed resource.
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"
hasDeployment Boolean
Deployment status for the device group.
id String
The provider-assigned unique ID for this managed resource.
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"
hasDeployment boolean
Deployment status for the device group.
id string
The provider-assigned unique ID for this managed resource.
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"
has_deployment bool
Deployment status for the device group.
id str
The provider-assigned unique ID for this managed resource.
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"
hasDeployment Boolean
Deployment status for the device group.
id String
The provider-assigned unique ID for this managed resource.
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"

Supporting Types

AllowCrashDumpCollection
, AllowCrashDumpCollectionArgs

Enabled
EnabledCrash dump collection enabled
Disabled
DisabledCrash dump collection disabled
AllowCrashDumpCollectionEnabled
EnabledCrash dump collection enabled
AllowCrashDumpCollectionDisabled
DisabledCrash dump collection disabled
Enabled
EnabledCrash dump collection enabled
Disabled
DisabledCrash dump collection disabled
Enabled
EnabledCrash dump collection enabled
Disabled
DisabledCrash dump collection disabled
ENABLED
EnabledCrash dump collection enabled
DISABLED
DisabledCrash dump collection disabled
"Enabled"
EnabledCrash dump collection enabled
"Disabled"
DisabledCrash dump collection disabled

OSFeedType
, OSFeedTypeArgs

Retail
RetailRetail OS feed type.
RetailEval
RetailEvalRetail evaluation OS feed type.
OSFeedTypeRetail
RetailRetail OS feed type.
OSFeedTypeRetailEval
RetailEvalRetail evaluation OS feed type.
Retail
RetailRetail OS feed type.
RetailEval
RetailEvalRetail evaluation OS feed type.
Retail
RetailRetail OS feed type.
RetailEval
RetailEvalRetail evaluation OS feed type.
RETAIL
RetailRetail OS feed type.
RETAIL_EVAL
RetailEvalRetail evaluation OS feed type.
"Retail"
RetailRetail OS feed type.
"RetailEval"
RetailEvalRetail evaluation OS feed type.

RegionalDataBoundary
, RegionalDataBoundaryArgs

None
NoneNo data boundary
EU
EUEU data boundary
RegionalDataBoundaryNone
NoneNo data boundary
RegionalDataBoundaryEU
EUEU data boundary
None
NoneNo data boundary
EU
EUEU data boundary
None
NoneNo data boundary
EU
EUEU data boundary
NONE
NoneNo data boundary
EU
EUEU data boundary
"None"
NoneNo data boundary
"EU"
EUEU data boundary

SystemDataResponse
, SystemDataResponseArgs

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.

UpdatePolicy
, UpdatePolicyArgs

UpdateAll
UpdateAllUpdate all policy.
No3rdPartyAppUpdates
No3rdPartyAppUpdatesNo update for 3rd party app policy.
UpdatePolicyUpdateAll
UpdateAllUpdate all policy.
UpdatePolicyNo3rdPartyAppUpdates
No3rdPartyAppUpdatesNo update for 3rd party app policy.
UpdateAll
UpdateAllUpdate all policy.
No3rdPartyAppUpdates
No3rdPartyAppUpdatesNo update for 3rd party app policy.
UpdateAll
UpdateAllUpdate all policy.
No3rdPartyAppUpdates
No3rdPartyAppUpdatesNo update for 3rd party app policy.
UPDATE_ALL
UpdateAllUpdate all policy.
NO3RD_PARTY_APP_UPDATES
No3rdPartyAppUpdatesNo update for 3rd party app policy.
"UpdateAll"
UpdateAllUpdate all policy.
"No3rdPartyAppUpdates"
No3rdPartyAppUpdatesNo update for 3rd party app policy.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:azuresphere:DeviceGroup MyDeviceId1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

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