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

Discovered Asset Endpoint Profiles - Create Or Replace

参考

服务:: Device Registry

API 版本:: 2024-09-01-preview

创建 DiscoveredAssetEndpointProfile

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles/{discoveredAssetEndpointProfileName}?api-version=2024-09-01-preview

URI 参数

名称	在	必需	类型	说明
discoveredAssetEndpointProfileName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	发现的资产终结点配置文件名称参数。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
extendedLocation	True	ExtendedLocation	扩展位置。
location	True	string	资源所在的地理位置
properties.discoveryId	True	string	用于检测资产终结点配置文件中的更改的标识符。
properties.endpointProfileType	True	string	定义与终结点配置文件一起使用的连接器类型的配置。
properties.targetAddress	True	string (uri)	指定南行设备的网络地址/DNS 名称的本地有效 URI。 targetAddress URI 的方案部分指定设备的类型。 additionalConfiguration 字段包含其他连接器类型特定的配置。
properties.version	True	integer (int64)	每次修改资源时递增的整数。
properties.additionalConfiguration		string	字符串化 JSON，其中包含特定于连接类型的进一步配置（例如 OPC UA、Modbus、ONVIF）。
properties.supportedAuthenticationMethods		AuthenticationMethod[]	目标服务器支持的身份验证方法列表。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	DiscoveredAssetEndpointProfile	资源“DiscoveredAssetEndpointProfile”更新操作成功
201 Created	DiscoveredAssetEndpointProfile	资源“DiscoveredAssetEndpointProfile”创建操作成功标头 Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

名称

类型

说明

200 OK

DiscoveredAssetEndpointProfile

资源“DiscoveredAssetEndpointProfile”更新操作成功

201 Created

DiscoveredAssetEndpointProfile

资源“DiscoveredAssetEndpointProfile”创建操作成功

标头

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create_DiscoveredAssetEndpointProfile

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles/my-discoveredassetendpointprofile?api-version=2024-09-01-preview

{
  "location": "West Europe",
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
  },
  "tags": {
    "site": "building-1"
  },
  "properties": {
    "targetAddress": "https://www.example.com/myTargetAddress",
    "additionalConfiguration": "{\"foo\": \"bar\"}",
    "discoveryId": "11111111-1111-1111-1111-111111111111",
    "version": 73766,
    "endpointProfileType": "myEndpointProfileType",
    "supportedAuthenticationMethods": [
      "Anonymous",
      "Certificate",
      "UsernamePassword"
    ]
  }
}


import com.azure.resourcemanager.deviceregistry.models.AuthenticationMethod;
import com.azure.resourcemanager.deviceregistry.models.DiscoveredAssetEndpointProfileProperties;
import com.azure.resourcemanager.deviceregistry.models.ExtendedLocation;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DiscoveredAssetEndpointProfiles CreateOrReplace.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-09-01-preview/Create_DiscoveredAssetEndpointProfile.json
     */
    /**
     * Sample code: Create_DiscoveredAssetEndpointProfile.
     * 
     * @param manager Entry point to DeviceRegistryManager.
     */
    public static void
        createDiscoveredAssetEndpointProfile(com.azure.resourcemanager.deviceregistry.DeviceRegistryManager manager) {
        manager.discoveredAssetEndpointProfiles().define("my-discoveredassetendpointprofile").withRegion("West Europe")
            .withExistingResourceGroup("myResourceGroup")
            .withExtendedLocation(new ExtendedLocation().withType("CustomLocation").withName(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"))
            .withTags(mapOf("site", "building-1"))
            .withProperties(new DiscoveredAssetEndpointProfileProperties()
                .withTargetAddress("https://www.example.com/myTargetAddress")
                .withAdditionalConfiguration("{\"foo\": \"bar\"}")
                .withSupportedAuthenticationMethods(Arrays.asList(AuthenticationMethod.ANONYMOUS,
                    AuthenticationMethod.CERTIFICATE, AuthenticationMethod.USERNAME_PASSWORD))
                .withEndpointProfileType("myEndpointProfileType")
                .withDiscoveryId("11111111-1111-1111-1111-111111111111").withVersion(73766L))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.deviceregistry import DeviceRegistryMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-deviceregistry
# USAGE
    python create_discovered_asset_endpoint_profile.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeviceRegistryMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.discovered_asset_endpoint_profiles.begin_create_or_replace(
        resource_group_name="myResourceGroup",
        discovered_asset_endpoint_profile_name="my-discoveredassetendpointprofile",
        resource={
            "extendedLocation": {
                "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
                "type": "CustomLocation",
            },
            "location": "West Europe",
            "properties": {
                "additionalConfiguration": '{"foo": "bar"}',
                "discoveryId": "11111111-1111-1111-1111-111111111111",
                "endpointProfileType": "myEndpointProfileType",
                "supportedAuthenticationMethods": ["Anonymous", "Certificate", "UsernamePassword"],
                "targetAddress": "https://www.example.com/myTargetAddress",
                "version": 73766,
            },
            "tags": {"site": "building-1"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2024-09-01-preview/Create_DiscoveredAssetEndpointProfile.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeviceRegistryManagementClient } = require("@azure/arm-deviceregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a DiscoveredAssetEndpointProfile
 *
 * @summary create a DiscoveredAssetEndpointProfile
 * x-ms-original-file: 2024-09-01-preview/Create_DiscoveredAssetEndpointProfile.json
 */
async function createDiscoveredAssetEndpointProfile() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new DeviceRegistryManagementClient(credential, subscriptionId);
  const result = await client.discoveredAssetEndpointProfiles.createOrReplace(
    "myResourceGroup",
    "my-discoveredassetendpointprofile",
    {
      location: "West Europe",
      extendedLocation: {
        type: "CustomLocation",
        name: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1",
      },
      tags: { site: "building-1" },
      properties: {
        targetAddress: "https://www.example.com/myTargetAddress",
        additionalConfiguration: '{"foo": "bar"}',
        discoveryId: "11111111-1111-1111-1111-111111111111",
        version: 73766,
        endpointProfileType: "myEndpointProfileType",
        supportedAuthenticationMethods: ["Anonymous", "Certificate", "UsernamePassword"],
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DeviceRegistry.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DeviceRegistry;

// Generated from example definition: 2024-09-01-preview/Create_DiscoveredAssetEndpointProfile.json
// this example is just showing the usage of "DiscoveredAssetEndpointProfile_CreateOrReplace" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DeviceRegistryDiscoveredAssetEndpointProfileResource
DeviceRegistryDiscoveredAssetEndpointProfileCollection collection = resourceGroupResource.GetDeviceRegistryDiscoveredAssetEndpointProfiles();

// invoke the operation
string discoveredAssetEndpointProfileName = "my-discoveredassetendpointprofile";
DeviceRegistryDiscoveredAssetEndpointProfileData data = new DeviceRegistryDiscoveredAssetEndpointProfileData(new AzureLocation("West Europe"), new DeviceRegistryExtendedLocation("CustomLocation", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"))
{
    Properties = new DiscoveredAssetEndpointProfileProperties(new Uri("https://www.example.com/myTargetAddress"), "myEndpointProfileType", "11111111-1111-1111-1111-111111111111", 73766L)
    {
        AdditionalConfiguration = "{\"foo\": \"bar\"}",
        SupportedAuthenticationMethods = { AuthenticationMethod.Anonymous, AuthenticationMethod.Certificate, AuthenticationMethod.UsernamePassword },
    },
    Tags =
    {
    ["site"] = "building-1"
    },
};
ArmOperation<DeviceRegistryDiscoveredAssetEndpointProfileResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, discoveredAssetEndpointProfileName, data);
DeviceRegistryDiscoveredAssetEndpointProfileResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DeviceRegistryDiscoveredAssetEndpointProfileData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles/my-discoveredassetendpointprofile",
  "name": "my-assetendpointprofile",
  "type": "Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles",
  "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": {
    "targetAddress": "https://www.example.com/myTargetAddress",
    "additionalConfiguration": "{\"foo\": \"bar\"}",
    "discoveryId": "11111111-1111-1111-1111-111111111111",
    "version": 73766,
    "endpointProfileType": "myEndpointProfileType",
    "supportedAuthenticationMethods": [
      "Anonymous",
      "Certificate",
      "UsernamePassword"
    ],
    "provisioningState": "Succeeded"
  }
}

状态代码:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles/my-discoveredassetendpointprofile",
  "name": "my-assetendpointprofile",
  "type": "Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles",
  "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": {
    "targetAddress": "https://www.example.com/myTargetAddress",
    "additionalConfiguration": "{\"foo\": \"bar\"}",
    "discoveryId": "11111111-1111-1111-1111-111111111111",
    "version": 73766,
    "endpointProfileType": "myEndpointProfileType",
    "supportedAuthenticationMethods": [
      "Anonymous",
      "Certificate",
      "UsernamePassword"
    ],
    "provisioningState": "Accepted"
  }
}

定义

名称	说明
AuthenticationMethod	在服务器上对客户端的用户进行身份验证的方法。
createdByType	创建资源的标识的类型。
DiscoveredAssetEndpointProfile	已发现资产终结点配置文件定义。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedLocation	扩展位置。
ProvisioningState	资源的预配状态。
systemData	与创建和上次修改资源相关的元数据。

AuthenticationMethod

枚举

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

值	说明
Anonymous	用户身份验证方法是匿名的。
Certificate	用户身份验证方法是 x509 证书。
UsernamePassword	用户身份验证方法是用户名和密码。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User