Поделиться через


Asset Endpoint Profiles - List By Resource Group

Перечисление ресурсов AssetEndpointProfile по группе ресурсов

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles?api-version=2026-04-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не зависит от регистра.

subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

AssetEndpointProfileListResult

Операция Azure успешно завершена.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

List_AssetEndpointProfiles_ByResourceGroup

Образец запроса

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/assetEndpointProfiles?api-version=2026-04-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)

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса

properties.additionalConfiguration

string

Stringified JSON, содержащий тип подключения, конкретную дополнительную конфигурацию (например, OPC UA, Modbus, ONVIF).

properties.authentication

Authentication

Определяет механизм проверки подлинности клиента на сервере.

properties.discoveredAssetEndpointProfileRef

string

Ссылка на обнаруженный профиль конечной точки ресурса. Заполнено только в том случае, если профиль конечной точки ресурса был создан из потока обнаружения. Необходимо указать имя профиля конечной точки обнаруженного ресурса.

properties.endpointProfileType

string

Определяет конфигурацию для типа соединителя, используемого с профилем конечной точки.

properties.provisioningState

ProvisioningState

Состояние подготовки ресурса.

properties.status

AssetEndpointProfileStatus

Объект только для чтения для отражения изменений, произошедших на Edge. Аналогично свойству status Kubernetes для пользовательских ресурсов.

properties.targetAddress

string (uri)

Локальный допустимый URI, указывающий сетевой адрес или DNS-имя южного устройства. Часть схемы URI targetAddress указывает тип устройства. Поле дополнительные конфигурации конфигурации соединителя содержат дополнительную конфигурацию типа соединителя.

properties.uuid

string

Глобально уникальный, неизменяемый, не подлежащий повторному использованию id.

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AssetEndpointProfileListResult

Ответ операции со списком AssetEndpointProfile.

Имя Тип Описание
nextLink

string (uri)

Ссылка на следующую страницу элементов

value

AssetEndpointProfile[]

Элементы AssetEndpointProfile на этой странице

AssetEndpointProfileStatus

Определяет свойства состояния профиля конечной точки ресурса.

Имя Тип Описание
errors

AssetEndpointProfileStatusError[]

Array для передачи и сохранения ошибок, исходящих от Edge.

AssetEndpointProfileStatusError

Определяет свойства ошибки состояния профиля конечной точки ресурса.

Имя Тип Описание
code

integer (int32)

Код ошибки для классификации ошибок (например: 400, 404, 500 и т. д.).

message

string

Удобочитаемое полезное сообщение об ошибке для предоставления дополнительного контекста для ошибки (например: "targetAddress 'foo' is not a valid url").

Authentication

Определение механизма проверки подлинности клиента на сервере.

Имя Тип Default value Описание
method

AuthenticationMethod

Certificate

Определяет метод проверки подлинности пользователя клиента на сервере.

usernamePasswordCredentials

UsernamePasswordCredentials

Определяет ссылки на имя пользователя и пароль при выборе режима проверки подлинности пользователя UsernamePassword.

x509Credentials

X509Credentials

Определяет ссылку на сертификат при выборе режима проверки подлинности пользователя сертификата.

AuthenticationMethod

Метод проверки подлинности пользователя клиента на сервере.

Значение Описание
Anonymous

Метод аутентификации пользователя является анонимным.

Certificate

Метод аутентификации пользователя — сертификат x509.

UsernamePassword

Методом аутентификации пользователя является имя пользователя и пароль.

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

Расширенное расположение.

Имя Тип Описание
name

string

Имя расширенного расположения.

type

string

Тип расширенного расположения.

ProvisioningState

Состояние подготовки ресурса.

Значение Описание
Succeeded

Ресурс создан.

Failed

Не удалось создать ресурс.

Canceled

Создание ресурсов было отменено.

Accepted

Ресурс принят сервером.

Deleting

Ресурс удаляется.

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).