Microsoft.DataBoxEdge dataBoxEdgeDevices/roles 2019-08-01
Bicep 資源定義
dataBoxEdgeDevices/roles 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄。
資源格式
若要建立 Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles 資源,請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-08-01' = {
name: 'string'
kind: 'string'
parent: resourceSymbolicName
// For remaining properties, see dataBoxEdgeDevices/roles objects
}
dataBoxEdgeDevices/roles 物件
設定 kind 屬性以指定物件的類型。
針對 IOT,請使用:
kind: 'IOT'
properties: {
hostPlatform: 'string'
ioTDeviceDetails: {
authentication: {
symmetricKey: {
connectionString: {
encryptionAlgorithm: 'string'
encryptionCertThumbprint: 'string'
value: 'string'
}
}
}
deviceId: 'string'
ioTHostHub: 'string'
ioTHostHubId: 'string'
}
ioTEdgeDeviceDetails: {
authentication: {
symmetricKey: {
connectionString: {
encryptionAlgorithm: 'string'
encryptionCertThumbprint: 'string'
value: 'string'
}
}
}
deviceId: 'string'
ioTHostHub: 'string'
ioTHostHubId: 'string'
}
roleStatus: 'string'
shareMappings: [
{
shareId: 'string'
}
]
}
屬性值
dataBoxEdgeDevices/roles
名稱 | 描述 | 值 |
---|---|---|
NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
字串 (必要) |
kind | 設定物件類型 | 需要 IOT () |
父系 (parent) | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源之外宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型資源的符號名稱: dataBoxEdgeDevices |
IoTRole
名稱 | 描述 | 值 |
---|---|---|
kind | 角色類型。 | 需要 『IOT』 () |
properties | IoT 角色特有的屬性。 | IoTRoleProperties |
IoTRoleProperties
名稱 | 描述 | 值 |
---|---|---|
hostPlatform | IoT 角色支援的主機 OS。 | 'Linux' 'Windows' (必要) |
ioTDeviceDetails | 需要連接數據箱邊緣裝置的IoT裝置元數據。 | IoTDeviceInfo (必要) |
ioTEdgeDeviceDetails | 必須設定IoT角色的IoT Edge裝置。 | IoTDeviceInfo (必要) |
roleStatus | 角色狀態。 | 'Disabled' 必要) ('Enabled' |
shareMappings | 角色 () 中的共用裝入點。 | MountPointMap[] |
IoTDeviceInfo
名稱 | 描述 | 值 |
---|---|---|
驗證 (authentication) | IoT 裝置驗證資訊。 | 驗證 |
deviceId | IoT 裝置/邊緣裝置的標識碼。 | 字串 (必要) |
ioTHostHub | 與裝置相關聯的IoT中樞主機名。 | 字串 (必要) |
ioTHostHubId | 與裝置相關聯的IoT中樞標識碼。 | 字串 |
驗證
名稱 | 描述 | 值 |
---|---|---|
symmetricKey | 用於驗證的對稱金鑰。 | SymmetricKey |
SymmetricKey
名稱 | 描述 | 值 |
---|---|---|
connectionString | 以對稱金鑰為基礎的連接字串。 | AsymmetricEncryptedSecret |
AsymmetricEncryptedSecret
名稱 | 描述 | 值 |
---|---|---|
encryptionAlgorithm | 用來加密「值」的演算法。 | 'AES256' 'None' 必要) ('RSAES_PKCS1_v_1_5' |
encryptionCertThumbprint | 用來加密「值」的指紋憑證。 如果值未加密,則會是 Null。 | 字串 |
value | 密碼的值。 | 字串 (必要) |
MountPointMap
名稱 | 描述 | 值 |
---|---|---|
shareId | 掛接至角色 VM 的共享識別碼。 | 字串 (必要) |
ARM 範本資源定義
dataBoxEdgeDevices/roles 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄。
資源格式
若要建立 Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles 資源,請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles",
"apiVersion": "2019-08-01",
"name": "string",
"kind": "string",
// For remaining properties, see dataBoxEdgeDevices/roles objects
}
dataBoxEdgeDevices/roles 物件
設定 kind 屬性以指定物件的類型。
針對 IOT,請使用:
"kind": "IOT",
"properties": {
"hostPlatform": "string",
"ioTDeviceDetails": {
"authentication": {
"symmetricKey": {
"connectionString": {
"encryptionAlgorithm": "string",
"encryptionCertThumbprint": "string",
"value": "string"
}
}
},
"deviceId": "string",
"ioTHostHub": "string",
"ioTHostHubId": "string"
},
"ioTEdgeDeviceDetails": {
"authentication": {
"symmetricKey": {
"connectionString": {
"encryptionAlgorithm": "string",
"encryptionCertThumbprint": "string",
"value": "string"
}
}
},
"deviceId": "string",
"ioTHostHub": "string",
"ioTHostHubId": "string"
},
"roleStatus": "string",
"shareMappings": [
{
"shareId": "string"
}
]
}
屬性值
dataBoxEdgeDevices/roles
名稱 | 描述 | 值 |
---|---|---|
類型 | 資源類型 | 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles' |
apiVersion | 資源 API 版本 | '2019-08-01' |
NAME | 資源名稱 請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。 |
字串 (必要) |
kind | 設定物件類型 | 需要 IOT () |
IoTRole
名稱 | 描述 | 值 |
---|---|---|
kind | 角色類型。 | 需要 『IOT』 () |
properties | IoT 角色特有的屬性。 | IoTRoleProperties |
IoTRoleProperties
名稱 | 描述 | 值 |
---|---|---|
hostPlatform | IoT 角色支援的主機 OS。 | 'Linux' 'Windows' (必要) |
ioTDeviceDetails | 需要連接數據箱邊緣裝置的IoT裝置元數據。 | IoTDeviceInfo (必要) |
ioTEdgeDeviceDetails | 必須設定IoT角色的IoT Edge裝置。 | IoTDeviceInfo (必要) |
roleStatus | 角色狀態。 | 'Disabled' 必要) ('Enabled' |
shareMappings | 角色 () 中的共用裝入點。 | MountPointMap[] |
IoTDeviceInfo
名稱 | 描述 | 值 |
---|---|---|
驗證 (authentication) | IoT 裝置驗證資訊。 | 驗證 |
deviceId | IoT 裝置/邊緣裝置的標識碼。 | 字串 (必要) |
ioTHostHub | 與裝置相關聯的IoT中樞主機名。 | 需要字串 () |
ioTHostHubId | 與裝置相關聯的IoT中樞標識碼。 | 字串 |
驗證
名稱 | 描述 | 值 |
---|---|---|
symmetricKey | 用於驗證的對稱金鑰。 | SymmetricKey |
SymmetricKey
名稱 | 描述 | 值 |
---|---|---|
connectionString | 以對稱金鑰為基礎的連接字串。 | AsymmetricEncryptedSecret |
AsymmetricEncryptedSecret
名稱 | 描述 | 值 |
---|---|---|
encryptionAlgorithm | 用來加密「值」的演算法。 | 'AES256' 'None' 'RSAES_PKCS1_v_1_5' (必要) |
encryptionCertThumbprint | 用來加密「值」的指紋憑證。 如果值未加密,則會是 Null。 | 字串 |
value | 密碼的值。 | 需要字串 () |
MountPointMap
名稱 | 描述 | 值 |
---|---|---|
shareId | 掛接至角色 VM 的共享識別碼。 | 需要字串 () |
Terraform (AzAPI 提供者) 資源定義
dataBoxEdgeDevices/roles 資源類型可以使用目標作業來部署:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-08-01"
name = "string"
parent_id = "string"
// For remaining properties, see dataBoxEdgeDevices/roles objects
body = jsonencode({
kind = "string"
})
}
dataBoxEdgeDevices/roles 物件
設定 kind 屬性以指定物件的類型。
針對 IOT,請使用:
kind = "IOT"
properties = {
hostPlatform = "string"
ioTDeviceDetails = {
authentication = {
symmetricKey = {
connectionString = {
encryptionAlgorithm = "string"
encryptionCertThumbprint = "string"
value = "string"
}
}
}
deviceId = "string"
ioTHostHub = "string"
ioTHostHubId = "string"
}
ioTEdgeDeviceDetails = {
authentication = {
symmetricKey = {
connectionString = {
encryptionAlgorithm = "string"
encryptionCertThumbprint = "string"
value = "string"
}
}
}
deviceId = "string"
ioTHostHub = "string"
ioTHostHubId = "string"
}
roleStatus = "string"
shareMappings = [
{
shareId = "string"
}
]
}
屬性值
dataBoxEdgeDevices/roles
名稱 | 描述 | 值 |
---|---|---|
類型 | 資源類型 | “Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-08-01” |
NAME | 資源名稱 | 需要字串 () |
parent_id | 此資源父系之資源的標識碼。 | 類型資源的標識碼: dataBoxEdgeDevices |
kind | 設定物件類型 | 需要 IOT () |
IoTRole
名稱 | 描述 | 值 |
---|---|---|
kind | 角色類型。 | “IOT” (必要) |
properties | IoT 角色特有的屬性。 | IoTRoleProperties |
IoTRoleProperties
名稱 | 描述 | 值 |
---|---|---|
hostPlatform | IoT 角色支援的主機 OS。 | "Linux" “Windows” (必要) |
ioTDeviceDetails | 需要連接數據箱邊緣裝置的IoT裝置元數據。 | 需要 IoTDeviceInfo () |
ioTEdgeDeviceDetails | 需要設定IoT角色的IoT Edge裝置。 | 需要 IoTDeviceInfo () |
roleStatus | 角色狀態。 | “Disabled” 「已啟用」 (必要) |
shareMappings | 角色 () 中的共用裝入點。 | MountPointMap[] |
IoTDeviceInfo
名稱 | 描述 | 值 |
---|---|---|
驗證 (authentication) | IoT 裝置驗證資訊。 | 驗證 |
deviceId | IoT 裝置/邊緣裝置的標識碼。 | 字串 (必要) |
ioTHostHub | 與裝置相關聯的IoT中樞主機名。 | 字串 (必要) |
ioTHostHubId | 與裝置相關聯的IoT中樞標識碼。 | 字串 |
驗證
名稱 | 描述 | 值 |
---|---|---|
symmetricKey | 用於驗證的對稱金鑰。 | SymmetricKey |
SymmetricKey
名稱 | 描述 | 值 |
---|---|---|
connectionString | 以對稱金鑰為基礎的連接字串。 | AsymmetricEncryptedSecret |
AsymmetricEncryptedSecret
名稱 | 描述 | 值 |
---|---|---|
encryptionAlgorithm | 用來加密「值」的演算法。 | “AES256” "None" 必要) (“RSAES_PKCS1_v_1_5” |
encryptionCertThumbprint | 用來加密「值」的指紋憑證。 如果值未加密,則會是 Null。 | 字串 |
value | 密碼的值。 | 字串 (必要) |
MountPointMap
名稱 | 描述 | 值 |
---|---|---|
shareId | 掛接至角色 VM 的共享識別碼。 | 字串 (必要) |
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應