Microsoft.DataBoxEdge dataBoxEdgeDevices/roles

  • 發行項

Bicep 資源定義

dataBoxEdgeDevices/roles 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2023-12-01' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // For remaining properties, see dataBoxEdgeDevices/roles objects
}

dataBoxEdgeDevices/roles 物件

設定 kind 屬性以指定物件的類型。

針對 CloudEdgeManagement，請使用：

  kind: 'CloudEdgeManagement'
  properties: {
    roleStatus: 'string'
  }

針對 IOT，請使用：

  kind: 'IOT'
  properties: {
    computeResource: {
      memoryInGB: int
      processorCount: int
    }
    hostPlatform: 'string'
    ioTDeviceDetails: {
      authentication: {
        symmetricKey: {
          connectionString: {
            encryptionAlgorithm: 'string'
            encryptionCertThumbprint: 'string'
            value: 'string'
          }
        }
      }
      deviceId: 'string'
      ioTHostHub: 'string'
      ioTHostHubId: 'string'
    }
    ioTEdgeAgentInfo: {
      imageName: 'string'
      imageRepository: {
        imageRepositoryUrl: 'string'
        password: {
          encryptionAlgorithm: 'string'
          encryptionCertThumbprint: 'string'
          value: 'string'
        }
        userName: 'string'
      }
      tag: 'string'
    }
    ioTEdgeDeviceDetails: {
      authentication: {
        symmetricKey: {
          connectionString: {
            encryptionAlgorithm: 'string'
            encryptionCertThumbprint: 'string'
            value: 'string'
          }
        }
      }
      deviceId: 'string'
      ioTHostHub: 'string'
      ioTHostHubId: 'string'
    }
    roleStatus: 'string'
    shareMappings: [
      {
        shareId: 'string'
      }
    ]
  }

針對 Kubernetes，請使用：

  kind: 'Kubernetes'
  properties: {
    hostPlatform: 'string'
    kubernetesClusterInfo: {
      version: 'string'
    }
    kubernetesRoleResources: {
      compute: {
        vmProfile: 'string'
      }
      storage: {
        endpoints: [
          {
            shareId: 'string'
          }
        ]
      }
    }
    roleStatus: 'string'
  }

針對 MEC，請使用：

  kind: 'MEC'
  properties: {
    connectionString: {
      encryptionAlgorithm: 'string'
      encryptionCertThumbprint: 'string'
      value: 'string'
    }
    controllerEndpoint: 'string'
    resourceUniqueId: 'string'
    roleStatus: 'string'
  }

屬性值

dataBoxEdgeDevices/roles

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 字串 (必要)
kind 設定物件類型 CloudEdgeManagement
IOT
Kubernetes
MEC (必要)
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： dataBoxEdgeDevices

CloudEdgeManagementRole

名稱 描述 值
kind 角色類型。 必要 (『CloudEdgeManagement』)
properties CloudEdgeManagementRole 角色特有的屬性。 CloudEdgeManagementRoleProperties

CloudEdgeManagementRoleProperties

名稱 描述 值
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'

IoTRole

名稱 描述 值
kind 角色類型。 需要 『IOT』 ()
properties IoT 角色特有的屬性。 IoTRoleProperties

IoTRoleProperties

名稱 描述 值
computeResource 資源配置 ComputeResource
hostPlatform IoT 角色支援的主機 OS。 'Linux'
'Windows' (必要)
ioTDeviceDetails 需要連接數據箱邊緣裝置的IoT裝置元數據。 IoTDeviceInfo (必要)
ioTEdgeAgentInfo Iot Edge 代理程式詳細數據，可下載代理程式和啟動程式 iot 執行時間。 IoTEdgeAgentInfo
ioTEdgeDeviceDetails 需要設定IoT角色的IoT Edge裝置。 需要 IoTDeviceInfo ()
roleStatus 角色狀態。 'Disabled'
必要 ('Enabled')
shareMappings 角色 () 中的共用裝入點。 MountPointMap[]

ComputeResource

名稱 描述 值
memoryInGB 記憶體 (GB) 需要 int ()
processorCount 處理器計數 需要 int ()

IoTDeviceInfo

名稱 描述 值
驗證 (authentication) 加密的IoT裝置/IoT Edge裝置 連接字串。 驗證
deviceId IoT 裝置/邊緣裝置的標識碼。 需要字串 ()
ioTHostHub 與裝置相關聯的IoT中樞主機名。 需要字串 ()
ioTHostHubId 與裝置相關聯的IoT中樞標識碼。 字串

驗證

名稱 描述 值
symmetricKey 用於驗證的對稱金鑰。 SymmetricKey

SymmetricKey

名稱 描述 值
connectionString 以對稱金鑰為基礎的連接字串。 AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

名稱 描述 值
encryptionAlgorithm 用來加密「值」的演算法。 'AES256'
'None'
'RSAES_PKCS1_v_1_5' (必要)
encryptionCertThumbprint 用來加密「值」的指紋憑證。 如果值未加密，則會是 Null。 字串

約束：
敏感性值。 以安全參數的形式傳入。
值 密碼的值。 需要字串 ()

IoTEdgeAgentInfo

名稱 描述 值
imageName IoT Edge 代理程式映像的名稱。 需要字串 ()
imageRepository 映像存放庫詳細數據。 ImageRepositoryCredential
標籤 影像標籤。 需要字串 ()

ImageRepositoryCredential

名稱 描述 值
imageRepositoryUrl 映像存放庫 URL (例如：mcr.microsoft.com) 。 需要字串 ()
password 存放庫用戶密碼。 AsymmetricEncryptedSecret
userName 存放庫用戶名稱。 需要字串 ()

MountPointMap

名稱 描述 值
shareId 掛接至角色 VM 的共享識別碼。 字串 (必要)

KubernetesRole

名稱 描述 值
kind 角色類型。 必要) 'Kubernetes' (
properties Kubernetes 角色特有的屬性。 KubernetesRoleProperties

KubernetesRoleProperties

名稱 描述 值
hostPlatform Kubernetes 角色支援的主機 OS。 'Linux'
'Windows' (必要)
kubernetesClusterInfo Kubernetes 叢集設定 KubernetesClusterInfo (必要)
kubernetesRoleResources Kubernetes 角色資源 KubernetesRoleResources (必要)
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'

KubernetesClusterInfo

名稱 描述 值
version Kubernetes 叢集版本 字串 (必要)

KubernetesRoleResources

名稱 描述 值
計算 Kubernetes 角色計算資源 KubernetesRoleCompute (必要)
儲存 Kubernetes 角色記憶體資源 KubernetesRoleStorage

KubernetesRoleCompute

名稱 描述 值
vmProfile VM 設定檔 字串 (必要)

KubernetesRoleStorage

名稱 描述 值
端點 角色 () 中的共用裝入點。 MountPointMap[]

MECRole

名稱 描述 值
kind 角色類型。 'MEC' (必要)
properties MEC 角色特有的屬性。 MECRoleProperties

MECRoleProperties

名稱 描述 值
connectionString MEC 的啟用金鑰。 AsymmetricEncryptedSecret
controllerEndpoint 控制器端點。 字串
resourceUniqueId 資源的唯一標識碼。 字串
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'

ARM 範本資源定義

dataBoxEdgeDevices/roles 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles",
  "apiVersion": "2023-12-01",
  "name": "string",
  "kind": "string",
  // For remaining properties, see dataBoxEdgeDevices/roles objects
}

dataBoxEdgeDevices/roles 物件

設定 kind 屬性以指定物件的類型。

針對 CloudEdgeManagement，請使用：

  "kind": "CloudEdgeManagement",
  "properties": {
    "roleStatus": "string"
  }

針對 IOT，請使用：

  "kind": "IOT",
  "properties": {
    "computeResource": {
      "memoryInGB": "int",
      "processorCount": "int"
    },
    "hostPlatform": "string",
    "ioTDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string",
      "ioTHostHubId": "string"
    },
    "ioTEdgeAgentInfo": {
      "imageName": "string",
      "imageRepository": {
        "imageRepositoryUrl": "string",
        "password": {
          "encryptionAlgorithm": "string",
          "encryptionCertThumbprint": "string",
          "value": "string"
        },
        "userName": "string"
      },
      "tag": "string"
    },
    "ioTEdgeDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string",
      "ioTHostHubId": "string"
    },
    "roleStatus": "string",
    "shareMappings": [
      {
        "shareId": "string"
      }
    ]
  }

針對 Kubernetes，請使用：

  "kind": "Kubernetes",
  "properties": {
    "hostPlatform": "string",
    "kubernetesClusterInfo": {
      "version": "string"
    },
    "kubernetesRoleResources": {
      "compute": {
        "vmProfile": "string"
      },
      "storage": {
        "endpoints": [
          {
            "shareId": "string"
          }
        ]
      }
    },
    "roleStatus": "string"
  }

針對 MEC，請使用：

  "kind": "MEC",
  "properties": {
    "connectionString": {
      "encryptionAlgorithm": "string",
      "encryptionCertThumbprint": "string",
      "value": "string"
    },
    "controllerEndpoint": "string",
    "resourceUniqueId": "string",
    "roleStatus": "string"
  }

屬性值

dataBoxEdgeDevices/roles

名稱 描述 值
類型 資源類型 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles'
apiVersion 資源 API 版本 '2023-12-01'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。		 字串 (必要)
kind 設定物件類型 CloudEdgeManagement
IOT
Kubernetes
MEC (必要)

CloudEdgeManagementRole

名稱 描述 值
kind 角色類型。 必要 (『CloudEdgeManagement』)
properties CloudEdgeManagementRole 角色特有的屬性。 CloudEdgeManagementRoleProperties

CloudEdgeManagementRoleProperties

名稱 描述 值
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'

IoTRole

名稱 描述 值
kind 角色類型。 需要 『IOT』 ()
properties IoT 角色特有的屬性。 IoTRoleProperties

IoTRoleProperties

名稱 描述 值
computeResource 資源配置 ComputeResource
hostPlatform IoT 角色支援的主機 OS。 'Linux'
'Windows' (必要)
ioTDeviceDetails 需要連接數據箱邊緣裝置的IoT裝置元數據。 IoTDeviceInfo (必要)
ioTEdgeAgentInfo Iot Edge 代理程式詳細數據，可下載代理程式和啟動程式 iot 執行時間。 IoTEdgeAgentInfo
ioTEdgeDeviceDetails 必須設定IoT角色的IoT Edge裝置。 IoTDeviceInfo (必要)
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'
shareMappings 角色 () 中的共用裝入點。 MountPointMap[]

ComputeResource

名稱 描述 值
memoryInGB 記憶體 (GB) int (必要)
processorCount 處理器計數 int (必要)

IoTDeviceInfo

名稱 描述 值
驗證 (authentication) 加密的IoT裝置/IoT Edge裝置 連接字串。 驗證
deviceId IoT 裝置/邊緣裝置的標識碼。 字串 (必要)
ioTHostHub 與裝置相關聯的IoT中樞主機名。 字串 (必要)
ioTHostHubId 與裝置相關聯的IoT中樞標識碼。 字串

驗證

名稱 描述 值
symmetricKey 用於驗證的對稱金鑰。 SymmetricKey

SymmetricKey

名稱 描述 值
connectionString 以對稱金鑰為基礎的連接字串。 AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

名稱 描述 值
encryptionAlgorithm 用來加密「值」的演算法。 'AES256'
'None'
必要) ('RSAES_PKCS1_v_1_5'
encryptionCertThumbprint 用來加密「值」的指紋憑證。 如果值未加密，則會是 Null。 字串

約束：
敏感性值。 以安全參數的形式傳入。
值 密碼的值。 字串 (必要)

IoTEdgeAgentInfo

名稱 描述 值
imageName IoT Edge 代理程式映像的名稱。 字串 (必要)
imageRepository 映像存放庫詳細數據。 ImageRepositoryCredential
標籤 影像標記。 字串 (必要)

ImageRepositoryCredential

名稱 描述 值
imageRepositoryUrl 映像存放庫 URL (例如：mcr.microsoft.com) 。 字串 (必要)
password 存放庫用戶密碼。 AsymmetricEncryptedSecret
userName 存放庫用戶名稱。 字串 (必要)

MountPointMap

名稱 描述 值
shareId 掛接至角色 VM 的共享識別碼。 字串 (必要)

KubernetesRole

名稱 描述 值
kind 角色類型。 必要) 'Kubernetes' (
properties Kubernetes 角色特有的屬性。 KubernetesRoleProperties

KubernetesRoleProperties

名稱 描述 值
hostPlatform Kubernetes 角色支援的主機 OS。 'Linux'
'Windows' (必要)
kubernetesClusterInfo Kubernetes 叢集設定 KubernetesClusterInfo (必要)
kubernetesRoleResources Kubernetes 角色資源 KubernetesRoleResources (必要)
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'

KubernetesClusterInfo

名稱 描述 值
version Kubernetes 叢集版本 字串 (必要)

KubernetesRoleResources

名稱 描述 值
計算 Kubernetes 角色計算資源 KubernetesRoleCompute (必要)
儲存 Kubernetes 角色記憶體資源 KubernetesRoleStorage

KubernetesRoleCompute

名稱 描述 值
vmProfile VM 設定檔 字串 (必要)

KubernetesRoleStorage

名稱 描述 值
端點 角色 () 中的共用裝入點。 MountPointMap[]

MECRole

名稱 描述 值
kind 角色類型。 'MEC' (必要)
properties MEC 角色特有的屬性。 MECRoleProperties

MECRoleProperties

名稱 描述 值
connectionString MEC 的啟用金鑰。 AsymmetricEncryptedSecret
controllerEndpoint 控制器端點。 字串
resourceUniqueId 資源的唯一標識碼。 字串
roleStatus 角色狀態。 'Disabled'
必要) ('Enabled'

Terraform (AzAPI 提供者) 資源定義

dataBoxEdgeDevices/roles 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2023-12-01"
  name = "string"
  parent_id = "string"
  // For remaining properties, see dataBoxEdgeDevices/roles objects
  body = jsonencode({
    kind = "string"
  })
}

dataBoxEdgeDevices/roles 物件

設定 kind 屬性以指定物件的類型。

針對 CloudEdgeManagement，請使用：

  kind = "CloudEdgeManagement"
  properties = {
    roleStatus = "string"
  }

針對 IOT，請使用：

  kind = "IOT"
  properties = {
    computeResource = {
      memoryInGB = int
      processorCount = int
    }
    hostPlatform = "string"
    ioTDeviceDetails = {
      authentication = {
        symmetricKey = {
          connectionString = {
            encryptionAlgorithm = "string"
            encryptionCertThumbprint = "string"
            value = "string"
          }
        }
      }
      deviceId = "string"
      ioTHostHub = "string"
      ioTHostHubId = "string"
    }
    ioTEdgeAgentInfo = {
      imageName = "string"
      imageRepository = {
        imageRepositoryUrl = "string"
        password = {
          encryptionAlgorithm = "string"
          encryptionCertThumbprint = "string"
          value = "string"
        }
        userName = "string"
      }
      tag = "string"
    }
    ioTEdgeDeviceDetails = {
      authentication = {
        symmetricKey = {
          connectionString = {
            encryptionAlgorithm = "string"
            encryptionCertThumbprint = "string"
            value = "string"
          }
        }
      }
      deviceId = "string"
      ioTHostHub = "string"
      ioTHostHubId = "string"
    }
    roleStatus = "string"
    shareMappings = [
      {
        shareId = "string"
      }
    ]
  }

針對 Kubernetes，請使用：

  kind = "Kubernetes"
  properties = {
    hostPlatform = "string"
    kubernetesClusterInfo = {
      version = "string"
    }
    kubernetesRoleResources = {
      compute = {
        vmProfile = "string"
      }
      storage = {
        endpoints = [
          {
            shareId = "string"
          }
        ]
      }
    }
    roleStatus = "string"
  }

針對 MEC，請使用：

  kind = "MEC"
  properties = {
    connectionString = {
      encryptionAlgorithm = "string"
      encryptionCertThumbprint = "string"
      value = "string"
    }
    controllerEndpoint = "string"
    resourceUniqueId = "string"
    roleStatus = "string"
  }

屬性值

dataBoxEdgeDevices/roles

名稱 描述 值
類型 資源類型 “Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2023-12-01”
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼： dataBoxEdgeDevices
kind 設定物件類型 CloudEdgeManagement
IOT
Kubernetes
MEC (必要)

CloudEdgeManagementRole

名稱 描述 值
kind 角色類型。 “CloudEdgeManagement” (必要)
properties CloudEdgeManagementRole 角色特有的屬性。 CloudEdgeManagementRoleProperties

CloudEdgeManagementRoleProperties

名稱 描述 值
roleStatus 角色狀態。 “Disabled”
「已啟用」 (必要)

IoTRole

名稱 描述 值
kind 角色類型。 “IOT” (必要)
properties IoT 角色特有的屬性。 IoTRoleProperties

IoTRoleProperties

名稱 描述 值
computeResource 資源配置 ComputeResource
hostPlatform IoT 角色支援的主機 OS。 "Linux"
“Windows” (必要)
ioTDeviceDetails 需要連接數據箱邊緣裝置的IoT裝置元數據。 需要 IoTDeviceInfo ()
ioTEdgeAgentInfo 要下載代理程式和啟動程式 iot 執行時間的 Iot Edge 代理程式詳細數據。 IoTEdgeAgentInfo
ioTEdgeDeviceDetails 需要設定IoT角色的IoT Edge裝置。 需要 IoTDeviceInfo ()
roleStatus 角色狀態。 “Disabled”
「已啟用」 (必要)
shareMappings 角色 () 中的共用裝入點。 MountPointMap[]

ComputeResource

名稱 描述 值
memoryInGB 記憶體 (GB) 需要 int ()
processorCount 處理器計數 需要 int ()

IoTDeviceInfo

名稱 描述 值
驗證 (authentication) 加密的IoT裝置/IoT Edge裝置 連接字串。 驗證
deviceId IoT 裝置/邊緣裝置的標識碼。 需要字串 ()
ioTHostHub 與裝置相關聯的IoT中樞主機名。 需要字串 ()
ioTHostHubId 與裝置相關聯的IoT中樞標識碼。 字串

驗證

名稱 描述 值
symmetricKey 用於驗證的對稱金鑰。 SymmetricKey

SymmetricKey

名稱 描述 值
connectionString 以對稱金鑰為基礎的連接字串。 AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

名稱 描述 值
encryptionAlgorithm 用來加密「值」的演算法。 “AES256”
"None"
“RSAES_PKCS1_v_1_5” (必要)
encryptionCertThumbprint 用來加密「值」的指紋憑證。 如果值未加密，則會是 Null。 字串

約束：
敏感性值。 以安全參數的形式傳入。
值 密碼的值。 需要字串 ()

IoTEdgeAgentInfo

名稱 描述 值
imageName IoT Edge 代理程式映像的名稱。 需要字串 ()
imageRepository 映像存放庫詳細數據。 ImageRepositoryCredential
標籤 影像標籤。 需要字串 ()

ImageRepositoryCredential

名稱 描述 值
imageRepositoryUrl 映像存放庫 URL (例如：mcr.microsoft.com) 。 需要字串 ()
password 存放庫用戶密碼。 AsymmetricEncryptedSecret
userName 存放庫用戶名稱。 需要字串 ()

MountPointMap

名稱 描述 值
shareId 掛接至角色 VM 的共享識別碼。 需要字串 ()

KubernetesRole

名稱 描述 值
kind 角色類型。 “Kubernetes” (必要)
properties Kubernetes 角色特有的屬性。 KubernetesRoleProperties

KubernetesRoleProperties

名稱 描述 值
hostPlatform Kubernetes 角色支援的主機 OS。 "Linux"
“Windows” (必要)
kubernetesClusterInfo Kubernetes 叢集設定 KubernetesClusterInfo (必要)
kubernetesRoleResources Kubernetes 角色資源 KubernetesRoleResources (必要)
roleStatus 角色狀態。 “Disabled”
「已啟用」 (必要)

KubernetesClusterInfo

名稱 描述 值
version Kubernetes 叢集版本 需要字串 ()

KubernetesRoleResources

名稱 描述 值
計算 Kubernetes 角色計算資源 KubernetesRoleCompute (必要)
儲存 Kubernetes 角色記憶體資源 KubernetesRoleStorage

KubernetesRoleCompute

名稱 描述 值
vmProfile VM 設定檔 需要字串 ()

KubernetesRoleStorage

名稱 描述 值
端點 角色 () 中的共用裝入點。 MountPointMap[]

MECRole

名稱 描述 值
kind 角色類型。 “MEC” (必要)
properties MEC 角色特有的屬性。 MECRoleProperties

MECRoleProperties

名稱 描述 值
connectionString MEC 的啟用金鑰。 AsymmetricEncryptedSecret
controllerEndpoint 控制器端點。 字串
resourceUniqueId 資源的唯一標識碼。 字串
roleStatus 角色狀態。 “Disabled”
「已啟用」 (必要)