共用方式為


Instance - List By Subscription

依訂用帳戶識別碼列出 InstanceResource 資源

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTOperations/instances?api-version=2026-03-01

URI 參數

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

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

InstanceResourceListResult

Azure 作業已順利完成。

Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

範圍

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

範例

Instance_ListBySubscription

範例要求

GET https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/providers/Microsoft.IoTOperations/instances?api-version=2026-03-01

範例回覆

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "version": "1.2.0",
        "schemaRegistryRef": {
          "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123"
        },
        "description": "empgqmbhvklcqlyahmdsjemlep"
      },
      "extendedLocation": {
        "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
        "type": "CustomLocation"
      },
      "identity": {
        "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327",
        "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec",
        "type": "None",
        "userAssignedIdentities": {}
      },
      "tags": {},
      "location": "eastus2",
      "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123",
      "name": "llptmlifnqqwairx",
      "type": "Microsoft.IoTOperations/instances",
      "systemData": {
        "createdBy": "contosouser",
        "createdByType": "User",
        "createdAt": "2024-08-09T18:13:29.389Z",
        "lastModifiedBy": "contosouser",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-08-09T18:13:29.389Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

定義

名稱 Description
AzureDeviceRegistryNamespaceRef

Azure 裝置登錄命名空間參考。

createdByType

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

ExtendedLocation

擴充位置是 Azure 位置的延伸模組。 它們提供一種方式,可使用已啟用 Azure ARC 的 Kubernetes 叢集作為部署 Azure 服務執行個體的目標位置。

ExtendedLocationType

接受的列舉定義 ExtendedLocation 類型。

InstanceFeature

AIO 實例的功能。

InstanceFeatureMode

功能的列舉定義模式。

InstanceProperties

執行個體資源的屬性。

InstanceResource

實例資源是一組子資源的邏輯容器。

InstanceResourceListResult

InstanceResource 清單作業的回應。

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

ProvisioningState

定義資源狀態的列舉。

ResourceHealthState

資源的健康情況狀態。

SchemaRegistryRef

這個 AIO 實例之架構登錄的參考。

SecretProviderClassRef

對 AIO Secret 提供程式類的引用。

systemData

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

UserAssignedIdentity

使用者指派的身分識別屬性

AzureDeviceRegistryNamespaceRef

Azure 裝置登錄命名空間參考。

名稱 類型 Description
resourceId

string (arm-id)

Azure 設備註冊表命名空間的資源ID。

createdByType

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

Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

附加資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

ExtendedLocation

擴充位置是 Azure 位置的延伸模組。 它們提供一種方式,可使用已啟用 Azure ARC 的 Kubernetes 叢集作為部署 Azure 服務執行個體的目標位置。

名稱 類型 Description
name

string

擴充位置的名稱。

type

ExtendedLocationType

ExtendedLocation 的類型。

ExtendedLocationType

接受的列舉定義 ExtendedLocation 類型。

Description
CustomLocation

CustomLocation 類型

InstanceFeature

AIO 實例的功能。

名稱 類型 Description
mode

InstanceFeatureMode

功能的狀態。

settings

object

功能的設定。

InstanceFeatureMode

功能的列舉定義模式。

Description
Stable

選擇啟用穩定功能

Preview

選擇啟用預覽功能

Disabled

選擇退出某項功能

InstanceProperties

執行個體資源的屬性。

名稱 類型 預設值 Description
adrNamespaceRef

AzureDeviceRegistryNamespaceRef

資產、發現的資產和設備使用的 Azure 設備註冊表命名空間

defaultSecretProviderClassRef

SecretProviderClassRef

對 AIO Secret 提供程式類的引用。

description

string

實例的詳細描述。

features

<string,  InstanceFeature>

AIO 實例的功能。

healthState

ResourceHealthState

Unknown

資源的健康情況狀態。

provisioningState

ProvisioningState

上次作業的狀態。

schemaRegistryRef

SchemaRegistryRef

這個 AIO 實例之架構登錄的參考。

version

string

Azure IoT 作業版本。

InstanceResource

實例資源是一組子資源的邏輯容器。

名稱 類型 Description
extendedLocation

ExtendedLocation

資源的邊緣位置。

id

string (arm-id)

資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

identity

ManagedServiceIdentity

指派給此資源的受控服務識別。

location

string

資源所在的地理位置

name

string

資源的名稱

properties

InstanceProperties

此資源的資源特定屬性。

systemData

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

tags

object

資源標籤。

type

string

資源的類型。 例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

InstanceResourceListResult

InstanceResource 清單作業的回應。

名稱 類型 Description
nextLink

string (uri)

專案下一頁的連結

value

InstanceResource[]

此頁面上的 InstanceResource 專案

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

名稱 類型 Description
principalId

string (uuid)

系統指派身分識別的服務主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string (uuid)

系統指派身分識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。

type

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 身分識別
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件({})。

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

定義資源狀態的列舉。

Description
Succeeded

資源已建立。

Failed

資源建立失敗。

Canceled

資源建立已取消。

Provisioning

資源正在佈建中。

Updating

資源正在更新中。

Deleting

資源正在刪除。

Accepted

資源已被接受。

ResourceHealthState

資源的健康情況狀態。

Description
Available

資源可用且如預期般運作。

Degraded

資源健康情況已降低。

Unavailable

資源未如預期般運作。

Unknown

資源狀態未知。

SchemaRegistryRef

這個 AIO 實例之架構登錄的參考。

名稱 類型 Description
resourceId

string (arm-id)

架構登錄的資源識別碼。

SecretProviderClassRef

對 AIO Secret 提供程式類的引用。

名稱 類型 Description
resourceId

string (arm-id)

AIO 金鑰提供者類的資源 ID。

systemData

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

名稱 類型 Description
createdAt

string (date-time)

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

createdBy

string

建立資源的身分識別。

createdByType

createdByType

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

lastModifiedAt

string (date-time)

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

UserAssignedIdentity

使用者指派的身分識別屬性

名稱 類型 Description
clientId

string (uuid)

指派之身分識別的用戶端標識碼。

principalId

string (uuid)

指派之身分識別的主體標識碼。