Iot Dps Resource - Update
Aktualisieren Sie die Tags eines vorhandenen Bereitstellungsdiensts. Um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
provisioning
|
path | True |
string |
Name des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts. |
resource
|
path | True |
string |
Ressourcengruppenbezeichner. |
subscription
|
path | True |
string |
Die Abonnement-ID. |
api-version
|
query | True |
string |
Die Version der API. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
tags |
object |
Ressourcentags |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Bereitstellungsdienst wurde erfolgreich aktualisiert |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
DPSPatch
Sample Request
PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2018-01-22
{
"tags": {
"foo": "bar"
}
}
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"
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {
"foo": "bar"
},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
Definitionen
Name | Beschreibung |
---|---|
Access |
Rechte, die dieser Schlüssel besitzt. |
Allocation |
Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. |
Iot |
die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot Hubs, aktuellem Zustand und systemgenerierten Eigenschaften wie Hostname und idScope |
Iot |
Sku-Name. |
Iot |
Liste der möglichen Bereitstellungsdienst-SKUs. |
Iot |
Beschreibung des IoT-Hubs. |
Provisioning |
Die Beschreibung des Bereitstellungsdiensts. |
Shared |
Beschreibung des freigegebenen Zugriffsschlüssels. |
state |
Aktueller Status des Bereitstellungsdiensts. |
Tags |
Ein Container, der nur die Tags für eine Ressource enthält, sodass der Benutzer die Tags für einen Bereitstellungsdienst instance aktualisieren kann. |
AccessRightsDescription
Rechte, die dieser Schlüssel besitzt.
Name | Typ | Beschreibung |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
IotDpsPropertiesDescription
die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot Hubs, aktuellem Zustand und systemgenerierten Eigenschaften wie Hostname und idScope
Name | Typ | Beschreibung |
---|---|---|
allocationPolicy |
Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. |
|
authorizationPolicies |
Shared |
Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst. |
deviceProvisioningHostName |
string |
Geräteendpunkt für diesen Bereitstellungsdienst. |
idScope |
string |
Eindeutiger Bezeichner dieses Bereitstellungsdiensts. |
iotHubs |
Liste der IoT Hubs, die diesem Bereitstellungsdienst zugeordnet sind. |
|
provisioningState |
string |
Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts. |
serviceOperationsHostName |
string |
Dienstendpunkt für den Bereitstellungsdienst. |
state |
Aktueller Status des Bereitstellungsdiensts. |
IotDpsSku
Sku-Name.
Name | Typ | Beschreibung |
---|---|---|
S1 |
string |
IotDpsSkuInfo
Liste der möglichen Bereitstellungsdienst-SKUs.
Name | Typ | Beschreibung |
---|---|---|
capacity |
integer |
Die Anzahl der bereitzustellenden Einheiten |
name |
Sku-Name. |
|
tier |
string |
Tarifname des Bereitstellungsdiensts. |
IotHubDefinitionDescription
Beschreibung des IoT-Hubs.
Name | Typ | Beschreibung |
---|---|---|
allocationWeight |
integer |
Gewicht, das für einen bestimmten iot h beantragt werden soll. |
applyAllocationPolicy |
boolean |
Flag für die Anwendung von allocationPolicy oder nicht für einen bestimmten iot Hub. |
connectionString |
string |
Verbindungszeichenfolge und IoT Hub. |
location |
string |
ARM-Region des IoT-Hubs. |
name |
string |
Hostname des IoT Hubs. |
ProvisioningServiceDescription
Die Beschreibung des Bereitstellungsdiensts.
Name | Typ | Beschreibung |
---|---|---|
etag |
string |
Das Feld Etag ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss es auch als Header gemäß der normalen ETag-Konvention bereitgestellt werden. |
id |
string |
Der Ressourcenbezeichner. |
location |
string |
Der Ressourcenspeicherort. |
name |
string |
Der Name der Ressource. |
properties |
Dienstspezifische Eigenschaften für einen Bereitstellungsdienst |
|
sku |
SKU-Informationen für einen Bereitstellungsdienst. |
|
tags |
object |
Die Ressourcentags. |
type |
string |
Der Ressourcentyp. |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
Beschreibung des freigegebenen Zugriffsschlüssels.
Name | Typ | Beschreibung |
---|---|---|
keyName |
string |
Name des Schlüssels. |
primaryKey |
string |
Primärer SAS-Schlüsselwert. |
rights |
Rechte, die dieser Schlüssel besitzt. |
|
secondaryKey |
string |
Sekundärer SAS-Schlüsselwert. |
state
Aktueller Status des Bereitstellungsdiensts.
Name | Typ | Beschreibung |
---|---|---|
Activating |
string |
|
ActivationFailed |
string |
|
Active |
string |
|
Deleted |
string |
|
Deleting |
string |
|
DeletionFailed |
string |
|
FailingOver |
string |
|
FailoverFailed |
string |
|
Resuming |
string |
|
Suspended |
string |
|
Suspending |
string |
|
Transitioning |
string |
TagsResource
Ein Container, der nur die Tags für eine Ressource enthält, sodass der Benutzer die Tags für einen Bereitstellungsdienst instance aktualisieren kann.
Name | Typ | Beschreibung |
---|---|---|
tags |
object |
Ressourcentags |