共用方式為


Iot Dps Resource - List By Subscription

取得訂用帳戶中的所有布建服務。
列出指定訂用帳戶標識碼的所有布建服務。

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

URI 參數

名稱 位於 必要 類型 Description
subscriptionId
path True

string

訂用帳戶識別碼。

api-version
query True

string

API 的版本。

回應

名稱 類型 Description
200 OK

ProvisioningServiceDescriptionListResult

這是同步作業。 本文包含訂用帳戶中所有布建服務的元數據 JSON 串行化陣列。

Other Status Codes

ErrorDetails

默認錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

DPSListBySubscription

範例要求

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

範例回覆

{
  "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",
        "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
      }
    },
    {
      "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",
        "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/mySecondProvisioningService",
      "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
      "tags": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    }
  ]
}

定義

名稱 Description
AccessRightsDescription

此金鑰擁有的許可權。

AllocationPolicy

此布建服務要使用的配置原則。

createdByType

建立資源的身分識別類型。

ErrorDetails

錯誤詳細數據。

IotDpsPropertiesDescription

布建服務的服務特定屬性,包括密鑰、連結的 iot 中樞、目前狀態,以及系統產生的屬性,例如主機名和 idScope

IotDpsSku

Sku 名稱。

IotDpsSkuInfo

可能的布建服務 SKU 清單。

IotHubDefinitionDescription

IoT 中樞的描述。

IpFilterActionType

此規則所擷取之要求所需的動作。

IpFilterRule

布建服務的IP篩選規則。

IpFilterTargetType

此規則所擷取的要求目標。

PrivateEndpoint

私人端點連線的私人端點屬性

PrivateEndpointConnection

布建服務的私人端點連線

PrivateEndpointConnectionProperties

私人端點連線的屬性

PrivateLinkServiceConnectionState

私人端點連線的目前狀態

PrivateLinkServiceConnectionStatus

私人端點連線的狀態

ProvisioningServiceDescription

布建服務的描述。

ProvisioningServiceDescriptionListResult

布建服務描述的清單。

PublicNetworkAccess

是否允許來自公用網路的要求

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共用存取金鑰的描述。

state

布建服務的目前狀態。

systemData

與建立和上次修改資源相關的元數據。

AccessRightsDescription

此金鑰擁有的許可權。

名稱 類型 Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

AllocationPolicy

此布建服務要使用的配置原則。

名稱 類型 Description
GeoLatency

string

Hashed

string

Static

string

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

integer

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。

IotDpsPropertiesDescription

布建服務的服務特定屬性,包括密鑰、連結的 iot 中樞、目前狀態,以及系統產生的屬性,例如主機名和 idScope

名稱 類型 Description
allocationPolicy

AllocationPolicy

此布建服務要使用的配置原則。

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

布建服務的授權金鑰清單。

deviceProvisioningHostName

string

此布建服務的裝置端點。

enableDataResidency

boolean

選擇性。 指出 DPS 實例是否已啟用 Data Residency,移除跨異地配對災害復原。

idScope

string

此布建服務的唯一標識符。

iotHubs

IotHubDefinitionDescription[]

與此布建服務相關聯的IoT中樞清單。

ipFilterRules

IpFilterRule[]

IP 篩選規則。

portalOperationsHostName

string

啟用此布建服務的 CORS 入口網站端點。

privateEndpointConnections

PrivateEndpointConnection[]

在此IotHub上建立的私人端點連線

provisioningState

string

布建服務的ARM布建狀態。

publicNetworkAccess

PublicNetworkAccess

是否允許來自公用網路的要求

serviceOperationsHostName

string

布建服務的服務端點。

state

state

布建服務的目前狀態。

IotDpsSku

Sku 名稱。

名稱 類型 Description
S1

string

IotDpsSkuInfo

可能的布建服務 SKU 清單。

名稱 類型 Description
capacity

integer

要布建的單位數目

name

IotDpsSku

Sku 名稱。

tier

string

布建服務的定價層名稱。

IotHubDefinitionDescription

IoT 中樞的描述。

名稱 類型 Description
allocationWeight

integer

要套用至指定 iot h 的權數。

applyAllocationPolicy

boolean

旗標,用於套用allocationPolicy或不適用於指定的iot中樞。

connectionString

string

IoT 中樞的連接字串。

location

string

IoT 中樞的ARM區域。

name

string

IoT 中樞的主機名。

IpFilterActionType

此規則所擷取之要求所需的動作。

名稱 類型 Description
Accept

string

Reject

string

IpFilterRule

布建服務的IP篩選規則。

名稱 類型 Description
action

IpFilterActionType

此規則所擷取之要求所需的動作。

filterName

string

IP 篩選規則的名稱。

ipMask

string

字串,包含規則 CIDR 表示法中的IP位址範圍。

target

IpFilterTargetType

此規則所擷取的要求目標。

IpFilterTargetType

此規則所擷取的要求目標。

名稱 類型 Description
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

私人端點連線的私人端點屬性

名稱 類型 Description
id

string

資源標識碼。

PrivateEndpointConnection

布建服務的私人端點連線

名稱 類型 Description
id

string

資源標識碼。

name

string

資源名稱。

properties

PrivateEndpointConnectionProperties

私人端點連線的屬性

systemData

systemData

與建立和上次修改資源相關的元數據。

type

string

資源類型。

PrivateEndpointConnectionProperties

私人端點連線的屬性

名稱 類型 Description
privateEndpoint

PrivateEndpoint

私人端點連線的私人端點屬性

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

私人端點連線的目前狀態

PrivateLinkServiceConnectionState

私人端點連線的目前狀態

名稱 類型 Description
actionsRequired

string

私人端點連線所需的動作

description

string

私人端點連線目前狀態的描述

status

PrivateLinkServiceConnectionStatus

私人端點連線的狀態

PrivateLinkServiceConnectionStatus

私人端點連線的狀態

名稱 類型 Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningServiceDescription

布建服務的描述。

名稱 類型 Description
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

資源類型。

ProvisioningServiceDescriptionListResult

布建服務描述的清單。

名稱 類型 Description
nextLink

string

下一個連結

value

ProvisioningServiceDescription[]

布建服務描述的清單。

PublicNetworkAccess

是否允許來自公用網路的要求

名稱 類型 Description
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

共用存取金鑰的描述。

名稱 類型 Description
keyName

string

金鑰的名稱。

primaryKey

string

主要 SAS 金鑰值。

rights

AccessRightsDescription

此金鑰擁有的許可權。

secondaryKey

string

次要 SAS 金鑰值。

state

布建服務的目前狀態。

名稱 類型 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

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。