Partager via


Catalogs - List Device Groups

Répertorier les groupes d’appareils pour le catalogue.

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}

Paramètres URI

Nom Dans Obligatoire Type Description
catalogName
path True

string

Nom du catalogue

Modèle d’expression régulière: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

$filter
query

string

Filtrer la liste des résultats à l’aide de l’expression donnée

$maxpagesize
query

integer

int32

Nombre maximal d’éléments de résultat par page.

$skip
query

integer

int32

Nombre d’éléments de résultat à ignorer.

$top
query

integer

int32

Nombre d’éléments de résultat à retourner.

Corps de la demande

Nom Type Description
deviceGroupName

string

Nom du groupe d’appareils.

Réponses

Nom Type Description
200 OK

DeviceGroupListResult

L’opération Azure s’est terminée avec succès.

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Catalogs_ListDeviceGroups

Exemple de requête

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"
}

Exemple de réponse

{
  "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"
    }
  ]
}

Définitions

Nom Description
AllowCrashDumpCollection

Autoriser les valeurs de vidage sur incident.

createdByType

Type d’identité qui a créé la ressource.

DeviceGroup

Ressource de groupe d’appareils appartenant à une ressource de produit.

DeviceGroupListResult

Réponse d’une opération de liste DeviceGroup.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ListDeviceGroupsRequest

Demande de l’action pour répertorier les groupes d’appareils pour un catalogue.

OSFeedType

Valeurs du type de flux de système d’exploitation.

ProvisioningState

État d’approvisionnement de la ressource.

RegionalDataBoundary

Valeurs de limites de données régionales.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UpdatePolicy

Mettre à jour les valeurs de stratégie.

AllowCrashDumpCollection

Autoriser les valeurs de vidage sur incident.

Nom Type Description
Disabled

string

Collecte de vidage sur incident désactivée

Enabled

string

Collecte de vidages sur incident activée

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

Ressource de groupe d’appareils appartenant à une ressource de produit.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

Indicateur permettant de définir si l’utilisateur autorise la collecte de vidage sur incident.

properties.description

string

Description du groupe d’appareils.

properties.hasDeployment

boolean

État du déploiement pour le groupe d’appareils.

properties.osFeedType

OSFeedType

Type de flux du système d’exploitation du groupe d’appareils.

properties.provisioningState

ProvisioningState

État de la dernière opération.

properties.regionalDataBoundary

RegionalDataBoundary

Limite de données régionales pour le groupe d’appareils.

properties.updatePolicy

UpdatePolicy

Mettre à jour la stratégie du groupe d’appareils.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DeviceGroupListResult

Réponse d’une opération de liste DeviceGroup.

Nom Type Description
nextLink

string

Lien vers la page d’éléments suivante

value

DeviceGroup[]

Éléments DeviceGroup sur cette page

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

ListDeviceGroupsRequest

Demande de l’action pour répertorier les groupes d’appareils pour un catalogue.

Nom Type Description
deviceGroupName

string

Nom du groupe d’appareils.

OSFeedType

Valeurs du type de flux de système d’exploitation.

Nom Type Description
Retail

string

Type de flux de système d’exploitation de vente au détail.

RetailEval

string

Type de flux de système d’exploitation d’évaluation de la vente au détail.

ProvisioningState

État d’approvisionnement de la ressource.

Nom Type Description
Accepted

string

La demande de création de ressource a été acceptée

Canceled

string

La création de la ressource a été annulée.

Deleting

string

La ressource est en cours de suppression

Failed

string

Échec de la création de la ressource.

Provisioning

string

La ressource est en cours d’approvisionnement

Succeeded

string

La ressource a été créée.

Updating

string

La ressource est en cours de mise à jour

RegionalDataBoundary

Valeurs de limites de données régionales.

Nom Type Description
EU

string

Limite des données de l’UE

None

string

Aucune limite de données

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UpdatePolicy

Mettre à jour les valeurs de stratégie.

Nom Type Description
No3rdPartyAppUpdates

string

Aucune mise à jour pour la stratégie d’application tierce.

UpdateAll

string

Mettez à jour toutes les stratégies.