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

Microsoft.DeviceRegistry assetEndpointProfiles 2024-09-01-预览版

Bicep 资源定义

assetEndpointProfiles 资源类型可以使用目标操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DeviceRegistry/assetEndpointProfiles 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DeviceRegistry/assetEndpointProfiles@2024-09-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalConfiguration: 'string'
    authentication: {
      method: 'string'
      usernamePasswordCredentials: {
        passwordSecretName: 'string'
        usernameSecretName: 'string'
      }
      x509Credentials: {
        certificateSecretName: 'string'
      }
    }
    discoveredAssetEndpointProfileRef: 'string'
    endpointProfileType: 'string'
    targetAddress: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.DeviceRegistry/assetEndpointProfiles

名字 描述 价值
extendedLocation 扩展位置。 ExtendedLocation (必需)
位置 资源所在的地理位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 63
模式 = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (必需)
性能 此资源的资源特定属性。 AssetEndpointProfileProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

AssetEndpointProfileProperties

名字 描述 价值
additionalConfiguration 字符串化 JSON,其中包含特定于连接类型的进一步配置(例如 OPC UA、Modbus、ONVIF)。 字符串
认证 定义服务器的客户端身份验证机制。 身份验证
发现 AssetEndpointProfileRef 对发现的资产终结点配置文件的引用。 仅当资产终结点配置文件是从发现流创建的时才填充的。 必须提供发现的资产终结点配置文件名称。 字符串
endpointProfileType 定义与终结点配置文件一起使用的连接器类型的配置。 string (必需)
目标地址 指定南行设备的网络地址/DNS 名称的本地有效 URI。 targetAddress URI 的方案部分指定设备的类型。 additionalConfiguration 字段包含其他连接器类型特定的配置。 string (必需)

认证

名字 描述 价值
方法 定义在服务器上对客户端用户进行身份验证的方法。 “Anonymous”
“Certificate”
“UsernamePassword”(必需)
usernamePasswordCredentials 选择 UsernamePassword 用户身份验证模式时定义用户名和密码引用。 UsernamePasswordCredentials
x509凭证 选择证书用户身份验证模式时定义证书引用。 X509凭证

扩展位置

名字 描述 价值
名字 扩展位置名称。 string (必需)
类型 扩展位置类型。 string (必需)

TrackedResourceTags

名字 描述 价值

UsernamePasswordCredentials

名字 描述 价值
密码秘密名称 包含密码的机密的名称。 string (必需)
用户名SecretName 包含用户名的机密的名称。 string (必需)

X509凭证

名字 描述 价值
certificateSecretName 证书 包含证书和私钥的机密的名称(例如存储为 .der/.pem 或 .der/.pfx)。 string (必需)

ARM 模板资源定义

assetEndpointProfiles 资源类型可以使用目标操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DeviceRegistry/assetEndpointProfiles 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DeviceRegistry/assetEndpointProfiles",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "additionalConfiguration": "string",
    "authentication": {
      "method": "string",
      "usernamePasswordCredentials": {
        "passwordSecretName": "string",
        "usernameSecretName": "string"
      },
      "x509Credentials": {
        "certificateSecretName": "string"
      }
    },
    "discoveredAssetEndpointProfileRef": "string",
    "endpointProfileType": "string",
    "targetAddress": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.DeviceRegistry/assetEndpointProfiles

名字 描述 价值
apiVersion API 版本 “2024-09-01-预览”
extendedLocation 扩展位置。 ExtendedLocation (必需)
位置 资源所在的地理位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 63
模式 = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (必需)
性能 此资源的资源特定属性。 AssetEndpointProfileProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.DeviceRegistry/assetEndpointProfiles”

AssetEndpointProfileProperties

名字 描述 价值
additionalConfiguration 字符串化 JSON,其中包含特定于连接类型的进一步配置(例如 OPC UA、Modbus、ONVIF)。 字符串
认证 定义服务器的客户端身份验证机制。 身份验证
发现 AssetEndpointProfileRef 对发现的资产终结点配置文件的引用。 仅当资产终结点配置文件是从发现流创建的时才填充的。 必须提供发现的资产终结点配置文件名称。 字符串
endpointProfileType 定义与终结点配置文件一起使用的连接器类型的配置。 string (必需)
目标地址 指定南行设备的网络地址/DNS 名称的本地有效 URI。 targetAddress URI 的方案部分指定设备的类型。 additionalConfiguration 字段包含其他连接器类型特定的配置。 string (必需)

认证

名字 描述 价值
方法 定义在服务器上对客户端用户进行身份验证的方法。 “Anonymous”
“Certificate”
“UsernamePassword”(必需)
usernamePasswordCredentials 选择 UsernamePassword 用户身份验证模式时定义用户名和密码引用。 UsernamePasswordCredentials
x509凭证 选择证书用户身份验证模式时定义证书引用。 X509凭证

扩展位置

名字 描述 价值
名字 扩展位置名称。 string (必需)
类型 扩展位置类型。 string (必需)

TrackedResourceTags

名字 描述 价值

UsernamePasswordCredentials

名字 描述 价值
密码秘密名称 包含密码的机密的名称。 string (必需)
用户名SecretName 包含用户名的机密的名称。 string (必需)

X509凭证

名字 描述 价值
certificateSecretName 证书 包含证书和私钥的机密的名称(例如存储为 .der/.pem 或 .der/.pfx)。 string (必需)

用法示例

Terraform (AzAPI 提供程序)资源定义

assetEndpointProfiles 资源类型可以使用目标操作进行部署:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DeviceRegistry/assetEndpointProfiles 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceRegistry/assetEndpointProfiles@2024-09-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      additionalConfiguration = "string"
      authentication = {
        method = "string"
        usernamePasswordCredentials = {
          passwordSecretName = "string"
          usernameSecretName = "string"
        }
        x509Credentials = {
          certificateSecretName = "string"
        }
      }
      discoveredAssetEndpointProfileRef = "string"
      endpointProfileType = "string"
      targetAddress = "string"
    }
  }
}

属性值

Microsoft.DeviceRegistry/assetEndpointProfiles

名字 描述 价值
extendedLocation 扩展位置。 ExtendedLocation (必需)
位置 资源所在的地理位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 63
模式 = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (必需)
性能 此资源的资源特定属性。 AssetEndpointProfileProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DeviceRegistry/assetEndpointProfiles@2024-09-01-preview”

AssetEndpointProfileProperties

名字 描述 价值
additionalConfiguration 字符串化 JSON,其中包含特定于连接类型的进一步配置(例如 OPC UA、Modbus、ONVIF)。 字符串
认证 定义服务器的客户端身份验证机制。 身份验证
发现 AssetEndpointProfileRef 对发现的资产终结点配置文件的引用。 仅当资产终结点配置文件是从发现流创建的时才填充的。 必须提供发现的资产终结点配置文件名称。 字符串
endpointProfileType 定义与终结点配置文件一起使用的连接器类型的配置。 string (必需)
目标地址 指定南行设备的网络地址/DNS 名称的本地有效 URI。 targetAddress URI 的方案部分指定设备的类型。 additionalConfiguration 字段包含其他连接器类型特定的配置。 string (必需)

认证

名字 描述 价值
方法 定义在服务器上对客户端用户进行身份验证的方法。 “Anonymous”
“Certificate”
“UsernamePassword”(必需)
usernamePasswordCredentials 选择 UsernamePassword 用户身份验证模式时定义用户名和密码引用。 UsernamePasswordCredentials
x509凭证 选择证书用户身份验证模式时定义证书引用。 X509凭证

扩展位置

名字 描述 价值
名字 扩展位置名称。 string (必需)
类型 扩展位置类型。 string (必需)

TrackedResourceTags

名字 描述 价值

UsernamePasswordCredentials

名字 描述 价值
密码秘密名称 包含密码的机密的名称。 string (必需)
用户名SecretName 包含用户名的机密的名称。 string (必需)

X509凭证

名字 描述 价值
certificateSecretName 证书 包含证书和私钥的机密的名称(例如存储为 .der/.pem 或 .der/.pfx)。 string (必需)