Iot Dps Resource - Create Or Update

Dienst:: IoT Hub Device Provisioning Service

API-Version:: 2022-12-12

Erstellen oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten und Sicherheitsmetadaten des Bereitstellungsdiensts abzurufen, und sie dann mit den geänderten Werten in einem neuen Textkörper zu kombinieren, um den Bereitstellungsdienst zu aktualisieren.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
provisioningServiceName	path	True	string	Name des Bereitstellungsdiensts, der erstellt oder aktualisiert werden soll.
resourceGroupName	path	True	string	Ressourcengruppenbezeichner.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die Version der API.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der Ressourcenspeicherort.
properties	True	IotDpsPropertiesDescription	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst
sku	True	IotDpsSkuInfo	Sku-Informationen für einen Bereitstellungsdienst.
etag		string	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.
resourcegroup		string	Die Ressourcengruppe der Ressource.
subscriptionid		string	Die Abonnement-ID der Ressource.
tags		object	Die Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	ProvisioningServiceDescription	Der Text enthält alle nicht sicherheitsrelevanten Eigenschaften des Bereitstellungsdiensts. Sicherheitsbezogene Eigenschaften werden auf NULL festgelegt.
201 Created	ProvisioningServiceDescription	Dies ist ein lang ausgeführter Vorgang. Der Vorgang gibt einen Wert vom Typ 201 zurück, wenn die Überprüfung abgeschlossen ist. Die Antwort enthält einen Azure-AsyncOperation Header, der eine Status-URL enthält. Clients werden erwartet, dass die Status-URL für den Status des Vorgangs abgerufen wird. Bei erfolgreicher Ausführung gibt der Vorgang den HTTP-Statuscode 201 (OK) zurück.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

DPSCreate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AccessRightsDescription	Rechte, die dieser Schlüssel hat.
AllocationPolicy	Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDetails	Fehlerdetails.
IotDpsPropertiesDescription	die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot-Hubs, aktueller Status und vom System generierte Eigenschaften wie Hostname und idScope
IotDpsSku	Sku-Name.
IotDpsSkuInfo	Liste der möglichen Bereitstellungsdienst-SKUs.
IotHubDefinitionDescription	Beschreibung des IoT-Hubs.
IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
IpFilterRule	Die IP-Filterregeln für einen Bereitstellungsdienst.
IpFilterTargetType	Ziel für Anforderungen, die von dieser Regel erfasst werden.
PrivateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung
PrivateEndpointConnection	Die private Endpunktverbindung eines Bereitstellungsdiensts
PrivateEndpointConnectionProperties	Die Eigenschaften einer privaten Endpunktverbindung
PrivateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung
PrivateLinkServiceConnectionStatus	Der Status einer privaten Endpunktverbindung
ProvisioningServiceDescription	Die Beschreibung des Bereitstellungsdiensts.
PublicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschreibung des freigegebenen Zugriffsschlüssels.
state	Aktueller Status des Bereitstellungsdiensts.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessRightsDescription

Enumeration

Rechte, die dieser Schlüssel hat.

Wert	Beschreibung
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

Enumeration

Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.

Wert	Beschreibung
Hashed
GeoLatency
Static

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorDetails

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	integer (int32)	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

IotDpsPropertiesDescription

Objekt

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot-Hubs, aktueller Status und vom System generierte Eigenschaften wie Hostname und idScope

Name	Typ	Beschreibung
allocationPolicy	AllocationPolicy	Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst.
deviceProvisioningHostName	string	Geräteendpunkt für diesen Bereitstellungsdienst.
enableDataResidency	boolean	Wahlfrei. Gibt an, ob die DPS-Instanz Data Residency aktiviert hat und die cross-geo-pair-Notfallwiederherstellung entfernt wird.
idScope	string	Eindeutiger Bezeichner dieses Bereitstellungsdiensts.
iotHubs	IotHubDefinitionDescription[]	Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind.
ipFilterRules	IpFilterRule[]	Die IP-Filterregeln.
portalOperationsHostName	string	Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst.
privateEndpointConnections	PrivateEndpointConnection[]	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden
provisioningState	string	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.
publicNetworkAccess	PublicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.
serviceOperationsHostName	string	Dienstendpunkt für den Bereitstellungsdienst.
state	state	Aktueller Status des Bereitstellungsdiensts.

IotDpsSku

Enumeration

Sku-Name.

Wert	Beschreibung
S1

IotDpsSkuInfo

Objekt

Liste der möglichen Bereitstellungsdienst-SKUs.

Name	Typ	Beschreibung
capacity	integer (int64)	Die Anzahl der bereitzustellenden Einheiten
name	IotDpsSku	Sku-Name.
tier	string	Preisstufenname des Bereitstellungsdiensts.

IotHubDefinitionDescription

Objekt

Beschreibung des IoT-Hubs.

Name	Typ	Beschreibung
allocationWeight	integer (int32)	Gewichtung, um für einen bestimmten Iot h anzuwenden.
applyAllocationPolicy	boolean	Flag für die Anwendung von allocationPolicy oder nicht für einen bestimmten IoT Hub.
connectionString	string	Verbindungszeichenfolge des IoT-Hubs.
location	string	ARM-Region des IoT-Hubs.
name	string	Hostname des IoT-Hubs.

IpFilterActionType

Enumeration

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

Wert	Beschreibung
Accept
Reject

IpFilterRule

Objekt

Die IP-Filterregeln für einen Bereitstellungsdienst.

Name	Typ	Beschreibung
action	IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
filterName	string	Der Name der IP-Filterregel.
ipMask	string	Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.
target	IpFilterTargetType	Ziel für Anforderungen, die von dieser Regel erfasst werden.

IpFilterTargetType

Enumeration

Ziel für Anforderungen, die von dieser Regel erfasst werden.

Wert	Beschreibung
all
serviceApi
deviceApi

PrivateEndpoint

Objekt

Die private Endpunkteigenschaft einer privaten Endpunktverbindung

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.

PrivateEndpointConnection

Objekt

Die private Endpunktverbindung eines Bereitstellungsdiensts

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Der Ressourcenname.
properties	PrivateEndpointConnectionProperties	Die Eigenschaften einer privaten Endpunktverbindung
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Ressourcentyp.

PrivateEndpointConnectionProperties

Objekt

Die Eigenschaften einer privaten Endpunktverbindung

Name	Typ	Beschreibung
privateEndpoint	PrivateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionState

Objekt

Der aktuelle Status einer privaten Endpunktverbindung

Name	Typ	Beschreibung
actionsRequired	string	Aktionen, die für eine private Endpunktverbindung erforderlich sind
description	string	Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung
status	PrivateLinkServiceConnectionStatus	Der Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Enumeration

Der Status einer privaten Endpunktverbindung

Wert	Beschreibung
Pending
Approved
Rejected
Disconnected

ProvisioningServiceDescription

Objekt

Die Beschreibung des Bereitstellungsdiensts.

Name	Typ	Beschreibung
etag	string	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.
id	string	Der Ressourcenbezeichner.
location	string	Der Ressourcenspeicherort.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Der Ressourcenname.
properties	IotDpsPropertiesDescription	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst
resourcegroup	string	Die Ressourcengruppe der Ressource.
sku	IotDpsSkuInfo	Sku-Informationen für einen Bereitstellungsdienst.
subscriptionid	string	Die Abonnement-ID der Ressource.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

PublicNetworkAccess

Enumeration

Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.

Wert	Beschreibung
Enabled
Disabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Objekt

Beschreibung des freigegebenen Zugriffsschlüssels.

Name	Typ	Beschreibung
keyName	string	Der Name des Schlüssels.
primaryKey	string	Primärer SAS-Schlüsselwert.
rights	AccessRightsDescription	Rechte, die dieser Schlüssel hat.
secondaryKey	string	Sekundärer SAS-Schlüsselwert.

state

Enumeration

Aktueller Status des Bereitstellungsdiensts.

Wert	Beschreibung
Activating
Active
Deleting
Deleted
ActivationFailed
DeletionFailed
Transitioning
Suspending
Suspended
Resuming
FailingOver
FailoverFailed

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Iot Dps Resource - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

DPSCreate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData