Tenants - Create

  • Referência
Service:
Azure Sphere Public API
API Version:
v2

Inicia uma operação assíncrona para criar um locatário do Azure Sphere.

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

Corpo da solicitação

Nome Tipo Description
DeviceId

string

A ID do dispositivo que está sendo usado para autorizar essa criação de locatário. Esse dispositivo ainda não deve ser reivindicado em nenhum locatário. Esse é um campo obrigatório.
TenantFriendlyName

string

O nome do locatário – isso será exibido aos usuários e poderá ser usado para desambiguar para usuários que têm vários locatários do Azure Sphere. Esse é um campo obrigatório.

Respostas

Nome Tipo Description
200 OK

Operation

Iniciou a operação com êxito.

Definições

Nome Description
ErrorResponse
Operation
TenantCreationRequest

ErrorResponse

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

Obtém o código.
Message

string

Obtém a mensagem de erro legível humano.

Operation

Nome Tipo Description
CompletedDateUTC

string

Obtém a data em UTC que a operação concluiu.
CreatedDateUTC

string

Obtém a data de criação da operação em UTC.
DetailsLocation

string

Obtém o local para obter detalhes da operação.
Error

ErrorResponse

OperationId

string

Obtém o identificador de operação exclusivo.
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

Obtém o identificador de tipo de operação.
ResourceLocation

string

Obtém o local dos recursos criados durante a execução da operação.
StartedDateUTC

string

Obtém a data em UTC em que a operação iniciou o processamento.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Obtém o estado da operação.
TenantId

string

Obtém o identificador de locatário.

TenantCreationRequest

Nome Tipo Description
DeviceId

string

A ID do dispositivo que está sendo usado para autorizar essa criação de locatário. Esse dispositivo ainda não deve ser reivindicado em nenhum locatário. Esse é um campo obrigatório.
TenantFriendlyName

string

O nome do locatário – isso será exibido aos usuários e poderá ser usado para desambiguar para usuários que têm vários locatários do Azure Sphere. Esse é um campo obrigatório.