Microsoft.DataBoxEdge dataBoxEdgeDevices/roles 2020-05-01-preview
Bicep-resourcedefinitie
Het resourcetype dataBoxEdgeDevices/roles kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview' = {
name: 'string'
kind: 'string'
parent: resourceSymbolicName
// For remaining properties, see dataBoxEdgeDevices/roles objects
}
dataBoxEdgeDevices/roles-objecten
Stel de eigenschap type in om het type object op te geven.
Voor IOT gebruikt u:
kind: 'IOT'
properties: {
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'
}
]
}
Eigenschapswaarden
dataBoxEdgeDevices/roles
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep. |
tekenreeks (vereist) |
| Soort | Het objecttype instellen | IOT (vereist) |
| Bovenliggende | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie Onderliggende resource buiten bovenliggende resource voor meer informatie. |
Symbolische naam voor resource van het type: dataBoxEdgeDevices |
IoTRole
| Naam | Description | Waarde |
|---|---|---|
| Soort | Roltype. | 'IOT' (vereist) |
| properties | Eigenschappen die specifiek zijn voor de IoT-rol. | IoTRoleProperties |
IoTRoleProperties
| Naam | Description | Waarde |
|---|---|---|
| hostPlatform | Host-besturingssysteem dat wordt ondersteund door de IoT-rol. | 'Linux' 'Windows' (vereist) |
| ioTDeviceDetails | Metagegevens van IoT-apparaten waarmee het Data Box Edge-apparaat moet worden verbonden. | IoTDeviceInfo (vereist) |
| ioTEdgeAgentInfo | IoT edge-agentdetails om de agent en bootstrap iot-runtime te downloaden. | IoTEdgeAgentInfo |
| ioTEdgeDeviceDetails | IoT Edge-apparaat waarop de IoT-rol moet worden geconfigureerd. | IoTDeviceInfo (vereist) |
| roleStatus | Rolstatus. | 'Uitgeschakeld' Ingeschakeld (vereist) |
| shareMappings | Koppel punten van shares in rol(s). | MountPointMap[] |
IoTDeviceInfo
| Naam | Description | Waarde |
|---|---|---|
| verificatie | Versleuteld IoT-apparaat/IoT Edge-apparaat verbindingsreeks. | Verificatie |
| deviceId | Id van het IoT-apparaat/edge-apparaat. | tekenreeks (vereist) |
| ioTHostHub | Hostnaam voor de IoT-hub die aan het apparaat is gekoppeld. | tekenreeks (vereist) |
| ioTHostHubId | Id voor de IoT-hub die aan het apparaat is gekoppeld. | tekenreeks |
Verificatie
| Naam | Description | Waarde |
|---|---|---|
| symmetricKey | Symmetrische sleutel voor verificatie. | SymmetricKey |
SymmetricKey
| Naam | Description | Waarde |
|---|---|---|
| connectionString | Verbindingsreeks op basis van de symmetrische sleutel. | AsymmetricEncryptedSecret |
AsymmetricEncryptedSecret
| Naam | Description | Waarde |
|---|---|---|
| encryptionAlgorithm | Het algoritme dat wordt gebruikt om 'Waarde' te versleutelen. | 'AES256' 'Geen' 'RSAES_PKCS1_v_1_5' (vereist) |
| encryptionCertThumbprint | Vingerafdrukcertificaat dat wordt gebruikt om 'Waarde' te versleutelen. Als de waarde niet is versleuteld, is deze null. | tekenreeks |
| waarde | De waarde van het geheim. | tekenreeks (vereist) |
IoTEdgeAgentInfo
| Naam | Description | Waarde |
|---|---|---|
| Afbeeldingnaam | Naam van de installatiekopieën van de IoT Edge-agent. | tekenreeks (vereist) |
| imageRepository | Details van opslagplaats voor installatiekopieën. | ImageRepositoryCredential |
| tag | Afbeeldingstag. | tekenreeks (vereist) |
ImageRepositoryCredential
| Naam | Description | Waarde |
|---|---|---|
| imageRepositoryUrl | URL van opslagplaats voor installatiekopieën (bijvoorbeeld: mcr.microsoft.com). | tekenreeks (vereist) |
| wachtwoord | Gebruikerswachtwoord voor opslagplaats. | AsymmetricEncryptedSecret |
| userName | Gebruikersnaam van opslagplaats. | tekenreeks (vereist) |
MountPointMap
| Naam | Description | Waarde |
|---|---|---|
| shareId | Id van de share die is gekoppeld aan de rol-VM. | tekenreeks (vereist) |
Resourcedefinitie van ARM-sjabloon
Het resourcetype dataBoxEdgeDevices/roles kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles",
"apiVersion": "2020-05-01-preview",
"name": "string",
"kind": "string",
// For remaining properties, see dataBoxEdgeDevices/roles objects
}
dataBoxEdgeDevices/roles-objecten
Stel de eigenschap Soort in om het type object op te geven.
Voor IOT gebruikt u:
"kind": "IOT",
"properties": {
"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"
}
]
}
Eigenschapswaarden
dataBoxEdgeDevices/roles
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles' |
| apiVersion | De resource-API-versie | '2020-05-01-preview' |
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) |
| Soort | Het objecttype instellen | IoT (vereist) |
IoTRole
| Naam | Description | Waarde |
|---|---|---|
| Soort | Roltype. | IOT (vereist) |
| properties | Eigenschappen die specifiek zijn voor de IoT-rol. | IoTRoleProperties |
IoTRoleProperties
| Naam | Description | Waarde |
|---|---|---|
| hostPlatform | Host-besturingssysteem dat wordt ondersteund door de IoT-rol. | 'Linux' 'Windows' (vereist) |
| ioTDeviceDetails | Metagegevens van IoT-apparaten waarmee het Data Box Edge-apparaat moet worden verbonden. | IoTDeviceInfo (vereist) |
| ioTEdgeAgentInfo | Iot edge-agentdetails om de agent en bootstrap iot-runtime te downloaden. | IoTEdgeAgentInfo |
| ioTEdgeDeviceDetails | IoT Edge-apparaat waarop de IoT-rol moet worden geconfigureerd. | IoTDeviceInfo (vereist) |
| roleStatus | Rolstatus. | 'Uitgeschakeld' Ingeschakeld (vereist) |
| shareMappings | Koppel punten van shares in rollen. | MountPointMap[] |
IoTDeviceInfo
| Naam | Description | Waarde |
|---|---|---|
| verificatie | Versleuteld IoT-apparaat/IoT Edge-apparaat verbindingsreeks. | Verificatie |
| deviceId | Id van het IoT-apparaat/edge-apparaat. | tekenreeks (vereist) |
| ioTHostHub | Hostnaam voor de IoT-hub die aan het apparaat is gekoppeld. | tekenreeks (vereist) |
| ioTHostHubId | Id voor de IoT-hub die is gekoppeld aan het apparaat. | tekenreeks |
Verificatie
| Naam | Description | Waarde |
|---|---|---|
| symmetricKey | Symmetrische sleutel voor verificatie. | SymmetricKey |
SymmetricKey
| Naam | Description | Waarde |
|---|---|---|
| connectionString | Verbindingsreeks op basis van de symmetrische sleutel. | AsymmetricEncryptedSecret |
AsymmetricEncryptedSecret
| Naam | Description | Waarde |
|---|---|---|
| encryptionAlgorithm | Het algoritme dat wordt gebruikt om 'Waarde' te versleutelen. | 'AES256' 'Geen' 'RSAES_PKCS1_v_1_5' (vereist) |
| encryptionCertThumbprint | Vingerafdrukcertificaat dat wordt gebruikt om 'Waarde' te versleutelen. Als de waarde niet is versleuteld, is deze null. | tekenreeks |
| waarde | De waarde van het geheim. | tekenreeks (vereist) |
IoTEdgeAgentInfo
| Naam | Description | Waarde |
|---|---|---|
| Afbeeldingnaam | Naam van de installatiekopieën van de IoT Edge-agent. | tekenreeks (vereist) |
| imageRepository | Details van opslagplaats voor installatiekopieën. | ImageRepositoryCredential |
| tag | Afbeeldingstag. | tekenreeks (vereist) |
ImageRepositoryCredential
| Naam | Description | Waarde |
|---|---|---|
| imageRepositoryUrl | URL van opslagplaats voor installatiekopieën (bijvoorbeeld: mcr.microsoft.com). | tekenreeks (vereist) |
| wachtwoord | Gebruikerswachtwoord voor opslagplaats. | AsymmetricEncryptedSecret |
| userName | Gebruikersnaam van opslagplaats. | tekenreeks (vereist) |
MountPointMap
| Naam | Description | Waarde |
|---|---|---|
| shareId | Id van de share die is gekoppeld aan de rol-VM. | tekenreeks (vereist) |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype dataBoxEdgeDevices/roles kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview"
name = "string"
parent_id = "string"
// For remaining properties, see dataBoxEdgeDevices/roles objects
body = jsonencode({
kind = "string"
})
}
dataBoxEdgeDevices/roles-objecten
Stel de eigenschap Soort in om het type object op te geven.
Voor IOT gebruikt u:
kind = "IOT"
properties = {
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"
}
]
}
Eigenschapswaarden
dataBoxEdgeDevices/roles
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview" |
| naam | De resourcenaam | tekenreeks (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: dataBoxEdgeDevices |
| Soort | Het objecttype instellen | IoT (vereist) |
IoTRole
| Naam | Description | Waarde |
|---|---|---|
| Soort | Roltype. | 'IOT' (vereist) |
| properties | Eigenschappen die specifiek zijn voor de IoT-rol. | IoTRoleProperties |
IoTRoleProperties
| Naam | Description | Waarde |
|---|---|---|
| hostPlatform | Host-besturingssysteem dat wordt ondersteund door de IoT-rol. | "Linux" "Windows" (vereist) |
| ioTDeviceDetails | Metagegevens van IoT-apparaten waarmee het Data Box Edge-apparaat moet worden verbonden. | IoTDeviceInfo (vereist) |
| ioTEdgeAgentInfo | Iot edge-agentdetails om de agent en bootstrap iot-runtime te downloaden. | IoTEdgeAgentInfo |
| ioTEdgeDeviceDetails | IoT Edge-apparaat waarop de IoT-rol moet worden geconfigureerd. | IoTDeviceInfo (vereist) |
| roleStatus | Rolstatus. | "Uitgeschakeld" 'Ingeschakeld' (vereist) |
| shareMappings | Koppel punten van shares in rollen. | MountPointMap[] |
IoTDeviceInfo
| Naam | Description | Waarde |
|---|---|---|
| verificatie | Versleuteld IoT-apparaat/IoT Edge-apparaat verbindingsreeks. | Verificatie |
| deviceId | Id van het IoT-apparaat/edge-apparaat. | tekenreeks (vereist) |
| ioTHostHub | Hostnaam voor de IoT-hub die aan het apparaat is gekoppeld. | tekenreeks (vereist) |
| ioTHostHubId | Id voor de IoT-hub die is gekoppeld aan het apparaat. | tekenreeks |
Verificatie
| Naam | Description | Waarde |
|---|---|---|
| symmetricKey | Symmetrische sleutel voor verificatie. | SymmetricKey |
SymmetricKey
| Naam | Description | Waarde |
|---|---|---|
| connectionString | Verbindingsreeks op basis van de symmetrische sleutel. | AsymmetricEncryptedSecret |
AsymmetricEncryptedSecret
| Naam | Description | Waarde |
|---|---|---|
| encryptionAlgorithm | Het algoritme dat wordt gebruikt om 'Waarde' te versleutelen. | "AES256" "Geen" "RSAES_PKCS1_v_1_5" (vereist) |
| encryptionCertThumbprint | Vingerafdrukcertificaat dat wordt gebruikt om 'Waarde' te versleutelen. Als de waarde niet is versleuteld, is deze null. | tekenreeks |
| waarde | De waarde van het geheim. | tekenreeks (vereist) |
IoTEdgeAgentInfo
| Naam | Description | Waarde |
|---|---|---|
| Afbeeldingnaam | Naam van de installatiekopieën van de IoT Edge-agent. | tekenreeks (vereist) |
| imageRepository | Details van opslagplaats voor installatiekopieën. | ImageRepositoryCredential |
| tag | Afbeeldingstag. | tekenreeks (vereist) |
ImageRepositoryCredential
| Naam | Description | Waarde |
|---|---|---|
| imageRepositoryUrl | URL van opslagplaats voor installatiekopieën (bijvoorbeeld: mcr.microsoft.com). | tekenreeks (vereist) |
| wachtwoord | Gebruikerswachtwoord voor opslagplaats. | AsymmetricEncryptedSecret |
| userName | Gebruikersnaam van opslagplaats. | tekenreeks (vereist) |
MountPointMap
| Naam | Description | Waarde |
|---|---|---|
| shareId | Id van de share die is gekoppeld aan de rol-VM. | tekenreeks (vereist) |
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor