gcloud-help/gcloud/alpha/iot/devices/list

NAME
    gcloud alpha iot devices list - list devices

SYNOPSIS
    gcloud alpha iot devices list (--registry=REGISTRY : --region=REGION)
        [--device-field-mask=DEVICE_FIELD_MASK;
          default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]]
        [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE]
        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has
    been retired.

    List devices.

EXAMPLES
    To list all devices in the device registry 'my-registry' and region
    'us-central1', run:

        $ gcloud alpha iot devices list --region=us-central1 \
            --registry=my-registry

REQUIRED FLAGS
     Registry resource - The registry you want to list the devices for. The
     arguments in this group can be used to specify the attributes of this
     resource. (NOTE) Some attributes are not given arguments in this group but
     can be set in other ways.

     To set the project attribute:
      ◆ provide the argument --registry on the command line with a fully
        specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     This must be specified.

       --registry=REGISTRY
          ID of the registry or fully qualified identifier for the registry.

          To set the registry attribute:
          ▸ provide the argument --registry on the command line.

          This flag argument must be specified if any of the other arguments in
          this group are specified.

       --region=REGION
          The name of the Cloud IoT region.

          To set the region attribute:
          ▸ provide the argument --registry on the command line with a fully
            specified name;
          ▸ provide the argument --region on the command line.

FLAGS
     --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig"
        If given, returns all specified device fields instead of the default
        set. The value is a comma-separated list of field names. Example:
        "lastErrorStatus,config,metadata". See full list of device fields at:
        https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices

     --device-ids=[DEVICE_IDS,...]
        If given, show only devices with one of the provided IDs.

     --device-num-ids=[DEVICE_NUM_IDS,...]
        If given, show only devices with one of the provided numerical IDs.

     --device-type=DEVICE_TYPE
        If specified, show only devices of that type. If left unspecified, show
        devices of any type. DEVICE_TYPE must be one of: gateway, non-gateway.

LIST COMMAND FLAGS
     --filter=EXPRESSION
        Apply a Boolean filter EXPRESSION to each resource item to be listed.
        If the expression evaluates True, then that item is listed. For more
        details and examples of filter expressions, run $ gcloud topic filters.
        This flag interacts with other flags that are applied in this order:
        --flatten, --sort-by, --filter, --limit.

     --limit=LIMIT
        Maximum number of resources to list. The default is unlimited. This
        flag interacts with other flags that are applied in this order:
        --flatten, --sort-by, --filter, --limit.

     --page-size=PAGE_SIZE
        Some services group resource list output into pages. This flag
        specifies the maximum number of resources per page. The default is
        determined by the service if it supports paging, otherwise it is
        unlimited (no paging). Paging may be applied before or after --filter
        and --limit depending on the service.

     --sort-by=[FIELD,...]
        Comma-separated list of resource field key names to sort by. The
        default order is ascending. Prefix a field with ``~'' for descending
        order on that field. This flag interacts with other flags that are
        applied in this order: --flatten, --sort-by, --filter, --limit.

     --uri
        Print a list of resource URIs instead of the default output, and change
        the command output to a list of URIs. If this flag is used with
        --format, the formatting is applied on this URI list. To display URIs
        alongside other keys instead, use the uri() transform.

GCLOUD WIDE FLAGS
    These flags are available to all commands: --access-token-file, --account,
    --billing-project, --configuration, --flags-file, --flatten, --format,
    --help, --impersonate-service-account, --log-http, --project, --quiet,
    --trace-token, --user-output-enabled, --verbosity.

    Run $ gcloud help for details.

API REFERENCE
    This command uses the cloudiot/v1 API. The full documentation for this API
    can be found at: https://cloud.google.com/iot

NOTES
    This command is currently in alpha and might change without notice. If this
    command fails with API permission errors despite specifying the correct
    project, you might be trying to access an API with an invitation-only early
    access allowlist. These variants are also available:

        $ gcloud iot devices list

        $ gcloud beta iot devices list