Iot Dps Resource - Create Or Update

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Create atau perbarui metadata layanan provisi. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata layanan provisi dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui layanan provisi.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
provisioningServiceName	path	True	string	Nama layanan provisi untuk dibuat atau diperbarui.
resourceGroupName	path	True	string	Pengidentifikasi grup sumber daya.
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi sumber daya.
properties	True	IotDpsPropertiesDescription	Properti khusus layanan untuk layanan provisi
sku	True	IotDpsSkuInfo	Info Sku untuk Layanan provisi.
etag		string	Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header sesuai konvensi ETag normal.
resourcegroup		string	Grup sumber daya sumber daya.
subscriptionid		string	Id langganan sumber daya.
tags		object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	ProvisioningServiceDescription	Isi berisi semua properti non-keamanan dari layanan provisi. Properti terkait keamanan diatur ke null.
201 Created	ProvisioningServiceDescription	Ini adalah operasi jangka panjang. Operasi mengembalikan 201 jika validasi selesai. Respons menyertakan header Azure-AsyncOperation yang berisi URL status. Klien diharapkan untuk melakukan polling URL status untuk status operasi. Jika berhasil, operasi mengembalikan kode status HTTP 201 (OK).
Other Status Codes	ErrorDetails	Respons kesalahan default.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
AccessRightsDescription	Hak yang dimiliki kunci ini.
AllocationPolicy	Kebijakan alokasi yang akan digunakan oleh layanan provisi ini.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorDetails	Detail kesalahan.
IotDpsPropertiesDescription	properti khusus layanan dari layanan provisi, termasuk kunci, hub iot tertaut, status saat ini, dan properti yang dihasilkan sistem seperti nama host dan idScope
IotDpsSku	Nama Sku.
IotDpsSkuInfo	Daftar kemungkinan SKU layanan provisi.
IotHubDefinitionDescription	Deskripsi hub IoT.
IpFilterActionType	Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.
IpFilterRule	Aturan filter IP untuk Layanan provisi.
IpFilterTargetType	Target untuk permintaan yang diambil oleh aturan ini.
PrivateEndpoint	Properti titik akhir privat dari koneksi titik akhir privat
PrivateEndpointConnection	Koneksi titik akhir privat dari layanan provisi
PrivateEndpointConnectionProperties	Properti koneksi titik akhir privat
PrivateLinkServiceConnectionState	Status koneksi titik akhir privat saat ini
PrivateLinkServiceConnectionStatus	Status koneksi titik akhir privat
ProvisioningServiceDescription	Deskripsi layanan provisi.
PublicNetworkAccess	Apakah permintaan dari Jaringan Publik diizinkan
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Deskripsi kunci akses bersama.
state	Status layanan provisi saat ini.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AccessRightsDescription

Hak yang dimiliki kunci ini.

Nama	Jenis	Deskripsi
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

Kebijakan alokasi yang akan digunakan oleh layanan provisi ini.

Nama	Jenis	Deskripsi
GeoLatency	string
Hashed	string
Static	string

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	integer	Kode kesalahan.
details	string	Detail kesalahan.
httpStatusCode	string	Kode status HTTP.
message	string	Pesan kesalahan.

IotDpsPropertiesDescription

properti khusus layanan dari layanan provisi, termasuk kunci, hub iot tertaut, status saat ini, dan properti yang dihasilkan sistem seperti nama host dan idScope

Nama	Jenis	Deskripsi
allocationPolicy	AllocationPolicy	Kebijakan alokasi yang akan digunakan oleh layanan provisi ini.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Daftar kunci otorisasi untuk layanan provisi.
deviceProvisioningHostName	string	Titik akhir perangkat untuk layanan provisi ini.
enableDataResidency	boolean	Pilihan. Menunjukkan apakah instans DPS telah Data Residency diaktifkan, menghapus pemulihan bencana pasangan geografis silang.
idScope	string	Pengidentifikasi unik dari layanan provisi ini.
iotHubs	IotHubDefinitionDescription[]	Daftar hub IoT yang terkait dengan layanan provisi ini.
ipFilterRules	IpFilterRule[]	Aturan filter IP.
portalOperationsHostName	string	Titik akhir portal untuk mengaktifkan CORS untuk layanan provisi ini.
privateEndpointConnections	PrivateEndpointConnection[]	Koneksi titik akhir privat yang dibuat pada IotHub ini
provisioningState	string	Status penyediaan ARM dari layanan provisi.
publicNetworkAccess	PublicNetworkAccess	Apakah permintaan dari Jaringan Publik diizinkan
serviceOperationsHostName	string	Titik akhir layanan untuk layanan provisi.
state	state	Status layanan provisi saat ini.

IotDpsSku

Nama Sku.

Nama	Jenis	Deskripsi
S1	string

IotDpsSkuInfo

Daftar kemungkinan SKU layanan provisi.

Nama	Jenis	Deskripsi
capacity	integer	Jumlah unit yang akan disediakan
name	IotDpsSku	Nama Sku.
tier	string	Nama tingkat harga layanan provisi.

IotHubDefinitionDescription

Deskripsi hub IoT.

Nama	Jenis	Deskripsi
allocationWeight	integer	berat untuk melamar iot h tertentu.
applyAllocationPolicy	boolean	bendera untuk menerapkan allocationPolicy atau tidak untuk hub iot tertentu.
connectionString	string	String koneksi hub IoT.
location	string	Wilayah ARM IoT hub.
name	string	Nama host hub IoT.

IpFilterActionType

Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.

Nama	Jenis	Deskripsi
Accept	string
Reject	string

IpFilterRule

Aturan filter IP untuk Layanan provisi.

Nama	Jenis	Deskripsi
action	IpFilterActionType	Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.
filterName	string	Nama aturan filter IP.
ipMask	string	String yang berisi rentang alamat IP dalam notasi CIDR untuk aturan.
target	IpFilterTargetType	Target untuk permintaan yang diambil oleh aturan ini.

IpFilterTargetType

Target untuk permintaan yang diambil oleh aturan ini.

Nama	Jenis	Deskripsi
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Properti titik akhir privat dari koneksi titik akhir privat

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya.

PrivateEndpointConnection

Koneksi titik akhir privat dari layanan provisi

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya.
name	string	Nama sumber daya.
properties	PrivateEndpointConnectionProperties	Properti koneksi titik akhir privat
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
type	string	Jenis sumber daya.

PrivateEndpointConnectionProperties

Properti koneksi titik akhir privat

Nama	Jenis	Deskripsi
privateEndpoint	PrivateEndpoint	Properti titik akhir privat dari koneksi titik akhir privat
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status koneksi titik akhir privat saat ini

PrivateLinkServiceConnectionState

Status koneksi titik akhir privat saat ini

Nama	Jenis	Deskripsi
actionsRequired	string	Tindakan yang diperlukan untuk koneksi titik akhir privat
description	string	Deskripsi untuk status koneksi titik akhir privat saat ini
status	PrivateLinkServiceConnectionStatus	Status koneksi titik akhir privat

PrivateLinkServiceConnectionStatus

Status koneksi titik akhir privat

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Deskripsi layanan provisi.

Nama	Jenis	Deskripsi
etag	string	Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header sesuai konvensi ETag normal.
id	string	Pengidentifikasi sumber daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties	IotDpsPropertiesDescription	Properti khusus layanan untuk layanan provisi
resourcegroup	string	Grup sumber daya sumber daya.
sku	IotDpsSkuInfo	Info Sku untuk Layanan provisi.
subscriptionid	string	Id langganan sumber daya.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya.

PublicNetworkAccess

Apakah permintaan dari Jaringan Publik diizinkan

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Deskripsi kunci akses bersama.

Nama	Jenis	Deskripsi
keyName	string	Nama kunci.
primaryKey	string	Nilai kunci SAS utama.
rights	AccessRightsDescription	Hak yang dimiliki kunci ini.
secondaryKey	string	Nilai kunci SAS sekunder.

state

Status layanan provisi saat ini.

Nama	Jenis	Deskripsi
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 yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.