Delen via


Iot Dps Resource - Create Or Update

Creatie of werk de metagegevens van de inrichtingsservice bij. Het gebruikelijke patroon voor het wijzigen van een eigenschap is om de metagegevens en beveiligingsmetagegevens van de inrichtingsservice op te halen en deze vervolgens te 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

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 Vereist Type Description
location True

string

De resourcelocatie.

properties True

IotDpsPropertiesDescription

Servicespecifieke eigenschappen voor een inrichtingsservice

sku True

IotDpsSkuInfo

SKU-informatie 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. Van clients wordt verwacht dat ze de status-URL voor de status van de bewerking peilen. Als dit lukt, retourneert de bewerking de HTTP-statuscode 201 (OK).

Other Status Codes

ErrorDetails

Standaardfoutreactie.

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

DPSCreate

Voorbeeldaanvraag

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

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

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, waaronder 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 inrichtingsservices.

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 door deze regel zijn vastgelegd.

PrivateEndpoint

De privé-eindpunteigenschap 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 het openbare netwerk zijn toegestaan

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschrijving van de gedeelde toegangssleutel.

state

Huidige status van de inrichtingsservice.

systemData

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

AccessRightsDescription

Rechten die deze sleutel heeft.

Waarde Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice.

Waarde Description
GeoLatency
Hashed
Static

createdByType

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
Application
Key
ManagedIdentity
User

ErrorDetails

Foutdetails.

Name Type Description
code

integer (int32)

De foutcode.

details

string

De foutdetails.

httpStatusCode

string

De HTTP-statuscode.

message

string

Het foutbericht.

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.

enableDataResidency

boolean

Optioneel. Hiermee wordt aangegeven of het DPS-exemplaar Data Residency ingeschakeld, waardoor het herstel na noodgeval tussen geo-paren wordt verwijderd.

idScope

string

De 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 het openbare netwerk zijn toegestaan

serviceOperationsHostName

string

Service-eindpunt voor inrichtingsservice.

state

state

Huidige status van de inrichtingsservice.

IotDpsSku

SKU-naam.

Waarde Description
S1

IotDpsSkuInfo

Lijst met mogelijke SKU's voor inrichtingsservices.

Name Type Description
capacity

integer (int64)

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 (int32)

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 van de IoT-hub.

location

string

ARM-regio van de IoT-hub.

name

string

Hostnaam van de IoT-hub.

IpFilterActionType

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

Waarde Description
Accept
Reject

IpFilterRule

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 bevat in CIDR-notatie voor de regel.

target

IpFilterTargetType

Doel voor aanvragen die door deze regel zijn vastgelegd.

IpFilterTargetType

Doel voor aanvragen die door deze regel zijn vastgelegd.

Waarde Description
all
deviceApi
serviceApi

PrivateEndpoint

De privé-eindpunteigenschap van een privé-eindpuntverbinding

Name Type Description
id

string

De resource-id.

PrivateEndpointConnection

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 laatste wijzigen van de resource.

type

string

Het resourcetype.

PrivateEndpointConnectionProperties

De eigenschappen van een privé-eindpuntverbinding

Name Type Description
privateEndpoint

PrivateEndpoint

De privé-eindpunteigenschap van een privé-eindpuntverbinding

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

De huidige status van een privé-eindpuntverbinding

PrivateLinkServiceConnectionState

De huidige status van een privé-eindpuntverbinding

Name Type Description
actionsRequired

string

Vereiste acties 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

De status van een privé-eindpuntverbinding

Waarde Description
Approved
Disconnected
Pending
Rejected

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

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-informatie voor een inrichtingsservice.

subscriptionid

string

De abonnements-id van de resource.

systemData

systemData

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

tags

object

De resourcetags.

type

string

Het resourcetype.

PublicNetworkAccess

Of aanvragen van het openbare netwerk zijn toegestaan

Waarde Description
Disabled
Enabled

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.

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

systemData

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

Name Type Description
createdAt

string (date-time)

Het 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 het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.