次の方法で共有

Tenants - Create

  • リファレンス
サービス:
Azure Sphere Public API
API バージョン:
v2

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 テナントを持つユーザーのあいまいさを解消するために使用できます。 これは必須フィールドです。