Tenants - Create

启动异步操作以创建 Azure Sphere 租户。

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

请求正文

名称 类型 说明
DeviceId

string

用于授权创建此租户的设备 ID。 此设备不得已声明到任何租户中。 这是必填字段。

TenantFriendlyName

string

租户的名称 - 这将向用户显示,并可用于消除具有多个 Azure Sphere 租户的用户的歧义。 这是必填字段。

响应

名称 类型 说明
200 OK

Operation

已成功启动操作。

定义

名称 说明
ErrorResponse
Operation
TenantCreationRequest

ErrorResponse

名称 类型 说明
Code enum:
  • 0 - OperationFailed
  • 1 - TenantInMigration
  • 2 - TenantMigrationRequired
  • 3 - ClientUpdateRequired
  • 4 - InternalServerError
  • 5 - BadRequest
  • 6 - Forbidden
  • 7 - Conflict
  • 8 - NotFound

获取代码。

Message

string

获取人工可读错误消息。

Operation

名称 类型 说明
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

名称 类型 说明
DeviceId

string

用于授权创建此租户的设备 ID。 此设备不得已声明到任何租户中。 这是必填字段。

TenantFriendlyName

string

租户的名称 - 这将向用户显示,并可用于消除具有多个 Azure Sphere 租户的用户的歧义。 这是必填字段。