in azext_iot/sdk/digitaltwins/dataplane/operations/digital_twins_operations.py [0:0]
def add(
self, id, twin, digital_twins_add_options=None, custom_headers=None, raw=False, **operation_config):
"""Adds or replaces a digital twin.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The digital twin id or payload is invalid.
* ModelDecommissioned - The model for the digital twin is
decommissioned.
* TwinLimitReached - The maximum number of digital twins allowed has
been reached.
* ValidationFailed - The digital twin payload is not valid.
* 412 Precondition Failed
* PreconditionFailed - The precondition check (If-Match or
If-None-Match) failed.
:param id: The id of the digital twin. The id is unique within the
service and case sensitive.
:type id: str
:param twin: The digital twin instance being added. If provided, the
$dtId property is ignored.
:type twin: object
:param digital_twins_add_options: Additional parameters for the
operation
:type digital_twins_add_options:
~dataplane.models.DigitalTwinsAddOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: dict or ClientRawResponse if raw=true
:rtype: dict[str, object] or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
"""
if_none_match = None
if digital_twins_add_options is not None:
if_none_match = digital_twins_add_options.if_none_match
traceparent = None
if digital_twins_add_options is not None:
traceparent = digital_twins_add_options.traceparent
tracestate = None
if digital_twins_add_options is not None:
tracestate = digital_twins_add_options.tracestate
# Construct URL
url = self.add.metadata['url']
path_format_arguments = {
'id': self._serialize.url("id", id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str', min_length=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['x-ms-client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if if_none_match is not None:
header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str')
if traceparent is not None:
header_parameters['traceparent'] = self._serialize.header("traceparent", traceparent, 'str')
if tracestate is not None:
header_parameters['tracestate'] = self._serialize.header("tracestate", tracestate, 'str')
# Construct body
body_content = self._serialize.body(twin, 'object')
# Construct and send request
request = self._client.put(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ErrorResponseException(self._deserialize, response)
deserialized = None
header_dict = {}
if response.status_code == 200:
deserialized = self._deserialize('{object}', response)
header_dict = {
'ETag': 'str',
'x-ms-error-code': 'str',
}
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized