Iot Dps Resource - Update

Referentie

Service:: IoT Hub Device Provisioning Service

API-versie:: 2018-01-22

De tags van een bestaande inrichtingsservice bijwerken. als u andere velden wilt bijwerken, gebruikt u de methode CreateOrUpdate

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22

URI-parameters

Name	In	Vereist	Type	Description
provisioningServiceName	path	True	string	Naam van de inrichtingsservice die moet worden gemaakt of bijgewerkt.
resourceGroupName	path	True	string	Resourcegroep-id.
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Aanvraagbody

Name	Type	Description
tags	object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	ProvisioningServiceDescription	Inrichtingsservice is bijgewerkt

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

DPSPatch

Voorbeeldaanvraag

HTTP

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"
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "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
  }
}

Definities

Name	Description
AccessRightsDescription	Rechten die deze sleutel heeft.
AllocationPolicy	Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice.
IotDpsPropertiesDescription	de servicespecifieke eigenschappen van een inrichtingsservice, waaronder sleutels, gekoppelde ioT-hubs, huidige status en door het systeem gegenereerde eigenschappen, zoals hostnaam en idScope
IotDpsSku	SKU-naam.
IotDpsSkuInfo	Lijst met mogelijke inrichtingsservice-SKU's.
IotHubDefinitionDescription	Beschrijving van de IoT-hub.
ProvisioningServiceDescription	De beschrijving van de inrichtingsservice.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschrijving van de gedeelde toegangssleutel.
state	Huidige status van de inrichtingsservice.
TagsResource	Een container met alleen de tags voor een resource, zodat de gebruiker de tags op een inrichtingsservice-exemplaar kan bijwerken.

AccessRightsDescription

Rechten die deze sleutel heeft.

Name	Type	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice.

Name	Type	Description
GeoLatency	string
Hashed	string
Static	string

IotDpsPropertiesDescription

de servicespecifieke eigenschappen van een inrichtingsservice, waaronder sleutels, gekoppelde ioT-hubs, huidige status en door het systeem gegenereerde eigenschappen, zoals hostnaam en idScope

Name	Type	Description
allocationPolicy	AllocationPolicy	Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Lijst met autorisatiesleutels voor een inrichtingsservice.
deviceProvisioningHostName	string	Apparaateindpunt voor deze inrichtingsservice.
idScope	string	De unieke id van deze inrichtingsservice.
iotHubs	IotHubDefinitionDescription[]	Lijst met IoT-hubs die zijn gekoppeld aan deze inrichtingsservice.
provisioningState	string	De ARM-inrichtingsstatus van de inrichtingsservice.
serviceOperationsHostName	string	Service-eindpunt voor inrichtingsservice.
state	state	Huidige status van de inrichtingsservice.

IotDpsSku

SKU-naam.

Name	Type	Description
S1	string

IotDpsSkuInfo

Lijst met mogelijke inrichtingsservice-SKU's.

Name	Type	Description
capacity	integer	Het aantal eenheden dat moet worden ingericht
name	IotDpsSku	SKU-naam.
tier	string	De naam van de prijscategorie van de inrichtingsservice.

IotHubDefinitionDescription

Beschrijving van de IoT-hub.

Name	Type	Description
allocationWeight	integer	gewicht toe te passen voor een bepaalde iot h.
applyAllocationPolicy	boolean	vlag voor het toepassen van allocationPolicy of niet voor een bepaalde ioT-hub.
connectionString	string	Verbindingsreeks voor de IoT-hub.
location	string	ARM-regio van de IoT-hub.
name	string	Hostnaam van de IoT-hub.

ProvisioningServiceDescription

De beschrijving van de inrichtingsservice.

Name	Type	Description
etag	string	Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie.
id	string	De resource-id.
location	string	De resourcelocatie.
name	string	De resourcenaam.
properties	IotDpsPropertiesDescription	Servicespecifieke eigenschappen voor een inrichtingsservice
sku	IotDpsSkuInfo	SKU-informatie voor een inrichtingsservice.
tags	object	De resourcetags.
type	string	Het resourcetype.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschrijving van de gedeelde toegangssleutel.

Name	Type	Description
keyName	string	Naam van de sleutel.
primaryKey	string	Waarde van primaire SAS-sleutel.
rights	AccessRightsDescription	Rechten die deze sleutel heeft.
secondaryKey	string	Waarde van secundaire SAS-sleutel.

state

Huidige status van de inrichtingsservice.

Name	Type	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

TagsResource

Een container met alleen de tags voor een resource, zodat de gebruiker de tags op een inrichtingsservice-exemplaar kan bijwerken.

Name	Type	Description
tags	object	Resourcetags

Delen via