azure-native.azuresphere.DeviceGroup
Explore with Pulumi AI
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,
    });
});
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
	})
}
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());
    }
}
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,
});
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)
resources:
  deviceGroup:
    type: azure-native:azuresphere:DeviceGroup
    properties:
      catalogName: MyCatalog1
      description: Description for MyDeviceGroup1
      deviceGroupName: MyDeviceGroup1
      osFeedType: Retail
      productName: MyProduct1
      resourceGroupName: MyResourceGroup1
      updatePolicy: UpdateAll
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 string
- The unique name of the resource.
- args DeviceGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args DeviceGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeviceGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
example, err := azuresphere.NewDeviceGroup(ctx, "deviceGroupResource", &azuresphere.DeviceGroupArgs{
	CatalogName:               pulumi.String("string"),
	ProductName:               pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	AllowCrashDumpsCollection: pulumi.String("string"),
	Description:               pulumi.String("string"),
	DeviceGroupName:           pulumi.String("string"),
	OsFeedType:                pulumi.String("string"),
	RegionalDataBoundary:      pulumi.String("string"),
	UpdatePolicy:              pulumi.String("string"),
})
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());
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")
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",
});
type: azure-native:azuresphere:DeviceGroup
properties:
    allowCrashDumpsCollection: string
    catalogName: string
    description: string
    deviceGroupName: string
    osFeedType: string
    productName: string
    regionalDataBoundary: string
    resourceGroupName: string
    updatePolicy: string
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 string
- Name of catalog
- ProductName string
- Name of product.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- AllowCrash string | Pulumi.Dumps Collection Azure Native. Azure Sphere. Allow Crash Dump Collection 
- Flag to define if the user allows for crash dump collection.
- Description string
- Description of the device group.
- DeviceGroup stringName 
- Name of device group.
- OsFeed string | Pulumi.Type Azure Native. Azure Sphere. OSFeed Type 
- Operating system feed type of the device group.
- RegionalData string | Pulumi.Boundary Azure Native. Azure Sphere. Regional Data Boundary 
- Regional data boundary for the device group.
- UpdatePolicy string | Pulumi.Azure Native. Azure Sphere. Update Policy 
- Update policy of the device group.
- CatalogName string
- Name of catalog
- ProductName string
- Name of product.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- AllowCrash string | AllowDumps Collection Crash Dump Collection 
- Flag to define if the user allows for crash dump collection.
- Description string
- Description of the device group.
- DeviceGroup stringName 
- Name of device group.
- OsFeed string | OSFeedType Type 
- Operating system feed type of the device group.
- RegionalData string | RegionalBoundary Data Boundary 
- Regional data boundary for the device group.
- UpdatePolicy string | UpdatePolicy 
- Update policy of the device group.
- catalogName String
- Name of catalog
- productName String
- Name of product.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- allowCrash String | AllowDumps Collection Crash Dump Collection 
- Flag to define if the user allows for crash dump collection.
- description String
- Description of the device group.
- deviceGroup StringName 
- Name of device group.
- osFeed String | OSFeedType Type 
- Operating system feed type of the device group.
- regionalData String | RegionalBoundary Data Boundary 
- Regional data boundary for the device group.
- updatePolicy String | UpdatePolicy 
- Update policy of the device group.
- catalogName string
- Name of catalog
- productName string
- Name of product.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- allowCrash string | AllowDumps Collection Crash Dump Collection 
- Flag to define if the user allows for crash dump collection.
- description string
- Description of the device group.
- deviceGroup stringName 
- Name of device group.
- osFeed string | OSFeedType Type 
- Operating system feed type of the device group.
- regionalData string | RegionalBoundary Data Boundary 
- Regional data boundary for the device group.
- updatePolicy string | UpdatePolicy 
- Update policy of the device group.
- catalog_name str
- Name of catalog
- product_name str
- Name of product.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- allow_crash_ str | Allowdumps_ collection Crash Dump Collection 
- Flag to define if the user allows for crash dump collection.
- description str
- Description of the device group.
- device_group_ strname 
- Name of device group.
- os_feed_ str | OSFeedtype Type 
- Operating system feed type of the device group.
- regional_data_ str | Regionalboundary Data Boundary 
- Regional data boundary for the device group.
- update_policy str | UpdatePolicy 
- Update policy of the device group.
- catalogName String
- Name of catalog
- productName String
- Name of product.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- allowCrash String | "Enabled" | "Disabled"Dumps Collection 
- Flag to define if the user allows for crash dump collection.
- description String
- Description of the device group.
- deviceGroup StringName 
- Name of device group.
- osFeed String | "Retail" | "RetailType Eval" 
- Operating system feed type of the device group.
- regionalData String | "None" | "EU"Boundary 
- Regional data boundary for the device group.
- updatePolicy String | "UpdateAll" | "No3rd Party App Updates" 
- 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.Azure Native. Azure Sphere. Outputs. System Data Response 
- 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 SystemData Response 
- 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 SystemData Response 
- 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 SystemData Response 
- 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 SystemData Response 
- 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
- AllowCrash Dump Collection Enabled 
- EnabledCrash dump collection enabled
- AllowCrash Dump Collection 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
- "Enabled"
- EnabledCrash dump collection enabled
- "Disabled"
- DisabledCrash dump collection disabled
OSFeedType, OSFeedTypeArgs    
- Retail
- RetailRetail OS feed type.
- RetailEval 
- RetailEvalRetail evaluation OS feed type.
- OSFeedType Retail 
- RetailRetail OS feed type.
- OSFeedType Retail Eval 
- 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
- RegionalData Boundary None 
- NoneNo data boundary
- RegionalData 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
- "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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
UpdatePolicy, UpdatePolicyArgs    
- UpdateAll 
- UpdateAllUpdate all policy.
- No3rdParty App Updates 
- No3rdPartyAppUpdatesNo update for 3rd party app policy.
- UpdatePolicy Update All 
- UpdateAllUpdate all policy.
- UpdatePolicy No3rd Party App Updates 
- No3rdPartyAppUpdatesNo update for 3rd party app policy.
- UpdateAll 
- UpdateAllUpdate all policy.
- No3rdParty App Updates 
- No3rdPartyAppUpdatesNo update for 3rd party app policy.
- UpdateAll 
- UpdateAllUpdate all policy.
- No3rdParty App Updates 
- 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.
- "No3rdParty App Updates" 
- 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} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0