---
title: "GET /deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}"
method: GET
path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}"
tags: ["Device and deployment management"]
---

# GET /deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}

`GET /deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}`

Gets the deployment properties.

## Path parameters

- `instanceId` string, required
- `groupId` string, required
- `deploymentId` string, required

## Query parameters

- `api-version` string, required

## Response `200`

The request has succeeded.

- Deployment — Deployment metadata.
  - `deploymentId` string, required — The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment.
  - `startDateTime` string, date-time, required — The deployment start datetime.
  - `update` UpdateInfo, required — Update information.
    - `updateId` UpdateId, required — Update identifier.
      - `provider` string, required — Update provider.
      - `name` string, required — Update name.
      - `version` string, required — Update version.
    - `description` string — Update description.
    - `friendlyName` string — Friendly update name.
  - `groupId` string, required — The group identity for the devices the deployment is intended to update.
  - `deviceClassSubgroups` string[] — The device class subgroups the deployment is compatible with and subgroup deployments have been created for. This is not provided by the caller during CreateOrUpdateDeployment but is automatically determined by Device Update
  - `isCanceled` boolean — Boolean flag indicating whether the deployment was canceled.
  - `isRetried` boolean — Boolean flag indicating whether the deployment has been retried.
  - `rollbackPolicy` CloudInitiatedRollbackPolicy — Rollback policy for deployment
    - `update` UpdateInfo, required — Update information.
      - `updateId` UpdateId, required — Update identifier.
        - `provider` string, required — Update provider.
        - `name` string, required — Update name.
        - `version` string, required — Update version.
      - `description` string — Update description.
      - `friendlyName` string — Friendly update name.
    - `failure` CloudInitiatedRollbackPolicyFailure, required — Failure conditions to initiate rollback policy
      - `devicesFailedPercentage` integer, required — Percentage of devices that failed.
      - `devicesFailedCount` integer, required — Number of devices that failed.
  - `isCloudInitiatedRollback` boolean — Boolean flag indicating whether the deployment is a rollback deployment.
  - `downloadSecurity` 'https' | 'http' — The protocol the device should use when downloading the update payload. Defaults to "https".

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/deviceupdate-microsoft-deviceupdate.md) · [All operations](https://skmtc.net/azure/apis/deviceupdate-microsoft-deviceupdate/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/deviceupdate-microsoft-deviceupdate/versions/ceb0ecac6c82/schema)