共用方式為

Product - Create

  • 參考
服務:
Azure Sphere Public API
API 版本:
v2

啟動異步操作以建立新產品。

POST https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products

URI 參數

名稱 位於 必要 類型 Description
tenantId
 path True

string

uuid

Azure Sphere 租用戶標識符。

要求本文

名稱 類型 Description
CreateDefaultGroups

boolean

布爾值，描述是否應該在產品內建立預設的一組裝置群組。
Description

string

產品的描述。
Name

string

產品名稱。

回應

名稱 類型 Description
202 Accepted

Operation

已成功啟動作業。

定義

名稱 Description
ErrorResponse
Operation
ProductCreateRequest

ErrorResponse

名稱 類型 Description
Code enum:
  • 0 - OperationFailed
  • 1 - TenantInMigration
  • 2 - TenantMigrationRequired
  • 3 - ClientUpdateRequired
  • 4 - InternalServerError
  • 5 - BadRequest
  • 6 - Forbidden
  • 7 - Conflict
  • 8 - NotFound

取得程序代碼。
Message

string

取得人類可讀取的錯誤訊息。

Operation

名稱 類型 Description
CompletedDateUTC

string

取得作業完成的 UTC 日期。
CreatedDateUTC

string

取得 UTC 的作業建立日期。
DetailsLocation

string

取得取得作業詳細數據的位置。
Error

ErrorResponse

OperationId

string

取得唯一作業標識碼。
OperationType enum:
  • 0 - DeviceClaim
  • 1 - DeviceUnclaim
  • 10 - DeleteProduct
  • 11 - BulkDeviceClaim
  • 2 - DeviceUpdateDeviceGroup
  • 3 - MigrateTenant
  • 4 - CreateProduct
  • 5 - DeployToDeviceGroup
  • 6 - DeployToOSFeed
  • 7 - ImageUpload
  • 8 - TenantCreation
  • 9 - DeleteDeviceGroup

取得作業類型識別碼。
ResourceLocation

string

取得作業執行期間建立的資源位置。
StartedDateUTC

string

取得作業開始處理的 UTC 日期。
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

取得作業的狀態。
TenantId

string

取得租用戶標識碼。

ProductCreateRequest

名稱 類型 Description
CreateDefaultGroups

boolean

布爾值，描述是否應該在產品內建立預設的一組裝置群組。
Description

string

產品的描述。
Name

string

產品名稱。