共用方式為

Tenants - Create

  • 參考
Service:
Azure Sphere Public API
API Version:
v2

啟動非同步作業以建立 Azure Sphere 租使用者。

POST https://prod.core.sphere.azure.net/v2/tenants/create

要求本文

名稱 類型 Description
DeviceId

string

用來授權建立此租使用者的裝置識別碼。 此裝置不得已宣告至任何租使用者。 這是必要的欄位。
TenantFriendlyName

string

租使用者的名稱 - 這會向使用者顯示，並可用來厘清擁有多個 Azure Sphere 租使用者的使用者。 這是必要的欄位。

回應

名稱 類型 Description
200 OK

Operation

已成功啟動作業。

定義

名稱 Description
ErrorResponse
Operation
TenantCreationRequest

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

取得租使用者識別碼。

TenantCreationRequest

名稱 類型 Description
DeviceId

string

用來授權建立此租使用者的裝置識別碼。 此裝置不得已宣告至任何租使用者。 這是必要的欄位。
TenantFriendlyName

string

租使用者的名稱 - 這會向使用者顯示，並可用來厘清擁有多個 Azure Sphere 租使用者的使用者。 這是必要的欄位。