azure.iot.hub.protocol.models.ExportImportDevice.yml

### YamlMime:PythonClass
uid: azure.iot.hub.protocol.models.ExportImportDevice
name: ExportImportDevice
fullName: azure.iot.hub.protocol.models.ExportImportDevice
module: azure.iot.hub.protocol.models
inheritances:
- msrest.serialization.Model
summary: ExportImportDevice.
constructor:
  syntax: 'ExportImportDevice(*, id: str = None, module_id: str = None, e_tag: str
    = None, import_mode=None, status=None, status_reason: str = None, authentication=None,
    twin_etag: str = None, tags=None, properties=None, capabilities=None, device_scope:
    str = None, parent_scopes=None, **kwargs)'
  parameters:
  - name: id
    description: The unique identifier of the device.
    isRequired: true
    types:
    - <xref:str>
  - name: module_id
    description: The unique identifier of the module, if applicable.
    isRequired: true
    types:
    - <xref:str>
  - name: e_tag
    description: 'The string representing a weak ETag for the device RFC7232.

      The value is only used if import mode is updateIfMatchETag, in that case

      the import operation is performed only if this ETag matches the value

      maintained by the server.'
    isRequired: true
    types:
    - <xref:str>
  - name: import_mode
    description: 'The type of registry operation and ETag preferences.

      Possible values include: ''create'', ''update'', ''updateIfMatchETag'',

      ''delete'', ''deleteIfMatchETag'', ''updateTwin'', ''updateTwinIfMatchETag'''
    isRequired: true
    types:
    - <xref:str>
    - <xref:protocol.models.enum>
  - name: status
    description: 'The status of the module. If disabled, the module 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: authentication
    description: 'The authentication mechanism used by the module.

      This parameter is optional and defaults to SAS if not provided. In that

      case, primary/secondary access keys are auto-generated.'
    isRequired: true
    types:
    - <xref:azure.iot.hub.protocol.models.AuthenticationMechanism>
  - name: twin_etag
    description: 'The string representing a weak ETag for the device twin

      RFC7232. The value is only used if import mode is updateIfMatchETag, in

      that case the import operation is performed only if this ETag matches the

      value maintained by the server.'
    isRequired: true
    types:
    - <xref:str>
  - name: tags
    description: 'The JSON document read and written by the solution back end.

      The tags are not visible to device apps.'
    isRequired: true
    types:
    - <xref:dict>[<xref:str>, <xref:object>]
  - name: properties
    description: The desired and reported properties for the device.
    isRequired: true
    types:
    - <xref:azure.iot.hub.protocol.models.PropertyContainer>
  - name: capabilities
    description: The status of capabilities enabled on the device.
    isRequired: true
    types:
    - <xref:azure.iot.hub.protocol.models.DeviceCapabilities>
  - name: device_scope
    description: The scope of the device.
    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>]
  keywordOnlyParameters:
  - name: id
    isRequired: true
  - name: module_id
    isRequired: true
  - name: e_tag
    isRequired: true
  - name: import_mode
    isRequired: true
  - name: status
    isRequired: true
  - name: status_reason
    isRequired: true
  - name: authentication
    isRequired: true
  - name: twin_etag
    isRequired: true
  - name: tags
    isRequired: true
  - name: properties
    isRequired: true
  - name: capabilities
    isRequired: true
  - name: device_scope
    isRequired: true
  - name: parent_scopes
    isRequired: true
methods:
- uid: azure.iot.hub.protocol.models.ExportImportDevice.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.ExportImportDevice.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.ExportImportDevice.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.iot.hub.protocol.models.ExportImportDevice.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.ExportImportDevice.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.iot.hub.protocol.models.ExportImportDevice.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.ExportImportDevice.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>