Iot Dps Resource - Create Or Update

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Create o aggiornare i metadati del servizio di provisioning. Il modello consueto per modificare una proprietà consiste nel recuperare i metadati del servizio di provisioning e i metadati di sicurezza e quindi combinarli con i valori modificati in un nuovo corpo per aggiornare il servizio di provisioning.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
provisioningServiceName	path	True	string	Nome del servizio di provisioning da creare o aggiornare.
resourceGroupName	path	True	string	Identificatore del gruppo di risorse.
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso della risorsa.
properties	True	IotDpsPropertiesDescription	Proprietà specifiche del servizio per un servizio di provisioning
sku	True	IotDpsSkuInfo	Informazioni sullo SKU per un servizio di provisioning.
etag		string	Il campo Etag non è obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag.
resourcegroup		string	Gruppo di risorse della risorsa.
subscriptionid		string	ID sottoscrizione della risorsa.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	ProvisioningServiceDescription	Il corpo contiene tutte le proprietà non di sicurezza del servizio di provisioning. Le proprietà correlate alla sicurezza sono impostate su Null.
201 Created	ProvisioningServiceDescription	L'operazione può richiedere molto tempo. Se la convalida è stata completata, l'operazione restituisce un valore 201. La risposta include un'intestazione Azure-AsyncOperation che contiene un URL di stato. Si prevede che i client eseguano il polling dell'URL di stato per lo stato dell'operazione. In caso di esito positivo, l'operazione restituisce il codice di stato HTTP 201 (OK).
Other Status Codes	ErrorDetails	Risposta di errore predefinita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DPSCreate

Sample Request

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

Sample Response

Status code:

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

Status code:

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

Definizioni

Nome	Descrizione
AccessRightsDescription	Diritti di cui dispone questa chiave.
AllocationPolicy	Criteri di allocazione da usare da questo servizio di provisioning.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorDetails	Dettagli errore.
IotDpsPropertiesDescription	le proprietà specifiche del servizio di un servizio di provisioning, incluse le chiavi, gli hub iot collegati, lo stato corrente e le proprietà generate dal sistema, ad esempio nome host e idScope
IotDpsSku	Nome sku.
IotDpsSkuInfo	Elenco dei possibili SKU del servizio di provisioning.
IotHubDefinitionDescription	Descrizione dell'hub IoT.
IpFilterActionType	Azione desiderata per le richieste acquisite da questa regola.
IpFilterRule	Regole di filtro IP per un servizio di provisioning.
IpFilterTargetType	Destinazione per le richieste acquisite da questa regola.
PrivateEndpoint	Proprietà dell'endpoint privato di una connessione all'endpoint privato
PrivateEndpointConnection	Connessione dell'endpoint privato di un servizio di provisioning
PrivateEndpointConnectionProperties	Proprietà di una connessione endpoint privato
PrivateLinkServiceConnectionState	Stato corrente di una connessione endpoint privato
PrivateLinkServiceConnectionStatus	Stato di una connessione endpoint privato
ProvisioningServiceDescription	Descrizione del servizio di provisioning.
PublicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Descrizione della chiave di accesso condiviso.
state	Stato corrente del servizio di provisioning.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

AccessRightsDescription

Diritti di cui dispone questa chiave.

Nome	Tipo	Descrizione
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

Criteri di allocazione da usare da questo servizio di provisioning.

Nome	Tipo	Descrizione
GeoLatency	string
Hashed	string
Static	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Dettagli errore.

Nome	Tipo	Descrizione
code	integer	Codice di errore.
details	string	Dettagli dell'errore.
httpStatusCode	string	Codice di stato HTTP.
message	string	Messaggio di errore.

IotDpsPropertiesDescription

le proprietà specifiche del servizio di un servizio di provisioning, incluse le chiavi, gli hub iot collegati, lo stato corrente e le proprietà generate dal sistema, ad esempio nome host e idScope

Nome	Tipo	Descrizione
allocationPolicy	AllocationPolicy	Criteri di allocazione da usare da questo servizio di provisioning.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Elenco delle chiavi di autorizzazione per un servizio di provisioning.
deviceProvisioningHostName	string	Endpoint del dispositivo per questo servizio di provisioning.
enableDataResidency	boolean	facoltativo. Indica se l'istanza del servizio Device Provisioning ha Data Residency abilitato, rimuovendo il ripristino di emergenza tra coppie geografiche.
idScope	string	Identificatore univoco di questo servizio di provisioning.
iotHubs	IotHubDefinitionDescription[]	Elenco di hub IoT associati a questo servizio di provisioning.
ipFilterRules	IpFilterRule[]	Regole di filtro IP.
portalOperationsHostName	string	Endpoint del portale per abilitare CORS per questo servizio di provisioning.
privateEndpointConnections	PrivateEndpointConnection[]	Connessioni endpoint privato create in questo IotHub
provisioningState	string	Stato del provisioning arm del servizio di provisioning.
publicNetworkAccess	PublicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite
serviceOperationsHostName	string	Endpoint servizio per il servizio di provisioning.
state	state	Stato corrente del servizio di provisioning.

IotDpsSku

Nome sku.

Nome	Tipo	Descrizione
S1	string

IotDpsSkuInfo

Elenco dei possibili SKU del servizio di provisioning.

Nome	Tipo	Descrizione
capacity	integer	Numero di unità di cui effettuare il provisioning
name	IotDpsSku	Nome sku.
tier	string	Nome del piano tariffario del servizio di provisioning.

IotHubDefinitionDescription

Descrizione dell'hub IoT.

Nome	Tipo	Descrizione
allocationWeight	integer	peso da applicare per un determinato iot h.
applyAllocationPolicy	boolean	flag per l'applicazione di allocationPolicy o meno per un determinato hub iot.
connectionString	string	Stringa di connessione dell'hub IoT.
location	string	Area arm dell'hub IoT.
name	string	Nome host dell'hub IoT.

IpFilterActionType

Azione desiderata per le richieste acquisite da questa regola.

Nome	Tipo	Descrizione
Accept	string
Reject	string

IpFilterRule

Regole di filtro IP per un servizio di provisioning.

Nome	Tipo	Descrizione
action	IpFilterActionType	Azione desiderata per le richieste acquisite da questa regola.
filterName	string	Nome della regola di filtro IP.
ipMask	string	Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola.
target	IpFilterTargetType	Destinazione per le richieste acquisite da questa regola.

IpFilterTargetType

Destinazione per le richieste acquisite da questa regola.

Nome	Tipo	Descrizione
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Proprietà dell'endpoint privato di una connessione all'endpoint privato

Nome	Tipo	Descrizione
id	string	Identificatore della risorsa.

PrivateEndpointConnection

Connessione dell'endpoint privato di un servizio di provisioning

Nome	Tipo	Descrizione
id	string	Identificatore della risorsa.
name	string	Nome della risorsa.
properties	PrivateEndpointConnectionProperties	Proprietà di una connessione endpoint privato
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo di risorsa.

PrivateEndpointConnectionProperties

Proprietà di una connessione endpoint privato

Nome	Tipo	Descrizione
privateEndpoint	PrivateEndpoint	Proprietà dell'endpoint privato di una connessione all'endpoint privato
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato corrente di una connessione endpoint privato

PrivateLinkServiceConnectionState

Stato corrente di una connessione endpoint privato

Nome	Tipo	Descrizione
actionsRequired	string	Azioni necessarie per una connessione endpoint privato
description	string	Descrizione dello stato corrente di una connessione all'endpoint privato
status	PrivateLinkServiceConnectionStatus	Stato di una connessione endpoint privato

PrivateLinkServiceConnectionStatus

Stato di una connessione endpoint privato

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Descrizione del servizio di provisioning.

Nome	Tipo	Descrizione
etag	string	Il campo Etag non è obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag.
id	string	Identificatore della risorsa.
location	string	Percorso della risorsa.
name	string	Nome della risorsa.
properties	IotDpsPropertiesDescription	Proprietà specifiche del servizio per un servizio di provisioning
resourcegroup	string	Gruppo di risorse della risorsa.
sku	IotDpsSkuInfo	Informazioni sullo SKU per un servizio di provisioning.
subscriptionid	string	ID sottoscrizione della risorsa.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

PublicNetworkAccess

Indica se le richieste dalla rete pubblica sono consentite

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrizione della chiave di accesso condiviso.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave.
primaryKey	string	Valore della chiave di firma di accesso condiviso primario.
rights	AccessRightsDescription	Diritti di cui dispone questa chiave.
secondaryKey	string	Valore della chiave di firma di accesso condiviso secondario.

state

Stato corrente del servizio di provisioning.

Nome	Tipo	Descrizione
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

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.