Iot Dps Resource - Create Or Update

Tjänst:: IoT Hub Device Provisioning Service

API-version:: 2022-12-12

Skapa eller uppdatera metadata för etableringstjänsten. Det vanliga mönstret för att ändra en egenskap är att hämta etableringstjänstens metadata och säkerhetsmetadata och sedan kombinera dem med de ändrade värdena i ett nytt brödtext för att uppdatera etableringstjänsten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
provisioningServiceName	path	True	string	Namn på etableringstjänst som ska skapas eller uppdateras.
resourceGroupName	path	True	string	Resursgruppsidentifierare.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Resursplatsen.
properties	True	IotDpsPropertiesDescription	Tjänstspecifika egenskaper för en etableringstjänst
sku	True	IotDpsSkuInfo	SKU-information för en etableringstjänst.
etag		string	Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.
resourcegroup		string	Resursgruppen.
subscriptionid		string	Resursens prenumerations-ID.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	ProvisioningServiceDescription	Brödtexten innehåller alla icke-säkerhetsegenskaper för etableringstjänsten. Säkerhetsrelaterade egenskaper är inställda på null.
201 Created	ProvisioningServiceDescription	Det här är en tidskrävande åtgärd. Åtgärden returnerar ett 201 om verifieringen är klar. Svaret innehåller en Azure-AsyncOperation rubrik som innehåller en status-URL. Klienter förväntas avsöka status-URL:en för åtgärdens status. Om åtgärden lyckas returneras HTTP-statuskoden 201 (OK).
Other Status Codes	ErrorDetails	Standardfelsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

DPSCreate

Exempelbegäran

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

Exempelsvar

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

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

Definitioner

Name	Description
AccessRightsDescription	Rättigheter som den här nyckeln har.
AllocationPolicy	Allokeringsprincip som ska användas av den här etableringstjänsten.
createdByType	Den typ av identitet som skapade resursen.
ErrorDetails	Felinformation.
IotDpsPropertiesDescription	tjänstspecifika egenskaper för en etableringstjänst, inklusive nycklar, länkade iot-hubbar, aktuellt tillstånd och systemgenererade egenskaper som värdnamn och idScope
IotDpsSku	Sku-namn.
IotDpsSkuInfo	Lista över möjliga SKU:er för etableringstjänsten.
IotHubDefinitionDescription	Beskrivning av IoT-hubben.
IpFilterActionType	Önskad åtgärd för begäranden som samlas in av den här regeln.
IpFilterRule	IP-filterreglerna för en etableringstjänst.
IpFilterTargetType	Mål för begäranden som samlas in av den här regeln.
PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
PrivateEndpointConnection	Den privata slutpunktsanslutningen för en etableringstjänst
PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning
PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning
ProvisioningServiceDescription	Beskrivningen av etableringstjänsten.
PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beskrivning av nyckeln för delad åtkomst.
state	Etableringstjänstens aktuella tillstånd.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AccessRightsDescription

Uppräkning

Rättigheter som den här nyckeln har.

Värde	Description
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

Uppräkning

Allokeringsprincip som ska användas av den här etableringstjänsten.

Värde	Description
Hashed
GeoLatency
Static

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
code	integer (int32)	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

IotDpsPropertiesDescription

Objekt

tjänstspecifika egenskaper för en etableringstjänst, inklusive nycklar, länkade iot-hubbar, aktuellt tillstånd och systemgenererade egenskaper som värdnamn och idScope

Name	Typ	Description
allocationPolicy	AllocationPolicy	Allokeringsprincip som ska användas av den här etableringstjänsten.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Lista över auktoriseringsnycklar för en etableringstjänst.
deviceProvisioningHostName	string	Enhetsslutpunkt för den här etableringstjänsten.
enableDataResidency	boolean	Valfritt. Anger om DPS-instansen har Data Residency aktiverat, vilket tar bort haveriberedskapen mellan geo-par.
idScope	string	Unik identifierare för den här etableringstjänsten.
iotHubs	IotHubDefinitionDescription[]	Lista över IoT-hubbar som är associerade med den här etableringstjänsten.
ipFilterRules	IpFilterRule[]	IP-filterreglerna.
portalOperationsHostName	string	Portalslutpunkt för att aktivera CORS för den här etableringstjänsten.
privateEndpointConnections	PrivateEndpointConnection[]	Privata slutpunktsanslutningar som skapats på denna IotHub
provisioningState	string	ARM-etableringstillståndet för etableringstjänsten.
publicNetworkAccess	PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
serviceOperationsHostName	string	Tjänstslutpunkt för etableringstjänst.
state	state	Etableringstjänstens aktuella tillstånd.

IotDpsSku

Uppräkning

Sku-namn.

Värde	Description
S1

IotDpsSkuInfo

Objekt

Lista över möjliga SKU:er för etableringstjänsten.

Name	Typ	Description
capacity	integer (int64)	Antalet enheter som ska etableras
name	IotDpsSku	Sku-namn.
tier	string	Namn på prisnivå för etableringstjänsten.

IotHubDefinitionDescription

Objekt

Beskrivning av IoT-hubben.

Name	Typ	Description
allocationWeight	integer (int32)	vikt för att ansöka om en given iot h.
applyAllocationPolicy	boolean	flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb.
connectionString	string	Anslutningssträng för IoT-hubben.
location	string	ARM-regionen för IoT-hubben.
name	string	Värdnamnet för IoT-hubben.

IpFilterActionType

Uppräkning

Önskad åtgärd för begäranden som samlas in av den här regeln.

Värde	Description
Accept
Reject

IpFilterRule

Objekt

IP-filterreglerna för en etableringstjänst.

Name	Typ	Description
action	IpFilterActionType	Önskad åtgärd för begäranden som samlas in av den här regeln.
filterName	string	Namnet på IP-filterregeln.
ipMask	string	En sträng som innehåller IP-adressintervallet i CIDR-notationen för regeln.
target	IpFilterTargetType	Mål för begäranden som samlas in av den här regeln.

IpFilterTargetType

Uppräkning

Mål för begäranden som samlas in av den här regeln.

Värde	Description
all
serviceApi
deviceApi

PrivateEndpoint

Objekt

Egenskapen privat slutpunkt för en privat slutpunktsanslutning

Name	Typ	Description
id	string	Resursidentifieraren.

PrivateEndpointConnection

Objekt

Den privata slutpunktsanslutningen för en etableringstjänst

Name	Typ	Description
id	string	Resursidentifieraren.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Resursnamnet.
properties	PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstypen.

PrivateEndpointConnectionProperties

Objekt

Egenskaperna för en privat slutpunktsanslutning

Name	Typ	Description
privateEndpoint	PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning

PrivateLinkServiceConnectionState

Objekt

Det aktuella tillståndet för en privat slutpunktsanslutning

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs för en privat slutpunktsanslutning
description	string	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning
status	PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning

PrivateLinkServiceConnectionStatus

Uppräkning

Status för en privat slutpunktsanslutning

Värde	Description
Pending
Approved
Rejected
Disconnected

ProvisioningServiceDescription

Objekt

Beskrivningen av etableringstjänsten.

Name	Typ	Description
etag	string	Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.
id	string	Resursidentifieraren.
location	string	Resursplatsen.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Resursnamnet.
properties	IotDpsPropertiesDescription	Tjänstspecifika egenskaper för en etableringstjänst
resourcegroup	string	Resursgruppen.
sku	IotDpsSkuInfo	SKU-information för en etableringstjänst.
subscriptionid	string	Resursens prenumerations-ID.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resurstaggar.
type	string	Resurstypen.

PublicNetworkAccess

Uppräkning

Om begäranden från offentliga nätverk tillåts

Värde	Description
Enabled
Disabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Objekt

Beskrivning av nyckeln för delad åtkomst.

Name	Typ	Description
keyName	string	Namnet på nyckeln.
primaryKey	string	Primärt SAS-nyckelvärde.
rights	AccessRightsDescription	Rättigheter som den här nyckeln har.
secondaryKey	string	Sekundärt SAS-nyckelvärde.

state

Uppräkning

Etableringstjänstens aktuella tillstånd.

Värde	Description
Activating
Active
Deleting
Deleted
ActivationFailed
DeletionFailed
Transitioning
Suspending
Suspended
Resuming
FailingOver
FailoverFailed

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Iot Dps Resource - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

DPSCreate

Exempelbegäran

Exempelsvar

Definitioner

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData