in azext_iot/sdk/digitaltwins/dataplane/operations/digital_twins_operations.py [0:0]
def delete_relationship(
self, id, relationship_id, digital_twins_delete_relationship_options=None, custom_headers=None, raw=False, **operation_config):
"""Deletes a relationship between two digital twins.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The digital twin id or relationship id is invalid.
* 404 Not Found
* DigitalTwinNotFound - The digital twin was not found.
* RelationshipNotFound - The relationship was not found.
* 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 relationship_id: The id of the relationship. The id is unique
within the digital twin and case sensitive.
:type relationship_id: str
:param digital_twins_delete_relationship_options: Additional
parameters for the operation
:type digital_twins_delete_relationship_options:
~dataplane.models.DigitalTwinsDeleteRelationshipOptions
: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: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
"""
if_match = None
if digital_twins_delete_relationship_options is not None:
if_match = digital_twins_delete_relationship_options.if_match
traceparent = None
if digital_twins_delete_relationship_options is not None:
traceparent = digital_twins_delete_relationship_options.traceparent
tracestate = None
if digital_twins_delete_relationship_options is not None:
tracestate = digital_twins_delete_relationship_options.tracestate
# Construct URL
url = self.delete_relationship.metadata['url']
path_format_arguments = {
'id': self._serialize.url("id", id, 'str'),
'relationshipId': self._serialize.url("relationship_id", relationship_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_match is not None:
header_parameters['If-Match'] = self._serialize.header("if_match", if_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 and send request
request = self._client.delete(url, query_parameters)
response = self._client.send(request, header_parameters, stream=False, **operation_config)
# @vilit - added 202
if response.status_code not in [202, 204]:
raise models.ErrorResponseException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'x-ms-error-code': 'str',
})
return client_raw_response