Partager via

Microsoft.DataBoxEdge dataBoxEdgeDevices/roles 2019-07-01

  • Article

Définition de ressource Bicep

Le type de ressource dataBoxEdgeDevices/roles peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, ajoutez le Bicep suivant à votre modèle.

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

objets dataBoxEdgeDevices/roles

Définissez la propriété kind pour spécifier le type d’objet.

Pour IOT, utilisez :

  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'
      }
    ]
  }

Valeurs de propriétés

dataBoxEdgeDevices/roles

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 string (obligatoire)
kind Définir le type d’objet IOT (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : dataBoxEdgeDevices

IoTRole

Nom Description Valeur
kind Type de rôle. 'IOT' (obligatoire)
properties Propriétés spécifiques au rôle IoT. IoTRoleProperties

IoTRoleProperties

Nom Description Valeur
hostPlatform Système d’exploitation hôte pris en charge par le rôle IoT. 'Linux'
'Windows' (obligatoire)
ioTDeviceDetails Métadonnées d’appareil IoT auxquelles l’appareil de périphérie data box doit être connecté. IoTDeviceInfo (obligatoire)
ioTEdgeDeviceDetails Appareil IoT Edge sur lequel le rôle IoT doit être configuré. IoTDeviceInfo (obligatoire)
roleStatus Rôle status. 'Désactivé'
'Enabled' (obligatoire)
shareMappings Montez des points de partages dans des rôles. MountPointMap[]

IoTDeviceInfo

Nom Description Valeur
Authentification Informations d’authentification des appareils IoT. Authentification
deviceId ID de l’appareil IoT/périphérique. string (obligatoire)
ioTHostHub Nom d’hôte du hub IoT associé à l’appareil. string (obligatoire)
ioTHostHubId ID du hub IoT associé à l’appareil. string

Authentification

Nom Description Valeur
symmetricKey Clé symétrique pour l’authentification. SymmetricKey

SymmetricKey

Nom Description Valeur
connectionString Chaîne de connexion basée sur la clé symétrique. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Nom Description Valeur
encryptionAlgorithm Algorithme utilisé pour chiffrer « Value ». 'AES256'
'None'
'RSAES_PKCS1_v_1_5' (obligatoire)
encryptionCertThumbprint Certificat d’empreinte numérique utilisé pour chiffrer « Value ». Si la valeur n’est pas chiffrée, elle sera null. string
value Valeur de la clé secrète. string (obligatoire)

MountPointMap

Nom Description Valeur
shareId ID du partage monté sur la machine virtuelle de rôle. string (obligatoire)

Définition de ressources de modèle ARM

Le type de ressource dataBoxEdgeDevices/roles peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, ajoutez le code JSON suivant à votre modèle.

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

objets dataBoxEdgeDevices/roles

Définissez la propriété kind pour spécifier le type d’objet.

Pour IOT, utilisez :

  "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"
      }
    ]
  }

Valeurs de propriétés

dataBoxEdgeDevices/roles

Nom Description Valeur
type Type de ressource « Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles »
apiVersion Version de l’API de ressource '2019-07-01'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 string (obligatoire)
kind Définir le type d’objet IOT (obligatoire)

IoTRole

Nom Description Valeur
kind Type de rôle. 'IOT' (obligatoire)
properties Propriétés spécifiques au rôle IoT. IoTRoleProperties

IoTRoleProperties

Nom Description Valeur
hostPlatform Système d’exploitation hôte pris en charge par le rôle IoT. 'Linux'
'Windows' (obligatoire)
ioTDeviceDetails Métadonnées d’appareil IoT auxquelles l’appareil de périphérie data box doit être connecté. IoTDeviceInfo (obligatoire)
ioTEdgeDeviceDetails Appareil IoT Edge sur lequel le rôle IoT doit être configuré. IoTDeviceInfo (obligatoire)
roleStatus Rôle status. 'Désactivé'
'Enabled' (obligatoire)
shareMappings Montez des points de partages dans des rôles. MountPointMap[]

IoTDeviceInfo

Nom Description Valeur
Authentification Informations d’authentification des appareils IoT. Authentification
deviceId ID de l’appareil IoT/périphérique. string (obligatoire)
ioTHostHub Nom d’hôte du hub IoT associé à l’appareil. chaîne (obligatoire)
ioTHostHubId ID du hub IoT associé à l’appareil. string

Authentification

Nom Description Valeur
symmetricKey Clé symétrique pour l’authentification. SymmetricKey

SymmetricKey

Nom Description Valeur
connectionString Chaîne de connexion basée sur la clé symétrique. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Nom Description Valeur
encryptionAlgorithm Algorithme utilisé pour chiffrer « Value ». « AES256 »
'None'
'RSAES_PKCS1_v_1_5' (obligatoire)
encryptionCertThumbprint Certificat d’empreinte utilisé pour chiffrer « Value ». Si la valeur n’est pas chiffrée, elle sera null. string
value Valeur de la clé secrète. chaîne (obligatoire)

MountPointMap

Nom Description Valeur
shareId ID du partage monté sur la machine virtuelle de rôle. chaîne (obligatoire)

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource dataBoxEdgeDevices/roles peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, ajoutez le Terraform suivant à votre modèle.

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

objets dataBoxEdgeDevices/roles

Définissez la propriété kind pour spécifier le type d’objet.

Pour l’IOT, utilisez :

  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"
      }
    ]
  }

Valeurs de propriétés

dataBoxEdgeDevices/roles

Nom Description Valeur
type Type de ressource « Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-07-01 »
name Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : dataBoxEdgeDevices
kind Définir le type d’objet IOT (obligatoire)

IoTRole

Nom Description Valeur
kind Type de rôle. « IOT » (obligatoire)
properties Propriétés spécifiques au rôle IoT. IoTRoleProperties

IoTRoleProperties

Nom Description Valeur
hostPlatform Système d’exploitation hôte pris en charge par le rôle IoT. « Linux »
« Windows » (obligatoire)
ioTDeviceDetails Métadonnées d’appareil IoT auxquelles l’appareil de périphérie data box doit être connecté. IoTDeviceInfo (obligatoire)
ioTEdgeDeviceDetails Appareil De périphérie IoT sur lequel le rôle IoT doit être configuré. IoTDeviceInfo (obligatoire)
roleStatus Status de rôle. « Désactivé »
« Enabled » (obligatoire)
shareMappings Montez des points de partages dans des rôles. MountPointMap[]

IoTDeviceInfo

Nom Description Valeur
Authentification Informations d’authentification des appareils IoT. Authentification
deviceId ID de l’appareil IoT/périphérique. chaîne (obligatoire)
ioTHostHub Nom d’hôte du hub IoT associé à l’appareil. chaîne (obligatoire)
ioTHostHubId ID du hub IoT associé à l’appareil. string

Authentification

Nom Description Valeur
symmetricKey Clé symétrique pour l’authentification. SymmetricKey

SymmetricKey

Nom Description Valeur
connectionString Chaîne de connexion basée sur la clé symétrique. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Nom Description Valeur
encryptionAlgorithm Algorithme utilisé pour chiffrer « Value ». « AES256 »
"None"
« RSAES_PKCS1_v_1_5 » (obligatoire)
encryptionCertThumbprint Certificat d’empreinte utilisé pour chiffrer « Value ». Si la valeur n’est pas chiffrée, elle sera null. string
value Valeur de la clé secrète. chaîne (obligatoire)

MountPointMap

Nom Description Valeur
shareId ID du partage monté sur la machine virtuelle de rôle. chaîne (obligatoire)