Поделиться через

Tenants - Create

  • Ссылка
Service:
Azure Sphere Public API
API Version:
v2

Запускает асинхронную операцию для создания клиента Azure Sphere.

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

Текст запроса

Имя Тип Описание
DeviceId

string

Идентификатор устройства, используемого для авторизации создания этого клиента. Это устройство не должно быть зарегистрировано ни в одном клиенте. Это поле является обязательным.
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

Идентификатор устройства, используемого для авторизации создания этого клиента. Это устройство не должно быть зарегистрировано ни в одном клиенте. Это поле является обязательным.
TenantFriendlyName

string

Имя клиента. Оно будет отображаться для пользователей и может использоваться для устранения неоднозначности для пользователей с несколькими клиентами Azure Sphere. Это поле является обязательным.