Devices - Replace Module Properties

Serviço:

IoT Central

Versão da API:

2022-07-31

Substituir propriedades do módulo
Substitua todos os valores de propriedade de um módulo.

PUT https://{subdomain}.{baseDomain}/api/devices/{deviceId}/modules/{moduleName}/properties?api-version=2022-07-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
baseDomain	path	True	string	O domínio base para todas as solicitações de serviço do Azure IoT Central.
deviceId	path	True	string	ID exclusiva do dispositivo.
moduleName	path	True	string	Nome do módulo do dispositivo.
subdomain	path	True	string	O subdomínio do aplicativo.
api-version	query	True	string	A versão da API que está sendo chamada.

Corpo da solicitação

Nome	Tipo	Description
body	DeviceProperties	Propriedades do módulo.

Respostas

Nome	Tipo	Description
202 Accepted	DeviceProperties	Êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central do IoT. Cabeçalhos x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update properties of a module

Solicitação de exemplo

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/devices/mx1/modules/module_env/properties?api-version=2022-07-31

{
  "componentA": {
    "SensitivityDial": 200
  }
}

Resposta de exemplo

Código de status:

202

{
  "componentA": {
    "SensitivityDial": 75,
    "$metadata": {
      "SensitivityDial": {
        "desiredValue": 200,
        "desiredVersion": 3,
        "ackVersion": 1,
        "ackDescription": "Ok",
        "ackCode": 200,
        "lastUpdateTime": "2020-04-27T22:08:55.1149957Z"
      }
    }
  }
}

Definições

Nome	Description
Error	A definição de erro de resposta.
ErrorDetails	As informações detalhadas do erro.

Error

Objeto

A definição de erro de resposta.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro da solicitação atual.

ErrorDetails

Objeto

As informações detalhadas do erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação para a solicitação atual.
time	string (date-time-rfc1123)	A hora em que a solicitação de erro falhou.