Iot Dps Resource - Create Or Update

Ссылка

Служба:: IoT Hub Device Provisioning Service

Версия API:: 2022-12-12

Создайте или обновите метаданные службы подготовки. Обычный шаблон изменения свойства — получить метаданные службы подготовки и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления службы подготовки.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
provisioningServiceName	path	True	string	Имя службы подготовки для создания или обновления.
resourceGroupName	path	True	string	Идентификатор группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Расположение ресурса.
properties	True	IotDpsPropertiesDescription	Свойства конкретной службы для службы подготовки
sku	True	IotDpsSkuInfo	Сведения о SKU для службы подготовки.
etag		string	Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag.
resourcegroup		string	Группа ресурсов ресурса.
subscriptionid		string	Идентификатор подписки ресурса.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	ProvisioningServiceDescription	Текст содержит все небезопасные свойства службы подготовки. Свойства, связанные с безопасностью, имеют значение NULL.
201 Created	ProvisioningServiceDescription	Выполнение этой операции занимает длительное время. Операция возвращает значение 201, если проверка завершена. Ответ содержит заголовок Azure-AsyncOperation, содержащий URL-адрес состояния. Ожидается, что клиенты будут опрашивать URL-адрес состояния для состояния операции. В случае успешного выполнения операция возвращает код состояния HTTP 201 (ОК).
Other Status Codes	ErrorDetails	Ответ об ошибке по умолчанию.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

DPSCreate

Образец запроса

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

Пример ответа

Код состояния:: 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
  }
}

Код состояния:: 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
  }
}

Определения

Имя	Описание
AccessRightsDescription	Права, имеющиеся у этого ключа.
AllocationPolicy	Политика выделения, используемая этой службой подготовки.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorDetails	Сведения об ошибке.
IotDpsPropertiesDescription	определенные свойства службы подготовки, включая ключи, связанные центры iot, текущее состояние и системные созданные свойства, такие как имя узла и idScope
IotDpsSku	Имя SKU.
IotDpsSkuInfo	Список возможных номеров SKU службы подготовки.
IotHubDefinitionDescription	Описание Центра Интернета вещей.
IpFilterActionType	Требуемое действие для запросов, захваченных этим правилом.
IpFilterRule	Правила фильтрации IP-адресов для службы подготовки.
IpFilterTargetType	Целевой объект для запросов, захваченных этим правилом.
PrivateEndpoint	Свойство частной конечной точки подключения частной конечной точки
PrivateEndpointConnection	Подключение к частной конечной точке службы подготовки
PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки
PrivateLinkServiceConnectionState	Текущее состояние подключения к частной конечной точке
PrivateLinkServiceConnectionStatus	Состояние подключения частной конечной точки
ProvisioningServiceDescription	Описание службы подготовки.
PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Описание общего ключа доступа.
state	Текущее состояние службы подготовки.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AccessRightsDescription

Перечисление

Права, имеющиеся у этого ключа.

Значение	Описание
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Перечисление

Политика выделения, используемая этой службой подготовки.

Значение	Описание
GeoLatency
Hashed
Static

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorDetails

Object

Сведения об ошибке.

Имя	Тип	Описание
code	integer (int32)	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

IotDpsPropertiesDescription

Object

определенные свойства службы подготовки, включая ключи, связанные центры iot, текущее состояние и системные созданные свойства, такие как имя узла и idScope

Имя	Тип	Описание
allocationPolicy	AllocationPolicy	Политика выделения, используемая этой службой подготовки.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Список ключей авторизации для службы подготовки.
deviceProvisioningHostName	string	Конечная точка устройства для этой службы подготовки.
enableDataResidency	boolean	Необязательно. Указывает, включен ли экземпляр DPS расположение данных, удаляя межпаренный аварийное восстановление.
idScope	string	Уникальный идентификатор этой службы подготовки.
iotHubs	IotHubDefinitionDescription[]	Список центров Интернета вещей, связанных с этой службой подготовки.
ipFilterRules	IpFilterRule[]	Правила фильтрации IP-адресов.
portalOperationsHostName	string	Конечная точка портала для включения CORS для этой службы подготовки.
privateEndpointConnections	PrivateEndpointConnection[]	Подключения к частной конечной точке, созданные на этом IotHub
provisioningState	string	Состояние подготовки ARM службы подготовки.
publicNetworkAccess	PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
serviceOperationsHostName	string	Конечная точка службы для подготовки службы.
state	state	Текущее состояние службы подготовки.

IotDpsSku

Перечисление

Имя SKU.

Значение	Описание
S1

IotDpsSkuInfo

Object

Список возможных номеров SKU службы подготовки.

Имя	Тип	Описание
capacity	integer (int64)	Количество единиц для подготовки
name	IotDpsSku	Имя SKU.
tier	string	Имя ценовой категории службы подготовки.

IotHubDefinitionDescription

Object

Описание Центра Интернета вещей.

Имя	Тип	Описание
allocationWeight	integer (int32)	вес, применяемый для заданного iot h.
applyAllocationPolicy	boolean	флаг для применения allocationPolicy или нет для заданного концентратора iot.
connectionString	string	Строка подключения центра Интернета вещей.
location	string	Область ARM центра Интернета вещей.
name	string	Имя узла Центра Интернета вещей.

IpFilterActionType

Перечисление

Требуемое действие для запросов, захваченных этим правилом.

Значение	Описание
Accept
Reject

IpFilterRule

Object

Правила фильтрации IP-адресов для службы подготовки.

Имя	Тип	Описание
action	IpFilterActionType	Требуемое действие для запросов, захваченных этим правилом.
filterName	string	Имя правила фильтрации IP-адресов.
ipMask	string	Строка, содержащая диапазон IP-адресов в нотации CIDR для правила.
target	IpFilterTargetType	Целевой объект для запросов, захваченных этим правилом.

IpFilterTargetType

Перечисление

Целевой объект для запросов, захваченных этим правилом.

Значение	Описание
all
deviceApi
serviceApi

PrivateEndpoint

Object

Свойство частной конечной точки подключения частной конечной точки

Имя	Тип	Описание
id	string	Идентификатор ресурса.

PrivateEndpointConnection

Object

Подключение к частной конечной точке службы подготовки

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Имя ресурса.
properties	PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса.

PrivateEndpointConnectionProperties

Object

Свойства подключения частной конечной точки

Имя	Тип	Описание
privateEndpoint	PrivateEndpoint	Свойство частной конечной точки подключения частной конечной точки
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Текущее состояние подключения к частной конечной точке

PrivateLinkServiceConnectionState

Object

Текущее состояние подключения к частной конечной точке

Имя	Тип	Описание
actionsRequired	string	Действия, необходимые для подключения частной конечной точки
description	string	Описание текущего состояния подключения частной конечной точки
status	PrivateLinkServiceConnectionStatus	Состояние подключения частной конечной точки

PrivateLinkServiceConnectionStatus

Перечисление

Состояние подключения частной конечной точки

Значение	Описание
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Object

Описание службы подготовки.

Имя	Тип	Описание
etag	string	Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag.
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Имя ресурса.
properties	IotDpsPropertiesDescription	Свойства конкретной службы для службы подготовки
resourcegroup	string	Группа ресурсов ресурса.
sku	IotDpsSkuInfo	Сведения о SKU для службы подготовки.
subscriptionid	string	Идентификатор подписки ресурса.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

PublicNetworkAccess

Перечисление

Разрешены ли запросы из общедоступной сети

Значение	Описание
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Object

Описание общего ключа доступа.

Имя	Тип	Описание
keyName	string	Имя ключа.
primaryKey	string	Значение ключа первичного SAS.
rights	AccessRightsDescription	Права, имеющиеся у этого ключа.
secondaryKey	string	Значение дополнительного ключа SAS.

state

Перечисление

Текущее состояние службы подготовки.

Значение	Описание
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Iot Dps Resource - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

DPSCreate

Образец запроса

Пример ответа

Определения

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

Дополнительные ресурсы