Dela via


Product - Create

Startar en asynkron åtgärd för att skapa en ny produkt.

POST https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products

URI-parametrar

Name I Obligatorisk Typ Description
tenantId
path True

string

uuid

Klient-ID:t för Azure Sphere.

Begärandetext

Name Typ Description
CreateDefaultGroups

boolean

Ett booleskt värde som beskriver om standarduppsättningen med enhetsgrupper ska skapas i produkten.

Description

string

Beskrivningen av produkten.

Name

string

Namnet på produkten.

Svar

Name Typ Description
202 Accepted

Operation

Åtgärden har startats.

Definitioner

Name Description
ErrorResponse
Operation
ProductCreateRequest

ErrorResponse

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

Hämtar koden.

Message

string

Hämtar det mänskliga läsbara felmeddelandet.

Operation

Name Typ Description
CompletedDateUTC

string

Hämtar datumet i UTC som åtgärden slutförde.

CreatedDateUTC

string

Hämtar åtgärdens skapandedatum i UTC.

DetailsLocation

string

Hämtar platsen för att få information om åtgärden.

Error

ErrorResponse

OperationId

string

Hämtar den unika åtgärdsidentifieraren.

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

Hämtar åtgärdstypidentifieraren.

ResourceLocation

string

Hämtar platsen för resurser som skapades under körningen av åtgärden.

StartedDateUTC

string

Hämtar datumet i UTC som åtgärden började bearbeta.

State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Hämtar åtgärdens tillstånd.

TenantId

string

Hämtar klientidentifieraren.

ProductCreateRequest

Name Typ Description
CreateDefaultGroups

boolean

Ett booleskt värde som beskriver om standarduppsättningen med enhetsgrupper ska skapas i produkten.

Description

string

Beskrivningen av produkten.

Name

string

Namnet på produkten.