Freigeben über


Iot Dps Resource - Create Or Update

Create oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten des Bereitstellungsdiensts und die Sicherheitsmetadaten abzurufen und diese 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 zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.

resourceGroupName
path True

string

Ressourcengruppenbezeichner.

subscriptionId
path True

string

Die Abonnement-ID.

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 Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header 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 sind auf NULL festgelegt.

201 Created

ProvisioningServiceDescription

Dieser Vorgang dauert lange. 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. Von Clients wird erwartet, dass sie die status-URL für die status des Vorgangs abfragen. Bei erfolgreicher Ausführung gibt der Vorgang HTTP-status Code von 201 (OK) zurück.

Other Status Codes

ErrorDetails

Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

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

{
  "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
  }
}
{
  "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, über die dieser Schlüssel verfügt.

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 Zustand und systemgenerierte 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 Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt

PrivateEndpointConnection

Die private Endpunktverbindung eines Bereitstellungsdiensts

PrivateEndpointConnectionProperties

Die Eigenschaften einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionState

Der aktuelle Status einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionStatus

Die status einer Verbindung mit einem privaten Endpunkt

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des gemeinsam genutzten Zugriffsschlüssels.

state

Aktueller Status des Bereitstellungsdiensts.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AccessRightsDescription

Rechte, über die dieser Schlüssel verfügt.

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

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

integer

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

IotDpsPropertiesDescription

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot Hubs, aktueller Zustand und systemgenerierte 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

Optional. Gibt an, ob für die DPS-instance Data Residency aktiviert ist, wobei die übergreifende geopaarübergreifende 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

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

serviceOperationsHostName

string

Dienstendpunkt für den Bereitstellungsdienst.

state

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

IotDpsSku

SKU-Name.

tier

string

Tarifname des Bereitstellungsdiensts.

IotHubDefinitionDescription

Beschreibung des IoT-Hubs.

Name Typ Beschreibung
allocationWeight

integer

Gewichtung, die für einen bestimmten iot h-Wert angewendet werden soll.

applyAllocationPolicy

boolean

flag for applying allocationPolicy or not for a given iot hub.

connectionString

string

Verbindungszeichenfolge des IoT-Hubs.

location

string

ARM-Region des IoT-Hubs.

name

string

Hostname des IoT-Hubs.

IpFilterActionType

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

Name Typ Beschreibung
Accept

string

Reject

string

IpFilterRule

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

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

Name Typ Beschreibung
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

PrivateEndpointConnection

Die private Endpunktverbindung eines Bereitstellungsdiensts

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

name

string

Der Name der Ressource.

properties

PrivateEndpointConnectionProperties

Die Eigenschaften einer Verbindung mit einem privaten Endpunkt

systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

type

string

Der Ressourcentyp.

PrivateEndpointConnectionProperties

Die Eigenschaften einer Verbindung mit einem privaten Endpunkt

Name Typ Beschreibung
privateEndpoint

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Der aktuelle Status einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionState

Der aktuelle Status einer Verbindung mit einem privaten Endpunkt

Name Typ Beschreibung
actionsRequired

string

Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen

description

string

Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt

status

PrivateLinkServiceConnectionStatus

Die status einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionStatus

Die status einer Verbindung mit einem privaten Endpunkt

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

Name Typ Beschreibung
etag

string

Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden.

id

string

Der Ressourcenbezeichner.

location

string

Der Ressourcenspeicherort.

name

string

Der Name der Ressource.

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, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

tags

object

Die Ressourcentags.

type

string

Der Ressourcentyp.

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

Name Typ Beschreibung
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des gemeinsam genutzten Zugriffsschlüssels.

Name Typ Beschreibung
keyName

string

Name des Schlüssels.

primaryKey

string

Primärer SAS-Schlüsselwert.

rights

AccessRightsDescription

Rechte, über die dieser Schlüssel verfügt.

secondaryKey

string

Wert des sekundären SAS-Schlüssels.

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

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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.