Iot Dps Resource - Create Or Update

Odwołanie

Usługa:: IoT Hub Device Provisioning Service

Wersja interfejsu API:: 2022-12-12

Utwórz lub zaktualizuj metadane usługi aprowizacji. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych usługi aprowizacji i metadanych zabezpieczeń, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania usługi aprowizacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
provisioningServiceName	path	True	string	Nazwa usługi aprowizacji w celu utworzenia lub zaktualizowania.
resourceGroupName	path	True	string	Identyfikator grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
properties	True	IotDpsPropertiesDescription	Właściwości specyficzne dla usługi aprowizacji
sku	True	IotDpsSkuInfo	Informacje o jednostce SKU dla usługi aprowizacji.
etag		string	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.
resourcegroup		string	Grupa zasobów zasobu.
subscriptionid		string	Identyfikator subskrypcji zasobu.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ProvisioningServiceDescription	Treść zawiera wszystkie właściwości niezwiązane z zabezpieczeniami usługi aprowizacji. Właściwości związane z zabezpieczeniami są ustawione na wartość null.
201 Created	ProvisioningServiceDescription	Jest to długotrwała operacja. Operacja zwraca błąd 201, jeśli weryfikacja została ukończona. Odpowiedź zawiera nagłówek Azure-AsyncOperation zawierający adres URL stanu. Oczekuje się, że klienci będą sondować adres URL stanu dla stanu operacji. W przypadku powodzenia operacja zwraca kod stanu HTTP 201 (OK).
Other Status Codes	ErrorDetails	Domyślna odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

DPSCreate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
AccessRightsDescription	Prawa, które ma ten klucz.
AllocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDetails	Szczegóły błędu.
IotDpsPropertiesDescription	właściwości specyficzne dla usługi aprowizacji, w tym klucze, połączone centra iot, bieżący stan i system wygenerowane właściwości, takie jak nazwa hosta i idScope
IotDpsSku	Nazwa jednostki SKU.
IotDpsSkuInfo	Lista możliwych jednostek SKU usługi aprowizacji.
IotHubDefinitionDescription	Opis centrum IoT.
IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
IpFilterRule	Reguły filtrowania adresów IP dla usługi aprowizacji.
IpFilterTargetType	Element docelowy dla żądań przechwyconych przez tę regułę.
PrivateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
PrivateEndpointConnection	Połączenie prywatnego punktu końcowego usługi aprowizacji
PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego
ProvisioningServiceDescription	Opis usługi aprowizacji.
PublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Opis klucza dostępu współdzielonego.
state	Bieżący stan usługi aprowizacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AccessRightsDescription

Wyliczanie

Prawa, które ma ten klucz.

Wartość	Opis
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Wyliczanie

Zasady alokacji, które mają być używane przez tę usługę aprowizacji.

Wartość	Opis
GeoLatency
Hashed
Static

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

ErrorDetails

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
code	integer (int32)	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

IotDpsPropertiesDescription

Objekt

właściwości specyficzne dla usługi aprowizacji, w tym klucze, połączone centra iot, bieżący stan i system wygenerowane właściwości, takie jak nazwa hosta i idScope

Nazwa	Typ	Opis
allocationPolicy	AllocationPolicy	Zasady alokacji, które mają być używane przez tę usługę aprowizacji.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Lista kluczy autoryzacji dla usługi aprowizacji.
deviceProvisioningHostName	string	Punkt końcowy urządzenia dla tej usługi aprowizacji.
enableDataResidency	boolean	Opcjonalny. Wskazuje, czy wystąpienie usługi DPS ma włączoną rezydencję danych, usuwając odzyskiwanie po awarii między parami geograficznymi.
idScope	string	Unikatowy identyfikator tej usługi aprowizacji.
iotHubs	IotHubDefinitionDescription[]	Lista centrów IoT skojarzonych z tą usługą aprowizacji.
ipFilterRules	IpFilterRule[]	Reguły filtrowania adresów IP.
portalOperationsHostName	string	Punkt końcowy portalu umożliwiający włączenie mechanizmu CORS dla tej usługi aprowizacji.
privateEndpointConnections	PrivateEndpointConnection[]	Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub
provisioningState	string	Stan aprowizacji usługi ARM dla usługi aprowizacji.
publicNetworkAccess	PublicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
serviceOperationsHostName	string	Punkt końcowy usługi na potrzeby aprowizacji usługi.
state	state	Bieżący stan usługi aprowizacji.

IotDpsSku

Wyliczanie

Nazwa jednostki SKU.

Wartość	Opis
S1

IotDpsSkuInfo

Objekt

Lista możliwych jednostek SKU usługi aprowizacji.

Nazwa	Typ	Opis
capacity	integer (int64)	Liczba jednostek do aprowizacji
name	IotDpsSku	Nazwa jednostki SKU.
tier	string	Nazwa warstwy cenowej usługi aprowizacji.

IotHubDefinitionDescription

Objekt

Opis centrum IoT.

Nazwa	Typ	Opis
allocationWeight	integer (int32)	waga do ubiegania się o daną iot h.
applyAllocationPolicy	boolean	flaga stosowania elementu allocationPolicy lub nie dla danego centrum iot.
connectionString	string	Parametry połączenia centrum IoT Hub.
location	string	Region usługi ARM centrum IoT.
name	string	Nazwa hosta centrum IoT.

IpFilterActionType

Wyliczanie

Żądana akcja żądań przechwyconych przez tę regułę.

Wartość	Opis
Accept
Reject

IpFilterRule

Objekt

Reguły filtrowania adresów IP dla usługi aprowizacji.

Nazwa	Typ	Opis
action	IpFilterActionType	Żądana akcja żądań przechwyconych przez tę regułę.
filterName	string	Nazwa reguły filtru adresów IP.
ipMask	string	Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły.
target	IpFilterTargetType	Element docelowy dla żądań przechwyconych przez tę regułę.

IpFilterTargetType

Wyliczanie

Element docelowy dla żądań przechwyconych przez tę regułę.

Wartość	Opis
all
deviceApi
serviceApi

PrivateEndpoint

Objekt

Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

PrivateEndpointConnection

Objekt

Połączenie prywatnego punktu końcowego usługi aprowizacji

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Nazwa zasobu.
properties	PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu.

PrivateEndpointConnectionProperties

Objekt

Właściwości połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
privateEndpoint	PrivateEndpoint	Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Bieżący stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionState

Objekt

Bieżący stan połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
actionsRequired	string	Akcje wymagane dla połączenia prywatnego punktu końcowego
description	string	Opis bieżącego stanu połączenia prywatnego punktu końcowego
status	PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionStatus

Wyliczanie

Stan połączenia prywatnego punktu końcowego

Wartość	Opis
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Objekt

Opis usługi aprowizacji.

Nazwa	Typ	Opis
etag	string	Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag.
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Nazwa zasobu.
properties	IotDpsPropertiesDescription	Właściwości specyficzne dla usługi aprowizacji
resourcegroup	string	Grupa zasobów zasobu.
sku	IotDpsSkuInfo	Informacje o jednostce SKU dla usługi aprowizacji.
subscriptionid	string	Identyfikator subskrypcji zasobu.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

PublicNetworkAccess

Wyliczanie

Czy żądania z sieci publicznej są dozwolone

Wartość	Opis
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Objekt

Opis klucza dostępu współdzielonego.

Nazwa	Typ	Opis
keyName	string	Nazwa klucza.
primaryKey	string	Podstawowa wartość klucza sygnatury dostępu współdzielonego.
rights	AccessRightsDescription	Prawa, które ma ten klucz.
secondaryKey	string	Pomocnicza wartość klucza sygnatury dostępu współdzielonego.

state

Wyliczanie

Bieżący stan usługi aprowizacji.

Wartość	Opis
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Iot Dps Resource - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

DPSCreate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

Dodatkowe zasoby