Iot Dps Resource - Create Or Update

Referens

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 en ny brödtext för att uppdatera etableringstjänsten.

HTTP

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	Namnet på etableringstjänsten 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 krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.
resourcegroup		string	Resursgruppen för resursen.
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 Flow.

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

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

JSON

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

JSON

{
  "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 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 offentligt nätverk tillåts
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beskrivning av den delade åtkomstnyckeln.
state	Etableringstjänstens aktuella tillstånd.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AccessRightsDescription

Rättigheter som nyckeln har.

Name	Typ	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

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

Name	Typ	Description
GeoLatency	string
Hashed	string
Static	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Felinformation.

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

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

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 aktiverad, vilket tar bort haveriberedskapen för flera 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 offentligt nätverk tillåts
serviceOperationsHostName	string	Tjänstslutpunkt för etableringstjänst.
state	state	Etableringstjänstens aktuella tillstånd.

IotDpsSku

Sku-namn.

Name	Typ	Description
S1	string

IotDpsSkuInfo

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

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

IotHubDefinitionDescription

Beskrivning av IoT-hubben.

Name	Typ	Description
allocationWeight	integer	vikt att ansöka om en viss 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 i IoT-hubben.
name	string	Värdnamnet för IoT-hubben.

IpFilterActionType

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

Name	Typ	Description
Accept	string
Reject	string

IpFilterRule

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-notation för regeln.
target	IpFilterTargetType	Mål för begäranden som samlas in av den här regeln.

IpFilterTargetType

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

Name	Typ	Description
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Egenskapen privat slutpunkt för en privat slutpunktsanslutning

Name	Typ	Description
id	string	Resursidentifieraren.

PrivateEndpointConnection

Den privata slutpunktsanslutningen för en etableringstjänst

Name	Typ	Description
id	string	Resursidentifieraren.
name	string	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

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

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

Status för en privat slutpunktsanslutning

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Beskrivningen av etableringstjänsten.

Name	Typ	Description
etag	string	Fältet Etag krävs inte . 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	Resursnamnet.
properties	IotDpsPropertiesDescription	Tjänstspecifika egenskaper för en etableringstjänst
resourcegroup	string	Resursgruppen för resursen.
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

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

Name	Typ	Description
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beskrivning av den delade åtkomstnyckeln.

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

state

Etableringstjänstens aktuella tillstånd.

Name	Typ	Description
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

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

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	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