Iot Dps Resource - Create Or Update
Skapa eller uppdatera metadata för etableringstjänsten. Det vanliga mönstret för att ändra en egenskap är att hämta etableringstjänstens metadata och säkerhetsmetadata och sedan kombinera dem med de ändrade värdena i en ny brödtext för att uppdatera etableringstjänsten.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
provisioning
|
path | True |
string |
Namnet på etableringstjänsten som ska skapas eller uppdateras. |
resource
|
path | True |
string |
Resursgruppsidentifierare. |
subscription
|
path | True |
string |
Prenumerationsidentifieraren. |
api-version
|
query | True |
string |
Versionen av API:et. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
location | True |
string |
Resursplatsen. |
properties | True |
Tjänstspecifika egenskaper för en etableringstjänst |
|
sku | True |
SKU-information för en etableringstjänst. |
|
etag |
string |
Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. |
|
tags |
object |
Resurstaggar. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Brödtexten innehåller alla icke-säkerhetsegenskaper för etableringstjänsten. Säkerhetsrelaterade egenskaper är inställda på null. |
|
201 Created |
Det här är en tidskrävande åtgärd. Åtgärden returnerar ett 201 om verifieringen är klar. Svaret innehåller en Azure-AsyncOperation rubrik som innehåller en status-URL. Klienter förväntas avsöka status-URL:en för åtgärdens status. Om åtgärden lyckas returneras HTTP-statuskoden 201 (OK). |
|
Other Status Codes |
Standardfelsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
DPSCreate
Sample Request
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2018-01-22
{
"location": "East US",
"type": "Microsoft.Devices/ProvisioningServices",
"properties": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"tags": {}
}
Sample Response
{
"etag": "AAAAAAAADGk=",
"name": "myFirstProvisioningService",
"location": "eastus",
"properties": {
"state": "Active",
"allocationPolicy": "Hashed",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"authorizationPolicies": []
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
{
"etag": "AAAAAAAADGk=",
"name": "myFirstProvisioningService",
"location": "eastus",
"properties": {
"state": "Active",
"allocationPolicy": "Hashed",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"authorizationPolicies": []
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
Definitioner
Name | Description |
---|---|
Access |
Rättigheter som nyckeln har. |
Allocation |
Allokeringsprincip som ska användas av den här etableringstjänsten. |
Error |
Felinformation. |
Iot |
tjänstspecifika egenskaper för en etableringstjänst, inklusive nycklar, länkade iot-hubbar, aktuellt tillstånd och systemgenererade egenskaper som värdnamn och idScope |
Iot |
Sku-namn. |
Iot |
Lista över möjliga SKU:er för etableringstjänsten. |
Iot |
Beskrivning av IoT-hubben. |
Provisioning |
Beskrivningen av etableringstjänsten. |
Shared |
Beskrivning av den delade åtkomstnyckeln. |
state |
Etableringstjänstens aktuella tillstånd. |
AccessRightsDescription
Rättigheter som nyckeln har.
Name | Typ | Description |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
Allokeringsprincip som ska användas av den här etableringstjänsten.
Name | Typ | Description |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
ErrorDetails
Felinformation.
Name | Typ | Description |
---|---|---|
code |
string |
Felkoden. |
details |
string |
Felinformationen. |
httpStatusCode |
string |
HTTP-statuskoden. |
message |
string |
Felmeddelandet. |
IotDpsPropertiesDescription
tjänstspecifika egenskaper för en etableringstjänst, inklusive nycklar, länkade iot-hubbar, aktuellt tillstånd och systemgenererade egenskaper som värdnamn och idScope
Name | Typ | Description |
---|---|---|
allocationPolicy |
Allokeringsprincip som ska användas av den här etableringstjänsten. |
|
authorizationPolicies |
Shared |
Lista över auktoriseringsnycklar för en etableringstjänst. |
deviceProvisioningHostName |
string |
Enhetsslutpunkt för den här etableringstjänsten. |
idScope |
string |
Unik identifierare för den här etableringstjänsten. |
iotHubs |
Lista över IoT-hubbar som är associerade med den här etableringstjänsten. |
|
provisioningState |
string |
ARM-etableringstillståndet för etableringstjänsten. |
serviceOperationsHostName |
string |
Tjänstslutpunkt för etableringstjänst. |
state |
Etableringstjänstens aktuella tillstånd. |
IotDpsSku
Sku-namn.
Name | Typ | Description |
---|---|---|
S1 |
string |
IotDpsSkuInfo
Lista över möjliga SKU:er för etableringstjänsten.
Name | Typ | Description |
---|---|---|
capacity |
integer |
Antalet enheter som ska etableras |
name |
Sku-namn. |
|
tier |
string |
Namn på prisnivå för etableringstjänsten. |
IotHubDefinitionDescription
Beskrivning av IoT-hubben.
Name | Typ | Description |
---|---|---|
allocationWeight |
integer |
vikt att ansöka om en viss iot h. |
applyAllocationPolicy |
boolean |
flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. |
connectionString |
string |
Anslutningssträng från IoT-hubben. |
location |
string |
ARM-regionen i IoT-hubben. |
name |
string |
Värdnamnet för IoT-hubben. |
ProvisioningServiceDescription
Beskrivningen av etableringstjänsten.
Name | Typ | Description |
---|---|---|
etag |
string |
Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. |
id |
string |
Resursidentifieraren. |
location |
string |
Resursplatsen. |
name |
string |
Resursnamnet. |
properties |
Tjänstspecifika egenskaper för en etableringstjänst |
|
sku |
SKU-information för en etableringstjänst. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
Beskrivning av den delade åtkomstnyckeln.
Name | Typ | Description |
---|---|---|
keyName |
string |
Namnet på nyckeln. |
primaryKey |
string |
Primärt SAS-nyckelvärde. |
rights |
Rättigheter som nyckeln har. |
|
secondaryKey |
string |
Sekundärt SAS-nyckelvärde. |
state
Etableringstjänstens aktuella tillstånd.
Name | Typ | Description |
---|---|---|
Activating |
string |
|
ActivationFailed |
string |
|
Active |
string |
|
Deleted |
string |
|
Deleting |
string |
|
DeletionFailed |
string |
|
FailingOver |
string |
|
FailoverFailed |
string |
|
Resuming |
string |
|
Suspended |
string |
|
Suspending |
string |
|
Transitioning |
string |