Iot Dps Resource - Create Or Update

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Sağlama hizmetinin meta verilerini İçerik Oluşturucu veya güncelleştirin. Bir özelliği değiştirmek için normal desen, sağlama hizmeti meta verilerini ve güvenlik meta verilerini almak ve bunları yeni bir gövdedeki değiştirilmiş değerlerle birleştirerek sağlama hizmetini güncelleştirmektir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
provisioningServiceName	path	True	string	Oluşturulacak veya güncelleştirilecek sağlama hizmetinin adı.
resourceGroupName	path	True	string	Kaynak grubu tanımlayıcısı.
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
api-version	query	True	string	API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynak konumu.
properties	True	IotDpsPropertiesDescription	Sağlama hizmeti için hizmete özgü özellikler
sku	True	IotDpsSkuInfo	Sağlama Hizmeti için SKU bilgileri.
etag		string	Etag alanı gerekli değildir . Yanıt gövdesinde sağlanıyorsa, normal ETag kuralına göre üst bilgi olarak da sağlanmalıdır.
resourcegroup		string	Kaynağın kaynak grubu.
subscriptionid		string	Kaynağın abonelik kimliği.
tags		object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	ProvisioningServiceDescription	Gövde, sağlama hizmetinin tüm güvenlik dışı özelliklerini içerir. Güvenlikle ilgili özellikler null olarak ayarlanır.
201 Created	ProvisioningServiceDescription	Bu uzun süre çalışan bir işlemdir. Doğrulama tamamlandıysa işlem bir 201 döndürür. Yanıt, durum URL'si içeren bir Azure-AsyncOperation üst bilgisi içerir. İstemcilerin işlemin durumu için durum URL'sini yoklaması beklenir. İşlem başarılı olursa 201 (Tamam) HTTP durum kodunu döndürür.
Other Status Codes	ErrorDetails	Varsayılan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
AccessRightsDescription	Bu anahtarın sahip olduğu haklar.
AllocationPolicy	Bu sağlama hizmeti tarafından kullanılacak ayırma ilkesi.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorDetails	Hata ayrıntıları.
IotDpsPropertiesDescription	anahtarlar, bağlı iot hub'ları, geçerli durum ve konak adı ve idScope gibi sistem tarafından oluşturulan özellikler de dahil olmak üzere bir sağlama hizmetinin hizmete özgü özellikleri
IotDpsSku	Sku adı.
IotDpsSkuInfo	Olası sağlama hizmeti SKU'larının listesi.
IotHubDefinitionDescription	IoT hub'ının açıklaması.
IpFilterActionType	Bu kural tarafından yakalanan istekler için istenen eylem.
IpFilterRule	Sağlama Hizmeti için IP filtresi kuralları.
IpFilterTargetType	Bu kural tarafından yakalanan istekler için hedef.
PrivateEndpoint	Özel uç nokta bağlantısının özel uç nokta özelliği
PrivateEndpointConnection	Sağlama hizmetinin özel uç nokta bağlantısı
PrivateEndpointConnectionProperties	Özel uç nokta bağlantısının özellikleri
PrivateLinkServiceConnectionState	Özel uç nokta bağlantısının geçerli durumu
PrivateLinkServiceConnectionStatus	Özel uç nokta bağlantısının durumu
ProvisioningServiceDescription	Sağlama hizmetinin açıklaması.
PublicNetworkAccess	Genel Ağdan gelen isteklere izin verilip verilmeyeceği
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Paylaşılan erişim anahtarının açıklaması.
state	Sağlama hizmetinin geçerli durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

AccessRightsDescription

Bu anahtarın sahip olduğu haklar.

Name	Tür	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

Bu sağlama hizmeti tarafından kullanılacak ayırma ilkesi.

Name	Tür	Description
GeoLatency	string
Hashed	string
Static	string

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Hata ayrıntıları.

Name	Tür	Description
code	integer	Hata kodu.
details	string	Hata ayrıntıları.
httpStatusCode	string	HTTP durum kodu.
message	string	Hata iletisi.

IotDpsPropertiesDescription

anahtarlar, bağlı iot hub'ları, geçerli durum ve konak adı ve idScope gibi sistem tarafından oluşturulan özellikler de dahil olmak üzere bir sağlama hizmetinin hizmete özgü özellikleri

Name	Tür	Description
allocationPolicy	AllocationPolicy	Bu sağlama hizmeti tarafından kullanılacak ayırma ilkesi.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Sağlama hizmeti için yetkilendirme anahtarlarının listesi.
deviceProvisioningHostName	string	Bu sağlama hizmeti için cihaz uç noktası.
enableDataResidency	boolean	İsteğe bağlı. DPS örneğinin coğrafi çiftler arası olağanüstü durum kurtarmasını kaldırarak Data Residency etkinleştirilip etkinleştirilmediğini gösterir.
idScope	string	Bu sağlama hizmetinin benzersiz tanımlayıcısı.
iotHubs	IotHubDefinitionDescription[]	Bu sağlama hizmetiyle ilişkili IoT hub'larının listesi.
ipFilterRules	IpFilterRule[]	IP filtresi kuralları.
portalOperationsHostName	string	Bu sağlama hizmeti için CORS'yi etkinleştirmek için portal uç noktası.
privateEndpointConnections	PrivateEndpointConnection[]	Bu IotHub'da oluşturulan özel uç nokta bağlantıları
provisioningState	string	Sağlama hizmetinin ARM sağlama durumu.
publicNetworkAccess	PublicNetworkAccess	Genel Ağdan gelen isteklere izin verilip verilmeyeceği
serviceOperationsHostName	string	Hizmet sağlama için hizmet uç noktası.
state	state	Sağlama hizmetinin geçerli durumu.

IotDpsSku

Sku adı.

Name	Tür	Description
S1	string

IotDpsSkuInfo

Olası sağlama hizmeti SKU'larının listesi.

Name	Tür	Description
capacity	integer	Sağ kullanılacak birim sayısı
name	IotDpsSku	Sku adı.
tier	string	Sağlama hizmetinin fiyatlandırma katmanı adı.

IotHubDefinitionDescription

IoT hub'ının açıklaması.

Name	Tür	Description
allocationWeight	integer	belirli bir iot h için uygulanacak ağırlık.
applyAllocationPolicy	boolean	belirli bir iot hub'ı için allocationPolicy uygulama veya uygulamama bayrağı.
connectionString	string	IoT hub'ının bağlantı dizesi.
location	string	IoT hub'ının ARM bölgesi.
name	string	IoT hub'ının ana bilgisayar adı.

IpFilterActionType

Bu kural tarafından yakalanan istekler için istenen eylem.

Name	Tür	Description
Accept	string
Reject	string

IpFilterRule

Sağlama Hizmeti için IP filtresi kuralları.

Name	Tür	Description
action	IpFilterActionType	Bu kural tarafından yakalanan istekler için istenen eylem.
filterName	string	IP filtresi kuralının adı.
ipMask	string	Kural için CIDR gösteriminde IP adresi aralığını içeren bir dize.
target	IpFilterTargetType	Bu kural tarafından yakalanan istekler için hedef.

IpFilterTargetType

Bu kural tarafından yakalanan istekler için hedef.

Name	Tür	Description
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Özel uç nokta bağlantısının özel uç nokta özelliği

Name	Tür	Description
id	string	Kaynak tanımlayıcısı.

PrivateEndpointConnection

Sağlama hizmetinin özel uç nokta bağlantısı

Name	Tür	Description
id	string	Kaynak tanımlayıcısı.
name	string	Kaynak adı.
properties	PrivateEndpointConnectionProperties	Özel uç nokta bağlantısının özellikleri
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
type	string	Kaynak türü.

PrivateEndpointConnectionProperties

Özel uç nokta bağlantısının özellikleri

Name	Tür	Description
privateEndpoint	PrivateEndpoint	Özel uç nokta bağlantısının özel uç nokta özelliği
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Özel uç nokta bağlantısının geçerli durumu

PrivateLinkServiceConnectionState

Özel uç nokta bağlantısının geçerli durumu

Name	Tür	Description
actionsRequired	string	Özel uç nokta bağlantısı için gereken eylemler
description	string	Özel uç nokta bağlantısının geçerli durumunun açıklaması
status	PrivateLinkServiceConnectionStatus	Özel uç nokta bağlantısının durumu

PrivateLinkServiceConnectionStatus

Özel uç nokta bağlantısının durumu

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Sağlama hizmetinin açıklaması.

Name	Tür	Description
etag	string	Etag alanı gerekli değildir . Yanıt gövdesinde sağlanıyorsa, normal ETag kuralına göre üst bilgi olarak da sağlanmalıdır.
id	string	Kaynak tanımlayıcısı.
location	string	Kaynak konumu.
name	string	Kaynak adı.
properties	IotDpsPropertiesDescription	Sağlama hizmeti için hizmete özgü özellikler
resourcegroup	string	Kaynağın kaynak grubu.
sku	IotDpsSkuInfo	Sağlama Hizmeti için SKU bilgileri.
subscriptionid	string	Kaynağın abonelik kimliği.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri.
type	string	Kaynak türü.

PublicNetworkAccess

Genel Ağdan gelen isteklere izin verilip verilmeyeceği

Name	Tür	Description
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Paylaşılan erişim anahtarının açıklaması.

Name	Tür	Description
keyName	string	Anahtarın adı.
primaryKey	string	Birincil SAS anahtarı değeri.
rights	AccessRightsDescription	Bu anahtarın sahip olduğu haklar.
secondaryKey	string	İkincil SAS anahtar değeri.

state

Sağlama hizmetinin geçerli durumu.

Name	Tür	Description
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

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.