Compartir a través de


Catalogs - List Device Groups

Enumere los grupos de dispositivos del catálogo.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups?api-version=2024-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups?api-version=2024-04-01&$filter={$filter}&$top={$top}&$skip={$skip}&$maxpagesize={$maxpagesize}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
catalogName
path True

string

Nombre del catálogo

Patrón de Regex: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

$filter
query

string

Filtrar la lista de resultados mediante la expresión especificada

$maxpagesize
query

integer

int32

Número máximo de elementos de resultado por página.

$skip
query

integer

int32

Número de elementos de resultado que se van a omitir.

$top
query

integer

int32

Número de elementos de resultado que se van a devolver.

Cuerpo de la solicitud

Nombre Tipo Description
deviceGroupName

string

Nombre del grupo de dispositivos.

Respuestas

Nombre Tipo Description
200 OK

DeviceGroupListResult

La operación de Azure se completó correctamente.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Catalogs_ListDeviceGroups

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/listDeviceGroups?api-version=2024-04-01

{
  "deviceGroupName": "MyDeviceGroup1"
}

Respuesta de muestra

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1",
      "name": "MyDeviceGroup1",
      "type": "microsoft.azureSphere/catalogs/products/devicegroups"
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2",
      "name": "MyDeviceGroup2",
      "type": "microsoft.azureSphere/catalogs/products/devicegroups"
    }
  ]
}

Definiciones

Nombre Description
AllowCrashDumpCollection

Permitir valores de volcados de memoria.

createdByType

Tipo de identidad que creó el recurso.

DeviceGroup

Un recurso de grupo de dispositivos que pertenece a un recurso de producto.

DeviceGroupListResult

Respuesta de una operación de lista DeviceGroup.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

ListDeviceGroupsRequest

Solicitud de la acción para enumerar grupos de dispositivos para un catálogo.

OSFeedType

Valores de tipo de fuente del sistema operativo.

ProvisioningState

Estado de aprovisionamiento del recurso.

RegionalDataBoundary

Valores de límite de datos regionales.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

UpdatePolicy

Actualice los valores de la directiva.

AllowCrashDumpCollection

Permitir valores de volcados de memoria.

Nombre Tipo Description
Disabled

string

Colección de volcados de memoria deshabilitada

Enabled

string

Recopilación de volcado de memoria habilitada

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

Un recurso de grupo de dispositivos que pertenece a un recurso de producto.

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nombre del recurso.

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

Marca para definir si el usuario permite la recopilación de volcados de memoria.

properties.description

string

Descripción del grupo de dispositivos.

properties.hasDeployment

boolean

Estado de implementación del grupo de dispositivos.

properties.osFeedType

OSFeedType

Tipo de fuente del sistema operativo del grupo de dispositivos.

properties.provisioningState

ProvisioningState

Estado de la última operación.

properties.regionalDataBoundary

RegionalDataBoundary

Límite de datos regionales para el grupo de dispositivos.

properties.updatePolicy

UpdatePolicy

Actualice la directiva del grupo de dispositivos.

systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

Respuesta de una operación de lista DeviceGroup.

Nombre Tipo Description
nextLink

string

Vínculo a la página siguiente de elementos

value

DeviceGroup[]

Los elementos DeviceGroup de esta página

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ListDeviceGroupsRequest

Solicitud de la acción para enumerar grupos de dispositivos para un catálogo.

Nombre Tipo Description
deviceGroupName

string

Nombre del grupo de dispositivos.

OSFeedType

Valores de tipo de fuente del sistema operativo.

Nombre Tipo Description
Retail

string

Tipo de fuente del sistema operativo comercial.

RetailEval

string

Tipo de fuente del sistema operativo de evaluación comercial.

ProvisioningState

Estado de aprovisionamiento del recurso.

Nombre Tipo Description
Accepted

string

Se ha aceptado la solicitud de creación de recursos.

Canceled

string

Se canceló la creación de recursos.

Deleting

string

El recurso se está eliminando.

Failed

string

Error en la creación de recursos.

Provisioning

string

El recurso se está aprovisionando.

Succeeded

string

Se ha creado el recurso.

Updating

string

El recurso se está actualizando.

RegionalDataBoundary

Valores de límite de datos regionales.

Nombre Tipo Description
EU

string

Límite de datos de la UE

None

string

Sin límite de datos

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

UpdatePolicy

Actualice los valores de la directiva.

Nombre Tipo Description
No3rdPartyAppUpdates

string

No hay ninguna actualización para la directiva de aplicación de terceros.

UpdateAll

string

Actualice toda la directiva.