1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getDevicePool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.azurestackhci.getDevicePool

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Get a DevicePool

    Uses Azure REST API version 2026-03-01-preview.

    Using getDevicePool

    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 getDevicePool(args: GetDevicePoolArgs, opts?: InvokeOptions): Promise<GetDevicePoolResult>
function getDevicePoolOutput(args: GetDevicePoolOutputArgs, opts?: InvokeOptions): Output<GetDevicePoolResult>
    def get_device_pool(device_pool_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDevicePoolResult
def get_device_pool_output(device_pool_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDevicePoolResult]
    func LookupDevicePool(ctx *Context, args *LookupDevicePoolArgs, opts ...InvokeOption) (*LookupDevicePoolResult, error)
func LookupDevicePoolOutput(ctx *Context, args *LookupDevicePoolOutputArgs, opts ...InvokeOption) LookupDevicePoolResultOutput

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

    public static class GetDevicePool 
{
    public static Task<GetDevicePoolResult> InvokeAsync(GetDevicePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetDevicePoolResult> Invoke(GetDevicePoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDevicePoolResult> getDevicePool(GetDevicePoolArgs args, InvokeOptions options)
public static Output<GetDevicePoolResult> getDevicePool(GetDevicePoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurestackhci:getDevicePool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DevicePoolName string
    The name of the DevicePool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DevicePoolName string
    The name of the DevicePool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    devicePoolName String
    The name of the DevicePool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    devicePoolName string
    The name of the DevicePool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    device_pool_name str
    The name of the DevicePool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    devicePoolName String
    The name of the DevicePool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDevicePool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureStackHCI.Outputs.DevicePoolPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AzureStackHCI.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"
    Identity Pulumi.AzureNative.AzureStackHCI.Outputs.ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties DevicePoolPropertiesResponse
    The resource-specific properties for this resource.
    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"
    Identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties DevicePoolPropertiesResponse
    The resource-specific properties for this resource.
    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"
    identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties DevicePoolPropertiesResponse
    The resource-specific properties for this resource.
    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"
    identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties DevicePoolPropertiesResponse
    The resource-specific properties for this resource.
    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"
    identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    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"
    identity Property Map
    The managed service identities assigned to this resource.
    tags Map<String>
    Resource tags.

    Supporting Types

    DeviceDetailResponse

    ClaimedBy string
    Resource Id of group device belongs to.
    DeviceResourceId string
    Resource Id of the device.
    ClaimedBy string
    Resource Id of group device belongs to.
    DeviceResourceId string
    Resource Id of the device.
    claimedBy String
    Resource Id of group device belongs to.
    deviceResourceId String
    Resource Id of the device.
    claimedBy string
    Resource Id of group device belongs to.
    deviceResourceId string
    Resource Id of the device.
    claimed_by str
    Resource Id of group device belongs to.
    device_resource_id str
    Resource Id of the device.
    claimedBy String
    Resource Id of group device belongs to.
    deviceResourceId String
    Resource Id of the device.

    DevicePoolPropertiesResponse

    CloudId string
    Unique, immutable resource id.
    CustomLocationResourceId string
    Custom Location Resource Id for the pool
    OperationDetails List<Pulumi.AzureNative.AzureStackHCI.Inputs.OperationDetailResponse>
    operation status details for device pool.
    ProvisioningState string
    The provisioning state of a resource.
    CustomLocationName string
    Custom Location Name for the pool, default: -CL
    Devices List<Pulumi.AzureNative.AzureStackHCI.Inputs.DeviceDetailResponse>
    List of machines in device pool.
    ManagedResourceGroup string
    Managed resource group name for the pool
    CloudId string
    Unique, immutable resource id.
    CustomLocationResourceId string
    Custom Location Resource Id for the pool
    OperationDetails []OperationDetailResponse
    operation status details for device pool.
    ProvisioningState string
    The provisioning state of a resource.
    CustomLocationName string
    Custom Location Name for the pool, default: -CL
    Devices []DeviceDetailResponse
    List of machines in device pool.
    ManagedResourceGroup string
    Managed resource group name for the pool
    cloudId String
    Unique, immutable resource id.
    customLocationResourceId String
    Custom Location Resource Id for the pool
    operationDetails List<OperationDetailResponse>
    operation status details for device pool.
    provisioningState String
    The provisioning state of a resource.
    customLocationName String
    Custom Location Name for the pool, default: -CL
    devices List<DeviceDetailResponse>
    List of machines in device pool.
    managedResourceGroup String
    Managed resource group name for the pool
    cloudId string
    Unique, immutable resource id.
    customLocationResourceId string
    Custom Location Resource Id for the pool
    operationDetails OperationDetailResponse[]
    operation status details for device pool.
    provisioningState string
    The provisioning state of a resource.
    customLocationName string
    Custom Location Name for the pool, default: -CL
    devices DeviceDetailResponse[]
    List of machines in device pool.
    managedResourceGroup string
    Managed resource group name for the pool
    cloud_id str
    Unique, immutable resource id.
    custom_location_resource_id str
    Custom Location Resource Id for the pool
    operation_details Sequence[OperationDetailResponse]
    operation status details for device pool.
    provisioning_state str
    The provisioning state of a resource.
    custom_location_name str
    Custom Location Name for the pool, default: -CL
    devices Sequence[DeviceDetailResponse]
    List of machines in device pool.
    managed_resource_group str
    Managed resource group name for the pool
    cloudId String
    Unique, immutable resource id.
    customLocationResourceId String
    Custom Location Resource Id for the pool
    operationDetails List<Property Map>
    operation status details for device pool.
    provisioningState String
    The provisioning state of a resource.
    customLocationName String
    Custom Location Name for the pool, default: -CL
    devices List<Property Map>
    List of machines in device pool.
    managedResourceGroup String
    Managed resource group name for the pool

    ErrorAdditionalInfoResponse

    Info object
    The additional info.
    Type string
    The additional info type.
    Info interface{}
    The additional info.
    Type string
    The additional info type.
    info Object
    The additional info.
    type String
    The additional info type.
    info any
    The additional info.
    type string
    The additional info type.
    info Any
    The additional info.
    type str
    The additional info type.
    info Any
    The additional info.
    type String
    The additional info type.

    ErrorDetailResponse

    AdditionalInfo []ErrorAdditionalInfoResponse
    The error additional info.
    Code string
    The error code.
    Details []ErrorDetailResponse
    The error details.
    Message string
    The error message.
    Target string
    The error target.
    additionalInfo List<ErrorAdditionalInfoResponse>
    The error additional info.
    code String
    The error code.
    details List<ErrorDetailResponse>
    The error details.
    message String
    The error message.
    target String
    The error target.
    additionalInfo ErrorAdditionalInfoResponse[]
    The error additional info.
    code string
    The error code.
    details ErrorDetailResponse[]
    The error details.
    message string
    The error message.
    target string
    The error target.
    additional_info Sequence[ErrorAdditionalInfoResponse]
    The error additional info.
    code str
    The error code.
    details Sequence[ErrorDetailResponse]
    The error details.
    message str
    The error message.
    target str
    The error target.
    additionalInfo List<Property Map>
    The error additional info.
    code String
    The error code.
    details List<Property Map>
    The error details.
    message String
    The error message.
    target String
    The error target.

    ManagedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.AzureStackHCI.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    OperationDetailResponse

    Description string
    operation description.
    Error Pulumi.AzureNative.AzureStackHCI.Inputs.ErrorDetailResponse
    error details.
    Id string
    operation id.
    Name string
    operation name.
    ResourceId string
    operation resource id.
    Status string
    operation status.
    Type string
    operation type.
    Description string
    operation description.
    Error ErrorDetailResponse
    error details.
    Id string
    operation id.
    Name string
    operation name.
    ResourceId string
    operation resource id.
    Status string
    operation status.
    Type string
    operation type.
    description String
    operation description.
    error ErrorDetailResponse
    error details.
    id String
    operation id.
    name String
    operation name.
    resourceId String
    operation resource id.
    status String
    operation status.
    type String
    operation type.
    description string
    operation description.
    error ErrorDetailResponse
    error details.
    id string
    operation id.
    name string
    operation name.
    resourceId string
    operation resource id.
    status string
    operation status.
    type string
    operation type.
    description str
    operation description.
    error ErrorDetailResponse
    error details.
    id str
    operation id.
    name str
    operation name.
    resource_id str
    operation resource id.
    status str
    operation status.
    type str
    operation type.
    description String
    operation description.
    error Property Map
    error details.
    id String
    operation id.
    name String
    operation name.
    resourceId String
    operation resource id.
    status String
    operation status.
    type String
    operation type.

    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.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.