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

Asset Endpoint Profiles - List By Subscription

按订阅 ID 列出 AssetEndpointProfile 资源

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles?api-version=2024-11-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string (uuid)

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

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

AssetEndpointProfileListResult

Azure 操作已成功完成。

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List_AssetEndpointProfiles_Subscription

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/assetEndpointProfiles?api-version=2024-11-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/my-assetendpointprofile",
      "name": "my-assetendpointprofile",
      "type": "Microsoft.DeviceRegistry/assetEndpointProfiles",
      "location": "West Europe",
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
      },
      "tags": {
        "site": "building-1"
      },
      "systemData": {
        "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "createdByType": "Application",
        "createdAt": "2022-11-16T00:36:43.2516899Z",
        "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
      },
      "properties": {
        "uuid": "0796f7c1-f2c8-44d7-9f5b-9a6f9522a85d",
        "targetAddress": "https://www.example.com/myTargetAddress",
        "endpointProfileType": "myEndpointProfileType",
        "authentication": {
          "method": "Anonymous"
        },
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/my-assetendpointprofile1",
      "name": "my-assetendpointprofile1",
      "type": "Microsoft.DeviceRegistry/assetEndpointProfiles",
      "location": "West Europe",
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
      },
      "tags": {
        "site": "building-2"
      },
      "systemData": {
        "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "createdByType": "Application",
        "createdAt": "2022-11-16T00:36:43.2516899Z",
        "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
      },
      "properties": {
        "uuid": "7824a74f-21e1-4458-ae06-604d3a241d2c",
        "targetAddress": "https://www.example.com/myTargetAddress1",
        "endpointProfileType": "myEndpointProfileType",
        "authentication": {
          "method": "Certificate",
          "x509Credentials": {
            "certificateSecretName": "certificatRef"
          }
        },
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/my-assetendpointprofile2",
      "name": "my-assetendpointprofile2",
      "type": "Microsoft.DeviceRegistry/assetEndpointProfiles",
      "location": "West Europe",
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
      },
      "tags": {
        "site": "building-2"
      },
      "systemData": {
        "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "createdByType": "Application",
        "createdAt": "2022-11-16T00:36:43.2516899Z",
        "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
      },
      "properties": {
        "uuid": "1824a74f-21e1-4458-ae07-604d3a241d2e",
        "targetAddress": "https://www.example.com/myTargetAddress2",
        "endpointProfileType": "myEndpointProfileType",
        "authentication": {
          "method": "UsernamePassword",
          "usernamePasswordCredentials": {
            "usernameSecretName": "usernameRef",
            "passwordSecretName": "passwordRef"
          }
        },
        "provisioningState": "Succeeded"
      }
    }
  ]
}

定义

名称 说明
AssetEndpointProfile

资产终结点配置文件定义。

AssetEndpointProfileListResult

AssetEndpointProfile 列表操作的响应。

AssetEndpointProfileStatus

定义资产终结点配置文件状态属性。

AssetEndpointProfileStatusError

定义资产终结点配置文件状态错误属性。

Authentication

服务器客户端身份验证机制的定义。

AuthenticationMethod

定义在服务器上对客户端用户进行身份验证的方法。

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ExtendedLocation

扩展位置。

ProvisioningState

资源的预配状态。

systemData

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

UsernamePasswordCredentials

身份验证模式 UsernamePassword 的凭据。

X509Credentials

身份验证模式证书的 x509 证书。

AssetEndpointProfile

资产终结点配置文件定义。

名称 类型 说明
extendedLocation

ExtendedLocation

扩展位置。

id

string (arm-id)

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

location

string

资源所在的地理位置

name

string

资源的名称

properties.additionalConfiguration

string

字符串化 JSON,其中包含特定于连接类型的进一步配置(例如 OPC UA、Modbus、ONVIF)。

properties.authentication

Authentication

定义服务器的客户端身份验证机制。

properties.discoveredAssetEndpointProfileRef

string

对发现的资产终结点配置文件的引用。 仅当资产终结点配置文件是从发现流创建的时才填充的。 必须提供发现的资产终结点配置文件名称。

properties.endpointProfileType

string

定义与终结点配置文件一起使用的连接器类型的配置。

properties.provisioningState

ProvisioningState

资源的预配状态。

properties.status

AssetEndpointProfileStatus

只读对象以反映 Edge 上发生的更改。 类似于自定义资源的 Kubernetes 状态属性。

properties.targetAddress

string (uri)

指定南行设备的网络地址/DNS 名称的本地有效 URI。 targetAddress URI 的方案部分指定设备的类型。 additionalConfiguration 字段包含其他连接器类型特定的配置。

properties.uuid

string

全局唯一、不可变、不可重用的 ID。

systemData

systemData

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

tags

object

资源标记。

type

string

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

AssetEndpointProfileListResult

AssetEndpointProfile 列表操作的响应。

名称 类型 说明
nextLink

string (uri)

指向下一页项的链接

value

AssetEndpointProfile[]

此页面上的 AssetEndpointProfile 项

AssetEndpointProfileStatus

定义资产终结点配置文件状态属性。

名称 类型 说明
errors

AssetEndpointProfileStatusError[]

要传输和保留源自 Edge 的错误的数组对象。

AssetEndpointProfileStatusError

定义资产终结点配置文件状态错误属性。

名称 类型 说明
code

integer (int32)

错误分类的错误代码(例如:400、404、500 等)。

message

string

人为可读有用的错误消息,为错误提供其他上下文(例如:“targetAddress 'foo' 不是有效的 URL” )。

Authentication

服务器客户端身份验证机制的定义。

名称 类型 默认值 说明
method

AuthenticationMethod

Certificate

定义在服务器上对客户端用户进行身份验证的方法。

usernamePasswordCredentials

UsernamePasswordCredentials

选择 UsernamePassword 用户身份验证模式时定义用户名和密码引用。

x509Credentials

X509Credentials

选择证书用户身份验证模式时定义证书引用。

AuthenticationMethod

定义在服务器上对客户端用户进行身份验证的方法。

说明
Anonymous

用户身份验证方法是匿名的。

Certificate

用户身份验证方法是 x509 证书。

UsernamePassword

用户身份验证方法是用户名和密码。

createdByType

创建资源的标识的类型。

说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ExtendedLocation

扩展位置。

名称 类型 说明
name

string

扩展位置名称。

type

string

扩展位置类型。

ProvisioningState

资源的预配状态。

说明
Accepted

服务器已接受资源。

Canceled

资源创建已取消。

Deleting

正在删除资源。

Failed

资源创建失败。

Succeeded

已创建资源。

systemData

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

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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

UsernamePasswordCredentials

身份验证模式 UsernamePassword 的凭据。

名称 类型 说明
passwordSecretName

string

包含密码的机密的名称。

usernameSecretName

string

包含用户名的机密的名称。

X509Credentials

身份验证模式证书的 x509 证书。

名称 类型 说明
certificateSecretName

string

包含证书和私钥的机密的名称(例如存储为 .der/.pem 或 .der/.pfx)。