通过


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

Instance - List By Subscription

按订阅 ID 列出 InstanceResource 资源

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

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

minLength: 1

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

InstanceResourceListResult

Azure作已成功完成。

Other Status Codes

ErrorResponse

意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
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"
}

定义

名称 说明
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 设备注册表命名空间参考。

名称 类型 说明
resourceId

string (arm-id)

Azure 设备注册表命名空间的资源 ID。

createdByType

创建资源的标识的类型。

说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

附加信息。

type

string

附加信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ExtendedLocation

扩展位置是 Azure 位置的扩展。 它们提供了一种使用已启用 Azure ARC 的 Kubernetes 群集作为部署 Azure 服务实例的目标位置的方法。

名称 类型 说明
name

string

扩展位置的名称。

type

ExtendedLocationType

ExtendedLocation 的类型。

ExtendedLocationType

接受的枚举定义 ExtendedLocation 类型。

说明
CustomLocation

CustomLocation 类型

InstanceFeature

AIO 实例的功能。

名称 类型 说明
mode

InstanceFeatureMode

功能的状态。

settings

object

功能的设置。

InstanceFeatureMode

特征的枚举定义模式。

说明
Stable

选择启用稳定功能

Preview

选择启用预览功能

Disabled

选择退出某项功能

InstanceProperties

实例资源的属性。

名称 类型 默认值 说明
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

实例资源是一组子资源的逻辑容器。

名称 类型 说明
extendedLocation

ExtendedLocation

资源的边缘位置。

id

string (arm-id)

资源的完全限定资源 ID。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

identity

ManagedServiceIdentity

分配给此资源的托管服务标识。

location

string

资源所在的地理位置

name

string

资源的名称

properties

InstanceProperties

此资源的资源特定属性。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源类型。 例如,“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

InstanceResourceListResult

InstanceResource 列表作的响应。

名称 类型 说明
nextLink

string (uri)

指向下一页项的链接

value

InstanceResource[]

此页上的 InstanceResource 项

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

名称 类型 说明
principalId

string (uuid)

系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。

tenantId

string (uuid)

系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

说明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

枚举定义资源的状态。

说明
Succeeded

已创建资源。

Failed

资源创建失败。

Canceled

资源创建已取消。

Provisioning

资源正在预配。

Updating

资源正在更新。

Deleting

资源正在删除。

Accepted

资源已被接受。

ResourceHealthState

资源的运行状况。

说明
Available

资源可用且按预期运行。

Degraded

资源运行状况下降。

Unavailable

资源未按预期运行。

Unknown

资源状态未知。

SchemaRegistryRef

对此 AIO 实例的架构注册表的引用。

名称 类型 说明
resourceId

string (arm-id)

架构注册表的资源 ID。

SecretProviderClassRef

对 AIO Secret 提供程序类的引用。

名称 类型 说明
resourceId

string (arm-id)

AIO 密钥提供程序类的资源 ID。

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string (uuid)

分配的标识的客户端 ID。

principalId

string (uuid)

已分配标识的主体 ID。