Devices - Run Component Command

Bileşen komutunu çalıştırma
Bileşen üzerinde bir komut çalıştırın.

POST https://{subdomain}.{baseDomain}/api/devices/{deviceId}/components/{componentName}/commands/{commandName}?api-version=2022-06-30-preview

URI Parametreleri

Name In Required Type Description
baseDomain
path True
  • string

Tüm Azure IoT Central hizmet istekleri için temel etki alanı.

commandName
path True
  • string

Bu cihaz komutunun adı.

componentName
path True
  • string

Cihaz bileşeninin adı.

deviceId
path True
  • string

Cihazın benzersiz kimliği.

subdomain
path True
  • string

Uygulama alt etki alanı.

api-version
query True
  • string

Çağrılan API sürümü.

İstek Gövdesi

Name Type Description
connectionTimeout
  • integer

Bağlantısı kesilmiş bir cihazın çevrimiçi olmasını beklemek için saniye cinsinden bağlantı zaman aşımı. Varsayılan değer 0 saniyedir.

request

Cihaz komutu için yük, herhangi bir temel türü veya nesneyi destekler.

responseTimeout
  • integer

Bir cihazda komutun tamamlanmasını beklemek için saniye cinsinden yanıt zaman aşımı. Varsayılan değer 30 saniyedir.

Yanıtlar

Name Type Description
201 Created

Başarılı

Other Status Codes

IoT Central Hizmetinden alınan bir hata yanıtı.

Headers

  • x-ms-error-code: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Send command

Sample Request

POST https://appsubdomain.azureiotcentral.com/api/devices/mx1/components/Thermostat_1o/commands/CoolDown?api-version=2022-06-30-preview

{
  "request": {
    "tempVal": 30
  }
}

Sample Response

{}

Tanımlar

DeviceCommand

Cihaz komut tanımı.

Error

Yanıt hatası tanımı.

ErrorDetails

Hatanın ayrıntılı bilgileri.

DeviceCommand

Cihaz komut tanımı.

Name Type Description
connectionTimeout
  • integer

Bağlantısı kesilmiş bir cihazın çevrimiçi olmasını beklemek için saniye cinsinden bağlantı zaman aşımı. Varsayılan değer 0 saniyedir.

id
  • string

Cihaz komut yürütmesinin istek kimliği.

request

Cihaz komutu için yük, herhangi bir temel türü veya nesneyi destekler.

response

Cihaz komut yanıtının yükü, herhangi bir temel türü veya nesneyi destekler.

responseCode
  • integer

Cihaz komut yanıtının durum kodu.

responseTimeout
  • integer

Bir cihazda komutun tamamlanmasını beklemek için saniye cinsinden yanıt zaman aşımı. Varsayılan değer 30 saniyedir.

Error

Yanıt hatası tanımı.

Name Type Description
error

Geçerli istek için hata ayrıntıları.

ErrorDetails

Hatanın ayrıntılı bilgileri.

Name Type Description
code
  • string

Hata kodu.

message
  • string

Hata iletisi ayrıntıları.

requestId
  • string

Geçerli istek için bağıntı kimliği.

time
  • string

Hata isteğinin başarısız olduğu zaman.