Device Group - List By Name

服務:

Azure Sphere Public API

API 版本:

v2

取得具有指定名稱的所有 DeviceGroup。

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/name/{deviceGroupName}

含選擇性參數:

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/name/{deviceGroupName}?maxPageSize={maxPageSize}

URI 參數

名稱	位於	必要	類型	Description
deviceGroupName	path	True	string	DeviceGroup 名稱。
tenantId	path	True	string uuid	Azure Sphere 租用戶標識符。
maxPageSize	query		integer int32	回應中應包含的結果數目上限。

要求標頭

名稱	必要	類型	Description
Sphere-Continuation		string	用來繼續上一頁結果的接續令牌。

回應

名稱	類型	Description
200 OK	DeviceGroupV2ItemCollectionResponse	成功。

定義

名稱	Description
Deployment
DeviceGroupV2
DeviceGroupV2ItemCollectionResponse

Deployment

名稱	類型	Description
DeployedImages	string[]	目前在此部署中的映像標識碼。
DeploymentDateUtc	string	部署建立的 DateTime。
Id	string	部署的唯一標識碼。
TenantId	string	擁有部署之租使用者的唯一標識符。

DeviceGroupV2

名稱	類型	Description
AllowCrashDumpsCollection	boolean	啟用指定裝置群組的損毀傾印收集
CurrentDeployment	Deployment
Description	string	裝置群組的描述。
Id	string	裝置群組的唯一標識碼。
Name	string	裝置群組的名稱。
OsFeedType	enum: 0 - Retail 1 - RetailEval	此裝置群組用於OS更新的osfeed類型。
ProductId	string	此裝置群組所屬產品的唯一標識符。
TenantId	string	擁有裝置群組之租使用者的唯一標識符。
UpdatePolicy	enum: 0 - UpdateAll 1 - No3rdPartyAppUpdates	決定要更新哪些軟體的更新原則。

DeviceGroupV2ItemCollectionResponse

名稱	類型	Description
ContinuationToken	string	可用來取得下一組專案的接續令牌。
Items	DeviceGroupV2[]	項目清單。