Iot Dps Resource - Get

  • Ссылка
Служба:
IoT Hub Device Provisioning Service
Версия API:
2022-12-12

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

GET 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.

Ответы

Имя Тип Описание
200 OK

ProvisioningServiceDescription

Описание службы подготовки без ключей включается в ответ.
Other Status Codes

ErrorDetails

Ответ на ошибку по умолчанию

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

DPSGet

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

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2022-12-12

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

Код состояния:
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": [],
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Определения

Имя Описание
AccessRightsDescription

Права, которые имеет этот ключ.
AllocationPolicy

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

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

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

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

Имя SKU.
IotDpsSkuInfo

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AccessRightsDescription

Права, которые имеет этот ключ.

Имя Тип Описание
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

AllocationPolicy

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

Имя Тип Описание
GeoLatency

string

Hashed

string

Static

string

createdByType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

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

Имя Тип Описание
code

integer

Код ошибки.
details

string

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

string

Код состояния HTTP.
message

string

Сообщение об ошибке.

IotDpsPropertiesDescription

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

Имя Тип Описание
allocationPolicy

AllocationPolicy

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

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Список ключей авторизации для службы подготовки.
deviceProvisioningHostName

string

Конечная точка устройства для этой службы подготовки.
enableDataResidency

boolean

Необязательный элемент. Указывает, включен ли экземпляр DPS Data Residency, удаляя аварийное восстановление между геопарными парами.
idScope

string

Уникальный идентификатор этой службы подготовки.
iotHubs

IotHubDefinitionDescription[]

Список Центров Интернета вещей, связанных с этой службой подготовки.
ipFilterRules

IpFilterRule[]

Правила фильтрации IP-адресов.
portalOperationsHostName

string

Конечная точка портала для включения CORS для этой службы подготовки.
privateEndpointConnections

PrivateEndpointConnection[]

Подключения к частной конечной точке, созданные на этом сайте Интернета вещей
provisioningState

string

Состояние подготовки ARM службы подготовки.
publicNetworkAccess

PublicNetworkAccess

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

string

Конечная точка службы для службы подготовки.
state

state

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

IotDpsSku

Имя SKU.

Имя Тип Описание
S1

string

IotDpsSkuInfo

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

Имя Тип Описание
capacity

integer

Число подготовленных единиц
name

IotDpsSku

Имя SKU.
tier

string

Имя ценовой категории службы подготовки.

IotHubDefinitionDescription

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

Имя Тип Описание
allocationWeight

integer

вес для применения для заданного iot h.
applyAllocationPolicy

boolean

флаг для применения allocationPolicy или нет для данного центра Интернета вещей.
connectionString

string

Строка подключения Центра Интернета вещей.
location

string

Регион ARM Центра Интернета вещей.
name

string

Имя узла Центра Интернета вещей.

IpFilterActionType

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

Имя Тип Описание
Accept

string

Reject

string

IpFilterRule

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

Имя Тип Описание
action

IpFilterActionType

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

string

Имя правила фильтрации IP-адресов.
ipMask

string

Строка, содержащая диапазон IP-адресов в нотации CIDR для правила.
target

IpFilterTargetType

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

IpFilterTargetType

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

Имя Тип Описание
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

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

Имя Тип Описание
id

string

Идентификатор ресурса.

PrivateEndpointConnection

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

Имя Тип Описание
id

string

Идентификатор ресурса.
name

string

Имя ресурса.
properties

PrivateEndpointConnectionProperties

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

systemData

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

string

Тип ресурса.

PrivateEndpointConnectionProperties

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

Имя Тип Описание
privateEndpoint

PrivateEndpoint

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionState

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

Имя Тип Описание
actionsRequired

string

Действия, необходимые для подключения к частной конечной точке
description

string

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

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

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

Имя Тип Описание
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningServiceDescription

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

Имя Тип Описание
etag

string

Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в виде заголовка в соответствии с обычным соглашением ETag.
id

string

Идентификатор ресурса.
location

string

Местоположение ресурса.
name

string

Имя ресурса.
properties

IotDpsPropertiesDescription

Свойства службы для службы подготовки
resourcegroup

string

Группа ресурсов ресурса.
sku

IotDpsSkuInfo

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

string

Идентификатор подписки ресурса.
systemData

systemData

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

object

Теги ресурса.
type

string

Тип ресурса.

PublicNetworkAccess

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

Имя Тип Описание
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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

Имя Тип Описание
keyName

string

Имя ключа.
primaryKey

string

Значение первичного ключа SAS.
rights

AccessRightsDescription

Права, которые имеет этот ключ.
secondaryKey

string

Значение вторичного ключа SAS.

state

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

Имя Тип Описание
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

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

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

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

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.