v2

latestSwagger 2.0raw.githubusercontent.com2021-04-273265113.0 KB

PUT

Create or update the metadata of an IoT hub.

Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.

put/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}

Path parameters

subscriptionIdstring required

The subscription identifier.

resourceGroupNamestring required

The name of the resource group that contains the IoT hub.

resourceNamestring required

The name of the IoT hub.

Query parameters

api-versionstring required

The version of the API.

Headers

If-Matchstring

ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.

Request body

idstring

The resource identifier.

namestring

The resource name.

typestring

The resource type.

locationstring required

The resource location.

tagsobject

The resource tags.

Response

This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.