你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Iot Dps Resource - List By Subscription
获取订阅中的所有预配服务。
列出给定订阅 ID 的所有预配服务。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices?api-version=2018-01-22
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
订阅标识符。 |
api-version
|
query | True |
string |
API 的版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
这是一个同步操作。 正文包含来自订阅中所有预配服务的元数据的 JSON 序列化数组。 |
|
Other Status Codes |
默认错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
DPSListBySubscription
Sample Request
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/provisioningServices?api-version=2018-01-22
Sample Response
{
"value": [
{
"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"
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
},
{
"etag": "AAAAAAAADGk=",
"name": "mySecondProvisioningService",
"location": "eastus",
"properties": {
"state": "Active",
"allocationPolicy": "Hashed",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012"
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
]
}
定义
名称 | 说明 |
---|---|
Access |
此密钥具有的权限。 |
Allocation |
此预配服务要使用的分配策略。 |
Error |
错误详细信息。 |
Iot |
预配服务的特定于服务的属性,包括密钥、链接的 iot 中心、当前状态和系统生成的属性(如主机名和 idScope) |
Iot |
Sku 名称。 |
Iot |
可能的预配服务 SKU 列表。 |
Iot |
IoT 中心的说明。 |
Provisioning |
预配服务的说明。 |
Provisioning |
预配服务说明的列表。 |
Shared |
共享访问密钥的说明。 |
state |
预配服务的当前状态。 |
AccessRightsDescription
此密钥具有的权限。
名称 | 类型 | 说明 |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
此预配服务要使用的分配策略。
名称 | 类型 | 说明 |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
ErrorDetails
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
string |
错误详细信息。 |
httpStatusCode |
string |
HTTP 状态代码。 |
message |
string |
错误消息。 |
IotDpsPropertiesDescription
预配服务的特定于服务的属性,包括密钥、链接的 iot 中心、当前状态和系统生成的属性(如主机名和 idScope)
名称 | 类型 | 说明 |
---|---|---|
allocationPolicy |
此预配服务要使用的分配策略。 |
|
authorizationPolicies |
Shared |
预配服务的授权密钥列表。 |
deviceProvisioningHostName |
string |
此预配服务的设备终结点。 |
idScope |
string |
此预配服务的唯一标识符。 |
iotHubs |
与此预配服务关联的 IoT 中心列表。 |
|
provisioningState |
string |
预配服务的 ARM 预配状态。 |
serviceOperationsHostName |
string |
用于预配服务的服务终结点。 |
state |
预配服务的当前状态。 |
IotDpsSku
Sku 名称。
名称 | 类型 | 说明 |
---|---|---|
S1 |
string |
IotDpsSkuInfo
可能的预配服务 SKU 列表。
名称 | 类型 | 说明 |
---|---|---|
capacity |
integer |
要预配的单位数 |
name |
Sku 名称。 |
|
tier |
string |
预配服务的定价层名称。 |
IotHubDefinitionDescription
IoT 中心的说明。
名称 | 类型 | 说明 |
---|---|---|
allocationWeight |
integer |
要申请给定 iot h 的 weight。 |
applyAllocationPolicy |
boolean |
标志,用于为给定的 iot 中心应用 allocationPolicy 或不应用。 |
connectionString |
string |
连接字符串 og IoT 中心。 |
location |
string |
IoT 中心的 ARM 区域。 |
name |
string |
IoT 中心的主机名。 |
ProvisioningServiceDescription
预配服务的说明。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
Etag 字段 不 是必需的。 如果在响应正文中提供,则还必须根据常规 ETag 约定将其作为标头提供。 |
id |
string |
资源标识符。 |
location |
string |
资源位置。 |
name |
string |
资源名称。 |
properties |
预配服务的服务特定属性 |
|
sku |
预配服务的 SKU 信息。 |
|
tags |
object |
资源标记。 |
type |
string |
资源类型。 |
ProvisioningServiceDescriptionListResult
预配服务说明的列表。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
下一个链接 |
value |
预配服务说明的列表。 |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
共享访问密钥的说明。
名称 | 类型 | 说明 |
---|---|---|
keyName |
string |
密钥的名称。 |
primaryKey |
string |
主 SAS 密钥值。 |
rights |
此密钥具有的权限。 |
|
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 |