Skip to content

Latest commit

 

History

History
121 lines (93 loc) · 6.22 KB

azure_provisioning_service_description.md

File metadata and controls

121 lines (93 loc) · 6.22 KB

Document: "iotdps"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2018-01-22/iotdps.json")

ProvisioningServiceDescription

The description of the provisioning service.

azure_provisioning_service_description {
  api_version => "api_version",
  etag => "etag (optional)",
  iot_dps_description => "iotDpsDescription",
  location => "location (optional)",
  properties => $azure_iot_dps_properties_description
  provisioning_service_name => "provisioning_service_name",
  resource_group_name => "resource_group_name",
  sku => $azure_iot_dps_sku_info
  subscription_id => "subscription_id",
  tags => "tags (optional)",
}
Name Type Required Description
api_version String true The version of the API.
etag String false The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
iot_dps_description Hash true Description of the provisioning service to create or update.
location String false The resource location.
properties IotDpsPropertiesDescription true Service specific properties for a provisioning service
provisioning_service_name String true Name of provisioning service to create or update.
resource_group_name String true Resource group identifier.
sku IotDpsSkuInfo true Sku info for a provisioning Service.
subscription_id String true The subscription identifier.
tags Hash false The resource tags.

IotDpsPropertiesDescription

the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope

$azure_iot_dps_properties_description = {
  allocationPolicy => "allocationPolicy (optional)",
  authorizationPolicies => $azure_
  iotHubs => $azure_iot_hub_definition_description
  provisioningState => "provisioningState (optional)",
  state => "state (optional)",
}
Name Type Required Description
allocationPolicy String false Allocation policy to be used by this provisioning service.
authorizationPolicies false List of authorization keys for a provisioning service.
iotHubs IotHubDefinitionDescription false List of IoT hubs associated with this provisioning service.
provisioningState String false The ARM provisioning state of the provisioning service.
state String false Current state of the provisioning service. 

$_ = {
}
Name Type Required Description

IotHubDefinitionDescription

Description of the IoT hub.

$azure_iot_hub_definition_description = {
  allocationWeight => "1234 (optional)",
  applyAllocationPolicy => "applyAllocationPolicy (optional)",
  connectionString => "connectionString",
  location => "location",
}
Name Type Required Description
allocationWeight Integer false weight to apply for a given iot h.
applyAllocationPolicy Boolean false flag for applying allocationPolicy or not for a given iot hub.
connectionString String true Connection string og the IoT hub.
location String true ARM region of the IoT hub.

IotDpsSkuInfo

List of possible provisioning service SKUs.

$azure_iot_dps_sku_info = {
  capacity => "1234 (optional)",
  name => "name (optional)",
}
Name Type Required Description
capacity Integer false The number of units to provision
name String false Sku name.

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the ProvisioningServiceDescription

Operation Path Verb Description OperationID
Create /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Devices/provisioningServices/%{provisioning_service_name} Put Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service. IotDpsResource_CreateOrUpdate
List - list all /subscriptions/%{subscription_id}/providers/Microsoft.Devices/provisioningServices Get List all the provisioning services for a given subscription id. IotDpsResource_ListBySubscription
List - get one /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Devices/provisioningServices/%{provisioning_service_name} Get Get the metadata of the provisioning service without SAS keys. IotDpsResource_Get
List - get list using params /subscriptions/%{subscription_id}/providers/Microsoft.Devices/provisioningServices Get List all the provisioning services for a given subscription id. IotDpsResource_ListBySubscription
Update /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Devices/provisioningServices/%{provisioning_service_name} Put Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service. IotDpsResource_CreateOrUpdate
Delete /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Devices/provisioningServices/%{provisioning_service_name} Delete Deletes the Provisioning Service. IotDpsResource_Delete