Iot Dps Resource - Create Or Update

Referensi

Layanan:: IoT Hub Device Provisioning Service

Versi API:: 2022-12-12

Membuat atau memperbarui 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 membuat atau memperbarui.
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 per 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 mencakup 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.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

DPSCreate

Permintaan sampel

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

Respon sampel

Kode status:: 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
  }
}

Kode status:: 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

Enumeration

Hak yang dimiliki kunci ini.

Nilai	Deskripsi
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Enumeration

Kebijakan alokasi yang akan digunakan oleh layanan provisi ini.

Nilai	Deskripsi
GeoLatency
Hashed
Static

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

ErrorDetails

Objek

Detail kesalahan.

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

IotDpsPropertiesDescription

Objek

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	Fakultatif. Menunjukkan apakah instans DPS mengaktifkan Residensi Data, menghapus pemulihan bencana lintas pasangan geografis.
idScope	string	Pengidentifikasi unik 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 provisi 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

Enumeration

Nama Sku.

Nilai	Deskripsi
S1

IotDpsSkuInfo

Objek

Daftar kemungkinan SKU layanan provisi.

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

IotHubDefinitionDescription

Objek

Deskripsi hub IoT.

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

IpFilterActionType

Enumeration

Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.

Nilai	Deskripsi
Accept
Reject

IpFilterRule

Objek

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 tersebut.
target	IpFilterTargetType	Target untuk permintaan yang diambil oleh aturan ini.

IpFilterTargetType

Enumeration

Target untuk permintaan yang diambil oleh aturan ini.

Nilai	Deskripsi
all
deviceApi
serviceApi

PrivateEndpoint

Objek

Properti titik akhir privat dari koneksi titik akhir privat

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya.

PrivateEndpointConnection

Objek

Koneksi titik akhir privat dari layanan provisi

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	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

Objek

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

Objek

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

Enumeration

Status koneksi titik akhir privat

Nilai	Deskripsi
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Objek

Deskripsi layanan provisi.

Nama	Jenis	Deskripsi
etag	string	Bidang Etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi ETag normal.
id	string	Pengidentifikasi sumber daya.
location	string	Lokasi sumber daya.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	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

Enumeration

Apakah permintaan dari Jaringan Publik diizinkan

Nilai	Deskripsi
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Objek

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

Enumeration

Status layanan provisi saat ini.

Nilai	Deskripsi
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

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

Bagikan melalui

Iot Dps Resource - Create Or Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

DPSCreate

Permintaan sampel

Respon sampel

Definisi

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

Sumber Daya Tambahan: