Iot Dps Resource - Create Or Update

Reference

Služba:: IoT Hub Device Provisioning Service

Verze rozhraní API:: 2022-12-12

Vytvořte nebo aktualizujte metadata služby zřizování. Obvyklým způsobem úpravy vlastnosti je načtení metadat služby zřizování a metadat zabezpečení a jejich následné kombinování s upravenými hodnotami v novém těle, aby se aktualizovala služba zřizování.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
provisioningServiceName	path	True	string	Název služby zřizování pro vytvoření nebo aktualizaci
resourceGroupName	path	True	string	Identifikátor skupiny prostředků.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění prostředku.
properties	True	IotDpsPropertiesDescription	Vlastnosti specifické pro službu zřizování
sku	True	IotDpsSkuInfo	Informace o skladové pořizovací službě
etag		string	Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag.
resourcegroup		string	Skupina prostředků prostředku.
subscriptionid		string	ID předplatného prostředku.
tags		object	Značky prostředků.

Odpovědi

Name	Typ	Description
200 OK	ProvisioningServiceDescription	Tělo obsahuje všechny vlastnosti nesouvisecí se zabezpečením služby zřizování. Vlastnosti související se zabezpečením jsou nastaveny na hodnotu null.
201 Created	ProvisioningServiceDescription	Jedná se o dlouhotrvající operaci. Operace vrátí hodnotu 201, pokud je ověření dokončeno. Odpověď obsahuje hlavičku Azure-AsyncOperation, která obsahuje adresu URL stavu. Očekává se, že klienti se budou dotazovat na adresu URL stavu operace. V případě úspěchu operace vrátí stavový kód HTTP 201 (OK).
Other Status Codes	ErrorDetails	Výchozí chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

DPSCreate

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Stavový kód:: 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
  }
}

Definice

Name	Description
AccessRightsDescription	Práva, která tento klíč má.
AllocationPolicy	Zásady přidělování, které má tato služba zřizování používat.
createdByType	Typ identity, která prostředek vytvořila.
ErrorDetails	Podrobnosti o chybě
IotDpsPropertiesDescription	vlastnosti specifické pro službu zřizování, včetně klíčů, propojených iot Hubů, aktuálního stavu a systémem generovaných vlastností, jako je název hostitele a idScope
IotDpsSku	Název skladové položky.
IotDpsSkuInfo	Seznam možných skladových položek služby zřizování
IotHubDefinitionDescription	Popis centra IoT.
IpFilterActionType	Požadovaná akce pro požadavky zachycené tímto pravidlem.
IpFilterRule	Pravidla filtru IP adres pro službu zřizování
IpFilterTargetType	Cíl pro požadavky zachycené tímto pravidlem.
PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
PrivateEndpointConnection	Připojení privátního koncového bodu služby zřizování
PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu
ProvisioningServiceDescription	Popis služby zřizování
PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Popis sdíleného přístupového klíče
state	Aktuální stav služby zřizování
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AccessRightsDescription

Výčet

Práva, která tento klíč má.

Hodnota	Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Výčet

Zásady přidělování, které má tato služba zřizování používat.

Hodnota	Description
GeoLatency
Hashed
Static

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	integer (int32)	Kód chyby.
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP.
message	string	Chybová zpráva.

IotDpsPropertiesDescription

Objekt

vlastnosti specifické pro službu zřizování, včetně klíčů, propojených iot Hubů, aktuálního stavu a systémem generovaných vlastností, jako je název hostitele a idScope

Name	Typ	Description
allocationPolicy	AllocationPolicy	Zásady přidělování, které má tato služba zřizování používat.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Seznam autorizačních klíčů pro službu zřizování
deviceProvisioningHostName	string	Koncový bod zařízení pro tuto službu zřizování
enableDataResidency	boolean	Volitelný. Označuje, jestli má instance DPS povolenou rezidenci dat, odebrání zotavení po havárii mezi geografickou dvojicí.
idScope	string	Jedinečný identifikátor této služby zřizování
iotHubs	IotHubDefinitionDescription[]	Seznam center IoT přidružených k této službě zřizování
ipFilterRules	IpFilterRule[]	Pravidla filtru IP adres.
portalOperationsHostName	string	Koncový bod portálu pro povolení CORS pro tuto službu zřizování
privateEndpointConnections	PrivateEndpointConnection[]	Připojení privátního koncového bodu vytvořená na tomto IotHubu
provisioningState	string	Stav zřizování ARM služby zřizování.
publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
serviceOperationsHostName	string	Koncový bod služby pro zřizování služby.
state	state	Aktuální stav služby zřizování

IotDpsSku

Výčet

Název skladové položky.

Hodnota	Description
S1

IotDpsSkuInfo

Objekt

Seznam možných skladových položek služby zřizování

Name	Typ	Description
capacity	integer (int64)	Počet jednotek, které se mají zřídit
name	IotDpsSku	Název skladové položky.
tier	string	Název cenové úrovně služby zřizování

IotHubDefinitionDescription

Objekt

Popis centra IoT.

Name	Typ	Description
allocationWeight	integer (int32)	hmotnost, která se použije pro danou iot h.
applyAllocationPolicy	boolean	příznak pro použití allocationPolicy nebo ne pro dané centrum IoT.
connectionString	string	Připojovací řetězec centra IoT.
location	string	Oblast ARM centra IoT
name	string	Název hostitele centra IoT.

IpFilterActionType

Výčet

Požadovaná akce pro požadavky zachycené tímto pravidlem.

Hodnota	Description
Accept
Reject

IpFilterRule

Objekt

Pravidla filtru IP adres pro službu zřizování

Name	Typ	Description
action	IpFilterActionType	Požadovaná akce pro požadavky zachycené tímto pravidlem.
filterName	string	Název pravidla filtru IP adres.
ipMask	string	Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pravidla.
target	IpFilterTargetType	Cíl pro požadavky zachycené tímto pravidlem.

IpFilterTargetType

Výčet

Cíl pro požadavky zachycené tímto pravidlem.

Hodnota	Description
all
deviceApi
serviceApi

PrivateEndpoint

Objekt

Vlastnost privátního koncového bodu připojení privátního koncového bodu

Name	Typ	Description
id	string	Identifikátor prostředku.

PrivateEndpointConnection

Objekt

Připojení privátního koncového bodu služby zřizování

Name	Typ	Description
id	string	Identifikátor prostředku.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Název prostředku.
properties	PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku.

PrivateEndpointConnectionProperties

Objekt

Vlastnosti připojení privátního koncového bodu

Name	Typ	Description
privateEndpoint	PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu

PrivateLinkServiceConnectionState

Objekt

Aktuální stav připojení privátního koncového bodu

Name	Typ	Description
actionsRequired	string	Akce vyžadované pro připojení privátního koncového bodu
description	string	Popis aktuálního stavu připojení privátního koncového bodu
status	PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu

PrivateLinkServiceConnectionStatus

Výčet

Stav připojení privátního koncového bodu

Hodnota	Description
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Objekt

Popis služby zřizování

Name	Typ	Description
etag	string	Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag.
id	string	Identifikátor prostředku.
location	string	Umístění prostředku.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Název prostředku.
properties	IotDpsPropertiesDescription	Vlastnosti specifické pro službu zřizování
resourcegroup	string	Skupina prostředků prostředku.
sku	IotDpsSkuInfo	Informace o skladové pořizovací službě
subscriptionid	string	ID předplatného prostředku.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
tags	object	Značky prostředků.
type	string	Typ prostředku.

PublicNetworkAccess

Výčet

Jestli jsou povolené požadavky z veřejné sítě

Hodnota	Description
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Objekt

Popis sdíleného přístupového klíče

Name	Typ	Description
keyName	string	Název klíče.
primaryKey	string	Hodnota primárního klíče SAS
rights	AccessRightsDescription	Práva, která tento klíč má.
secondaryKey	string	Hodnota sekundárního klíče SAS

state

Výčet

Aktuální stav služby zřizování

Hodnota	Description
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Iot Dps Resource - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

DPSCreate

Ukázkový požadavek

Ukázková odpověď

Definice

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

Další materiály