你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Iot Dps Resource - Get

获取预配服务的非安全相关元数据。
获取没有 SAS 密钥的预配服务的元数据。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22

URI 参数

Name In Required Type Description
provisioningServiceName
path True
  • string

要检索的预配服务的名称。

resourceGroupName
path True
  • string

资源组名称。

subscriptionId
path True
  • string

订阅标识符。

api-version
query True
  • string

API 的版本。

响应

Name Type Description
200 OK

响应中未包含任何密钥的预配服务说明。

Other Status Codes

默认错误响应

安全性

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 模拟用户帐户

示例

DPSGet

Sample Request

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

Sample Response

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

定义

AccessRightsDescription

此密钥具有的权限。

AllocationPolicy

此预配服务要使用的分配策略。

ErrorDetails

错误详细信息。

IotDpsPropertiesDescription

预配服务的服务特定属性,包括密钥、链接的 iot 中心、当前状态和系统生成的属性,例如主机名和 idScope

IotDpsSku

Sku 名称。

IotDpsSkuInfo

可能的预配服务 SKU 列表。

IotHubDefinitionDescription

IoT 中心的说明。

ProvisioningServiceDescription

预配服务的说明。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共享访问密钥的说明。

state

预配服务的当前状态。

AccessRightsDescription

此密钥具有的权限。

Name Type Description
DeviceConnect
  • string
EnrollmentRead
  • string
EnrollmentWrite
  • string
RegistrationStatusRead
  • string
RegistrationStatusWrite
  • string
ServiceConfig
  • string

AllocationPolicy

此预配服务要使用的分配策略。

Name Type Description
GeoLatency
  • string
Hashed
  • string
Static
  • string

ErrorDetails

错误详细信息。

Name Type Description
code
  • string

错误代码。

details
  • string

错误详细信息。

httpStatusCode
  • string

HTTP 状态代码。

message
  • string

错误消息。

IotDpsPropertiesDescription

预配服务的服务特定属性,包括密钥、链接的 iot 中心、当前状态和系统生成的属性,例如主机名和 idScope

Name Type Description
allocationPolicy

此预配服务要使用的分配策略。

authorizationPolicies

预配服务的授权密钥列表。

deviceProvisioningHostName
  • string

此预配服务的设备终结点。

idScope
  • string

此预配服务的唯一标识符。

iotHubs

与此预配服务关联的 IoT 中心列表。

provisioningState
  • string

预配服务的 ARM 预配状态。

serviceOperationsHostName
  • string

用于预配服务的服务终结点。

state

预配服务的当前状态。

IotDpsSku

Sku 名称。

Name Type Description
S1
  • string

IotDpsSkuInfo

可能的预配服务 SKU 列表。

Name Type Description
capacity
  • integer

要预配的单位数

name

Sku 名称。

tier
  • string

预配服务的定价层名称。

IotHubDefinitionDescription

IoT 中心的说明。

Name Type Description
allocationWeight
  • integer

要应用于给定 iot h 的权重。

applyAllocationPolicy
  • boolean

用于应用 allocationPolicy 或不应用于给定 iot 中心的标志。

connectionString
  • string

连接字符串 og IoT 中心。

location
  • string

IoT 中心的 ARM 区域。

name
  • string

IoT 中心的主机名。

ProvisioningServiceDescription

预配服务的说明。

Name Type Description
etag
  • string

不需要 Etag 字段。 如果在响应正文中提供,则还必须根据正常的 ETag 约定将其作为标头提供。

id
  • string

资源标识符。

location
  • string

资源位置。

name
  • string

资源名称。

properties

预配服务的服务特定属性

sku

预配服务的 SKU 信息。

tags
  • object

资源标记。

type
  • string

资源类型。

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共享访问密钥的说明。

Name Type Description
keyName
  • string

密钥的名称。

primaryKey
  • string

主 SAS 密钥值。

rights

此密钥具有的权限。

secondaryKey
  • string

辅助 SAS 密钥值。

state

预配服务的当前状态。

Name Type 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