Iot Dps Resource - Update

Riferimento

Servizio:: IoT Hub Device Provisioning Service

Versione API:: 2022-12-12

Aggiornare i tag del servizio di provisioning esistenti. per aggiornare altri campi, usare il metodo CreateOrUpdate

PATCH 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	Tipo	Descrizione
tags	object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	ProvisioningServiceDescription	Il servizio di provisioning è stato aggiornato correttamente

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DPSPatch

Esempio di richiesta

HTTP

PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2022-12-12

{
  "tags": {
    "foo": "bar"
  }
}

Risposta di esempio

Codice di stato:: 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",
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {
    "foo": "bar"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definizioni

Nome	Descrizione
AccessRightsDescription	Diritti che questa chiave ha.
AllocationPolicy	Criteri di allocazione da usare da questo servizio di provisioning.
createdByType	Tipo di identità che ha creato la risorsa.
IotDpsPropertiesDescription	proprietà specifiche del servizio di un servizio di provisioning, incluse chiavi, hub iot collegati, stato corrente e proprietà generate dal sistema, ad esempio nome host e idScope
IotDpsSku	Nome sku.
IotDpsSkuInfo	Elenco degli SKU possibili 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 endpoint privato
PrivateEndpointConnection	Connessione 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.
TagsResource	Un contenitore che contiene solo i tag per una risorsa, consentendo all'utente di aggiornare i tag in un'istanza del servizio di provisioning.

AccessRightsDescription

Enumerazione

Diritti che questa chiave ha.

Valore	Descrizione
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Enumerazione

Criteri di allocazione da usare da questo servizio di provisioning.

Valore	Descrizione
GeoLatency
Hashed
Static

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

IotDpsPropertiesDescription

Object

proprietà specifiche del servizio di un servizio di provisioning, incluse chiavi, hub iot collegati, stato corrente e 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 di DPS è abilitata Data Residency, rimuovendo il ripristino di emergenza tra coppie geografiche.
idScope	string	Identificatore univoco di questo servizio di provisioning.
iotHubs	IotHubDefinitionDescription[]	Elenco degli 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 private create in questo IotHub
provisioningState	string	Stato di provisioning arm del servizio di provisioning.
publicNetworkAccess	PublicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite
serviceOperationsHostName	string	Endpoint di servizio per il servizio di provisioning.
state	state	Stato corrente del servizio di provisioning.

IotDpsSku

Enumerazione

Nome sku.

Valore	Descrizione
S1

IotDpsSkuInfo

Object

Elenco degli SKU possibili del servizio di provisioning.

Nome	Tipo	Descrizione
capacity	integer (int64)	Numero di unità da effettuare per il provisioning
name	IotDpsSku	Nome sku.
tier	string	Nome del piano tariffario del servizio di provisioning.

IotHubDefinitionDescription

Object

Descrizione dell'hub IoT.

Nome	Tipo	Descrizione
allocationWeight	integer (int32)	peso da applicare per un determinato iot h.
applyAllocationPolicy	boolean	flag per l'applicazione di allocazionePolicy 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

Enumerazione

Azione desiderata per le richieste acquisite da questa regola.

Valore	Descrizione
Accept
Reject

IpFilterRule

Object

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

Enumerazione

Destinazione per le richieste acquisite da questa regola.

Valore	Descrizione
all
deviceApi
serviceApi

PrivateEndpoint

Object

Proprietà dell'endpoint privato di una connessione endpoint privato

Nome	Tipo	Descrizione
id	string	Identificatore di risorsa.

PrivateEndpointConnection

Object

Connessione endpoint privato di un servizio di provisioning

Nome	Tipo	Descrizione
id	string	Identificatore di risorsa.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	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

Object

Proprietà di una connessione endpoint privato

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

PrivateLinkServiceConnectionState

Object

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 endpoint privato
status	PrivateLinkServiceConnectionStatus	Stato di una connessione endpoint privato

PrivateLinkServiceConnectionStatus

Enumerazione

Stato di una connessione endpoint privato

Valore	Descrizione
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Object

Descrizione del servizio di provisioning.

Nome	Tipo	Descrizione
etag	string	Il campo Etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve essere fornito anche come intestazione per la normale convenzione ETag.
id	string	Identificatore di risorsa.
location	string	Percorso della risorsa.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	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

Enumerazione

Indica se le richieste dalla rete pubblica sono consentite

Valore	Descrizione
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

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 che questa chiave ha.
secondaryKey	string	Valore della chiave di firma di accesso condiviso secondario.

state

Enumerazione

Stato corrente del servizio di provisioning.

Valore	Descrizione
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Object

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

Nome	Tipo	Descrizione
createdAt	string (date-time)	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 (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

TagsResource

Object

Un contenitore che contiene solo i tag per una risorsa, consentendo all'utente di aggiornare i tag in un'istanza del servizio di provisioning.

Nome	Tipo	Descrizione
tags	object	Tag delle risorse

Condividi tramite

Iot Dps Resource - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

DPSPatch

Esempio di richiesta

Risposta di esempio

Definizioni

AccessRightsDescription

AllocationPolicy

createdByType

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

TagsResource

Risorse aggiuntive