azure-native.azuresphere.getDeviceGroup
Explore with Pulumi AI
Get a DeviceGroup. ‘.default’ and ‘.unassigned’ are system defined values and cannot be used for product or device group name.
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 getDeviceGroup
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 getDeviceGroup(args: GetDeviceGroupArgs, opts?: InvokeOptions): Promise<GetDeviceGroupResult>
function getDeviceGroupOutput(args: GetDeviceGroupOutputArgs, opts?: InvokeOptions): Output<GetDeviceGroupResult>def get_device_group(catalog_name: Optional[str] = None,
                     device_group_name: Optional[str] = None,
                     product_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDeviceGroupResult
def get_device_group_output(catalog_name: Optional[pulumi.Input[str]] = None,
                     device_group_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[GetDeviceGroupResult]func LookupDeviceGroup(ctx *Context, args *LookupDeviceGroupArgs, opts ...InvokeOption) (*LookupDeviceGroupResult, error)
func LookupDeviceGroupOutput(ctx *Context, args *LookupDeviceGroupOutputArgs, opts ...InvokeOption) LookupDeviceGroupResultOutput> Note: This function is named LookupDeviceGroup in the Go SDK.
public static class GetDeviceGroup 
{
    public static Task<GetDeviceGroupResult> InvokeAsync(GetDeviceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceGroupResult> Invoke(GetDeviceGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDeviceGroupResult> getDeviceGroup(GetDeviceGroupArgs args, InvokeOptions options)
public static Output<GetDeviceGroupResult> getDeviceGroup(GetDeviceGroupArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:azuresphere:getDeviceGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Catalog
Name string - Name of catalog
 - Device
Group stringName  - Name of device group.
 - Product
Name string - Name of product.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Catalog
Name string - Name of catalog
 - Device
Group stringName  - Name of device group.
 - Product
Name string - Name of product.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- catalog
Name String - Name of catalog
 - device
Group StringName  - Name of device group.
 - product
Name String - Name of product.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- catalog
Name string - Name of catalog
 - device
Group stringName  - Name of device group.
 - product
Name string - Name of product.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- catalog_
name str - Name of catalog
 - device_
group_ strname  - Name of device group.
 - product_
name str - Name of product.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- catalog
Name String - Name of catalog
 - device
Group StringName  - Name of device group.
 - product
Name String - Name of product.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getDeviceGroup Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Has
Deployment bool - Deployment status for the device group.
 - Id string
 - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
 - Name string
 - The name of the resource
 - Provisioning
State string - The status of the last operation.
 - System
Data 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"
 - Allow
Crash stringDumps Collection  - Flag to define if the user allows for crash dump collection.
 - Description string
 - Description of the device group.
 - Os
Feed stringType  - Operating system feed type of the device group.
 - Regional
Data stringBoundary  - Regional data boundary for the device group.
 - Update
Policy string - Update policy of the device group.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Has
Deployment bool - Deployment status for the device group.
 - Id string
 - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
 - Name string
 - The name of the resource
 - Provisioning
State string - The status of the last operation.
 - System
Data 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"
 - Allow
Crash stringDumps Collection  - Flag to define if the user allows for crash dump collection.
 - Description string
 - Description of the device group.
 - Os
Feed stringType  - Operating system feed type of the device group.
 - Regional
Data stringBoundary  - Regional data boundary for the device group.
 - Update
Policy string - Update policy of the device group.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - has
Deployment Boolean - Deployment status for the device group.
 - id String
 - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
 - name String
 - The name of the resource
 - provisioning
State String - The status of the last operation.
 - system
Data 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"
 - allow
Crash StringDumps Collection  - Flag to define if the user allows for crash dump collection.
 - description String
 - Description of the device group.
 - os
Feed StringType  - Operating system feed type of the device group.
 - regional
Data StringBoundary  - Regional data boundary for the device group.
 - update
Policy String - Update policy of the device group.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - has
Deployment boolean - Deployment status for the device group.
 - id string
 - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
 - name string
 - The name of the resource
 - provisioning
State string - The status of the last operation.
 - system
Data 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"
 - allow
Crash stringDumps Collection  - Flag to define if the user allows for crash dump collection.
 - description string
 - Description of the device group.
 - os
Feed stringType  - Operating system feed type of the device group.
 - regional
Data stringBoundary  - Regional data boundary for the device group.
 - update
Policy string - Update policy of the device group.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - has_
deployment bool - Deployment status for the device group.
 - id str
 - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
 - 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"
 - allow_
crash_ strdumps_ collection  - Flag to define if the user allows for crash dump collection.
 - description str
 - Description of the device group.
 - os_
feed_ strtype  - Operating system feed type of the device group.
 - regional_
data_ strboundary  - Regional data boundary for the device group.
 - update_
policy str - Update policy of the device group.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - has
Deployment Boolean - Deployment status for the device group.
 - id String
 - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
 - name String
 - The name of the resource
 - provisioning
State String - The status of the last operation.
 - system
Data 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"
 - allow
Crash StringDumps Collection  - Flag to define if the user allows for crash dump collection.
 - description String
 - Description of the device group.
 - os
Feed StringType  - Operating system feed type of the device group.
 - regional
Data StringBoundary  - Regional data boundary for the device group.
 - update
Policy String - Update policy of the device group.
 
Supporting Types
SystemDataResponse  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified 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.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0