Iot Dps Resource - Create Or Update

Service:: IoT Hub Device Provisioning Service

API-versie:: 2022-12-12

Maak of werk de metagegevens van de inrichtingsservice bij. Het gebruikelijke patroon voor het wijzigen van een eigenschap is het ophalen van de metagegevens en beveiligingsmetagegevens van de inrichtingsservice en deze vervolgens combineren met de gewijzigde waarden in een nieuwe hoofdtekst om de inrichtingsservice bij te werken.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2022-12-12

URI-parameters

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

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De resourcelocatie.
properties	True	IotDpsPropertiesDescription	Servicespecifieke eigenschappen voor een inrichtingsservice
sku	True	IotDpsSkuInfo	SKU-gegevens voor een inrichtingsservice.
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.
resourcegroup		string	De resourcegroep van de resource.
subscriptionid		string	De abonnements-id van de resource.
tags		object	De resourcetags.

Antwoorden

Name	Type	Description
200 OK	ProvisioningServiceDescription	De hoofdtekst bevat alle niet-beveiligingseigenschappen van de inrichtingsservice. Beveiligingsgerelateerde eigenschappen worden ingesteld op null.
201 Created	ProvisioningServiceDescription	Dit is een langdurige bewerking. De bewerking retourneert een 201 als de validatie is voltooid. Het antwoord bevat een Azure-AsyncOperation header die een status-URL bevat. Clients zullen naar verwachting de status-URL voor de status van de bewerking peilen. Als dit lukt, retourneert de bewerking HTTP-statuscode 201 (OK).
Other Status Codes	ErrorDetails	Standaardfoutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

DPSCreate

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2022-12-12

{
  "location": "East US",
  "properties": {
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

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",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Statuscode:: 201

{
  "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": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "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.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorDetails	Foutdetails.
IotDpsPropertiesDescription	de servicespecifieke eigenschappen van een inrichtingsservice, inclusief sleutels, gekoppelde iot-hubs, huidige status en door het systeem gegenereerde eigenschappen, zoals hostnaam en idScope
IotDpsSku	SKU-naam.
IotDpsSkuInfo	Lijst met mogelijke SKU's voor de inrichtingsservice.
IotHubDefinitionDescription	Beschrijving van de IoT-hub.
IpFilterActionType	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.
IpFilterRule	De IP-filterregels voor een inrichtingsservice.
IpFilterTargetType	Doel voor aanvragen die zijn vastgelegd door deze regel.
PrivateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding
PrivateEndpointConnection	De privé-eindpuntverbinding van een inrichtingsservice
PrivateEndpointConnectionProperties	De eigenschappen van een privé-eindpuntverbinding
PrivateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding
PrivateLinkServiceConnectionStatus	De status van een privé-eindpuntverbinding
ProvisioningServiceDescription	De beschrijving van de inrichtingsservice.
PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschrijving van de gedeelde toegangssleutel.
state	Huidige status van de inrichtingsservice.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AccessRightsDescription

Inventarisatie

Rechten die deze sleutel heeft.

Waarde	Description
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

Inventarisatie

Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice.

Waarde	Description
Hashed
GeoLatency
Static

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Foutdetails.

Name	Type	Description
code	integer (int32)	De foutcode.
details	string	De foutdetails.
httpStatusCode	string	De HTTP-statuscode.
message	string	Het foutbericht.

IotDpsPropertiesDescription

Object

de servicespecifieke eigenschappen van een inrichtingsservice, inclusief 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.
enableDataResidency	boolean	Facultatief. Geeft aan of voor het DPS-exemplaar Data Residency is ingeschakeld, waardoor het herstel na noodgevallen voor meerdere geografische paren wordt verwijderd.
idScope	string	Unieke id van deze inrichtingsservice.
iotHubs	IotHubDefinitionDescription[]	Lijst met IoT-hubs die zijn gekoppeld aan deze inrichtingsservice.
ipFilterRules	IpFilterRule[]	De IP-filterregels.
portalOperationsHostName	string	Portal-eindpunt om CORS in te schakelen voor deze inrichtingsservice.
privateEndpointConnections	PrivateEndpointConnection[]	Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub
provisioningState	string	De ARM-inrichtingsstatus van de inrichtingsservice.
publicNetworkAccess	PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
serviceOperationsHostName	string	Service-eindpunt voor inrichtingsservice.
state	state	Huidige status van de inrichtingsservice.

IotDpsSku

Inventarisatie

SKU-naam.

Waarde	Description
S1

IotDpsSkuInfo

Object

Lijst met mogelijke SKU's voor de inrichtingsservice.

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

IotHubDefinitionDescription

Object

Beschrijving van de IoT-hub.

Name	Type	Description
allocationWeight	integer (int32)	gewicht om aan te vragen voor een bepaalde iot h.
applyAllocationPolicy	boolean	vlag voor het toepassen van allocationPolicy of niet voor een bepaalde iot-hub.
connectionString	string	Verbindingsreeks van de IoT-hub.
location	string	ARM-regio van de IoT-hub.
name	string	Hostnaam van de IoT-hub.

IpFilterActionType

Inventarisatie

De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.

Waarde	Description
Accept
Reject

IpFilterRule

Object

De IP-filterregels voor een inrichtingsservice.

Name	Type	Description
action	IpFilterActionType	De gewenste actie voor aanvragen die door deze regel zijn vastgelegd.
filterName	string	De naam van de IP-filterregel.
ipMask	string	Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat.
target	IpFilterTargetType	Doel voor aanvragen die zijn vastgelegd door deze regel.

IpFilterTargetType

Inventarisatie

Doel voor aanvragen die zijn vastgelegd door deze regel.

Waarde	Description
all
serviceApi
deviceApi

PrivateEndpoint

Object

De eigenschap privé-eindpunt van een privé-eindpuntverbinding

Name	Type	Description
id	string	De resource-id.

PrivateEndpointConnection

Object

De privé-eindpuntverbinding van een inrichtingsservice

Name	Type	Description
id	string	De resource-id.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	De resourcenaam.
properties	PrivateEndpointConnectionProperties	De eigenschappen van een privé-eindpuntverbinding
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	string	Het resourcetype.

PrivateEndpointConnectionProperties

Object

De eigenschappen van een privé-eindpuntverbinding

Name	Type	Description
privateEndpoint	PrivateEndpoint	De eigenschap privé-eindpunt van een privé-eindpuntverbinding
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionState

Object

De huidige status van een privé-eindpuntverbinding

Name	Type	Description
actionsRequired	string	Acties die vereist zijn voor een privé-eindpuntverbinding
description	string	De beschrijving voor de huidige status van een privé-eindpuntverbinding
status	PrivateLinkServiceConnectionStatus	De status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionStatus

Inventarisatie

De status van een privé-eindpuntverbinding

Waarde	Description
Pending
Approved
Rejected
Disconnected

ProvisioningServiceDescription

Object

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 pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	De resourcenaam.
properties	IotDpsPropertiesDescription	Servicespecifieke eigenschappen voor een inrichtingsservice
resourcegroup	string	De resourcegroep van de resource.
sku	IotDpsSkuInfo	SKU-gegevens voor een inrichtingsservice.
subscriptionid	string	De abonnements-id van de resource.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object	De resourcetags.
type	string	Het resourcetype.

PublicNetworkAccess

Inventarisatie

Of aanvragen van openbaar netwerk zijn toegestaan

Waarde	Description
Enabled
Disabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

Beschrijving van de gedeelde toegangssleutel.

Name	Type	Description
keyName	string	Naam van de sleutel.
primaryKey	string	Primaire SAS-sleutelwaarde.
rights	AccessRightsDescription	Rechten die deze sleutel heeft.
secondaryKey	string	Secundaire SAS-sleutelwaarde.

state

Inventarisatie

Huidige status van de inrichtingsservice.

Waarde	Description
Activating
Active
Deleting
Deleted
ActivationFailed
DeletionFailed
Transitioning
Suspending
Suspended
Resuming
FailingOver
FailoverFailed

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Iot Dps Resource - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

DPSCreate

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData