azure.iot.hub.protocol.models.device.Device.yml

### YamlMime:PythonClass
uid: azure.iot.hub.protocol.models.device.Device
name: Device
fullName: azure.iot.hub.protocol.models.device.Device
module: azure.iot.hub.protocol.models.device
inheritances:
- msrest.serialization.Model
summary: Device.
constructor:
  syntax: Device(**kwargs)
  parameters:
  - name: device_id
    description: The unique identifier of the device.
    isRequired: true
    types:
    - <xref:str>
  - name: generation_id
    description: 'The IoT Hub-generated, case-sensitive string up to

      128 characters long. This value is used to distinguish devices with the

      same deviceId, when they have been deleted and re-created.'
    isRequired: true
    types:
    - <xref:str>
  - name: etag
    description: 'The string representing a weak ETag for the device identity,

      as per RFC7232.'
    isRequired: true
    types:
    - <xref:str>
  - name: connection_state
    description: 'The state of the device. Possible values include:

      ''Disconnected'', ''Connected'''
    isRequired: true
    types:
    - <xref:str>
    - <xref:protocol.models.enum>
  - name: status
    description: 'The status of the device. If the status disabled, a device

      cannot connect to the service. Possible values include: ''enabled'',

      ''disabled'''
    isRequired: true
    types:
    - <xref:str>
    - <xref:protocol.models.enum>
  - name: status_reason
    description: 'The 128 character-long string that stores the reason

      for the device identity status. All UTF-8 characters are allowed.'
    isRequired: true
    types:
    - <xref:str>
  - name: connection_state_updated_time
    description: 'The date and time the connection

      state was last updated.'
    isRequired: true
    types:
    - <xref:datetime>
  - name: status_updated_time
    description: 'The date and time when the status field was

      last updated.'
    isRequired: true
    types:
    - <xref:datetime>
  - name: last_activity_time
    description: 'The date and last time the device last

      connected, received, or sent a message.'
    isRequired: true
    types:
    - <xref:datetime>
  - name: cloud_to_device_message_count
    description: 'The number of cloud-to-device

      messages currently queued to be sent to the device.'
    isRequired: true
    types:
    - <xref:int>
  - name: authentication
    description: The authentication mechanism used by the device.
    isRequired: true
    types:
    - <xref:azure.iot.hub.protocol.models.AuthenticationMechanism>
  - name: capabilities
    description: 'The set of capabilities of the device. For example,

      if this device is an edge device or not.'
    isRequired: true
    types:
    - <xref:azure.iot.hub.protocol.models.DeviceCapabilities>
  - name: device_scope
    description: 'The scope of the device. Auto generated and immutable

      for edge devices and modifiable in leaf devices to create child/parent

      relationship.'
    isRequired: true
    types:
    - <xref:str>
  - name: parent_scopes
    description: 'The scopes of the upper level edge devices if

      applicable. Only available for edge devices.'
    isRequired: true
    types:
    - <xref:list>[<xref:str>]
methods:
- uid: azure.iot.hub.protocol.models.device.Device.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.iot.hub.protocol.models.device.Device.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.iot.hub.protocol.models.device.Device.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.iot.hub.protocol.models.device.Device.from_dict
  name: from_dict
  summary: 'Parse a dict using given key extractor return a model.


    By default consider key

    extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor

    and last_rest_key_case_insensitive_extractor)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.iot.hub.protocol.models.device.Device.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.iot.hub.protocol.models.device.Device.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to azure from this model.


    This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.


    If you want XML serialization, you can pass the kwargs is_xml=True.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.iot.hub.protocol.models.device.Device.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>