Microsoft.DataBoxEdge dataBoxEdgeDevices/roles 2020-05-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso dataBoxEdgeDevices/roles pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, adicione o seguinte Bicep ao seu modelo.

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

objetos dataBoxEdgeDevices/roles

Defina a propriedade kind para especificar o tipo de objeto.

Para IOT, utilize:

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

Valores de propriedade

dataBoxEdgeDevices/roles

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
tipo Definir o tipo de objeto IOT (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: dataBoxEdgeDevices

IoTRole

Nome Descrição Valor
tipo Tipo de função. "IOT" (obrigatório)
propriedades Propriedades específicas da função IoT. IoTRoleProperties

IoTRoleProperties

Nome Descrição Valor
hostPlatform So anfitrião suportado pela função IoT. 'Linux'
"Windows" (obrigatório)
ioTDeviceDetails Metadados do dispositivo IoT aos quais o dispositivo edge do data box precisa de ser ligado. IoTDeviceInfo (obrigatório)
ioTEdgeAgentInfo Detalhes do agente do Iot edge para transferir o agente e bootstrap iot runtime. IoTEdgeAgentInfo
ioTEdgeDeviceDetails Dispositivo IoT edge para o qual a função IoT precisa de ser configurada. IoTDeviceInfo (obrigatório)
roleStatus Estado da função. "Desativado"
"Ativado" (obrigatório)
shareMappings Pontos de montagem de partilhas em funções. MountPointMap[]

IoTDeviceInfo

Nome Descrição Valor
autenticação Dispositivo IoT encriptado/dispositivo IoT edge cadeia de ligação. Autenticação
deviceId ID do dispositivo IoT/dispositivo edge. cadeia (obrigatório)
ioTHostHub Nome do anfitrião do hub IoT associado ao dispositivo. cadeia (obrigatório)
ioTHostHubId ID do hub IoT associado ao dispositivo. string

Autenticação

Nome Descrição Valor
symmetricKey Chave simétrica para autenticação. Chave Simétrica

Chave Simétrica

Nome Descrição Valor
connectionString Cadeia de ligação com base na chave simétrica. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Nome Descrição Valor
encryptionAlgorithm O algoritmo utilizado para encriptar "Valor". "AES256"
"Nenhum"
"RSAES_PKCS1_v_1_5" (obrigatório)
encryptionCertThumbprint Certificado thumbprint utilizado para encriptar "Valor". Se o valor não estiver encriptado, será nulo. string
valor O valor do segredo. cadeia (obrigatório)

IoTEdgeAgentInfo

Nome Descrição Valor
imageName Nome da imagem do agente do IoT Edge. cadeia (obrigatório)
imageRepository Detalhes do repositório de imagens. ImageRepositoryCredential
etiqueta Etiqueta de Imagem. cadeia (obrigatório)

ImageRepositoryCredential

Nome Descrição Valor
imageRepositoryUrl Url do repositório de imagens (por exemplo, mcr.microsoft.com). cadeia (obrigatório)
palavra-passe Palavra-passe de utilizador do repositório. AsymmetricEncryptedSecret
userName Nome de utilizador do repositório. cadeia (obrigatório)

MountPointMap

Nome Descrição Valor
shareId ID da partilha montada na VM de função. cadeia (obrigatório)

Definição de recurso de modelo do ARM

O tipo de recurso dataBoxEdgeDevices/roles pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, adicione o seguinte JSON ao seu modelo.

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

objetos dataBoxEdgeDevices/roles

Defina a propriedade kind para especificar o tipo de objeto.

Para IOT, utilize:

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

Valores de propriedade

dataBoxEdgeDevices/roles

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles"
apiVersion A versão da API de recursos "2020-05-01-preview"
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.		 cadeia (obrigatório)
tipo Definir o tipo de objeto IOT (obrigatório)

IoTRole

Nome Descrição Valor
tipo Tipo de função. "IOT" (obrigatório)
propriedades Propriedades específicas da função IoT. IoTRoleProperties

IoTRoleProperties

Nome Descrição Valor
hostPlatform SO anfitrião suportado pela função de IoT. 'Linux'
"Windows" (obrigatório)
ioTDeviceDetails Metadados do dispositivo IoT aos quais o dispositivo de data box edge precisa de ser ligado. IoTDeviceInfo (obrigatório)
ioTEdgeAgentInfo Detalhes do agente do Iot Edge para transferir o agente e o runtime do iot bootstrap. IoTEdgeAgentInfo
ioTEdgeDeviceDetails Dispositivo IoT edge para o qual a função IoT precisa de ser configurada. IoTDeviceInfo (obrigatório)
roleStatus Estado da função. "Desativado"
"Ativado" (obrigatório)
shareMappings Montar pontos de partilha em funções. MountPointMap[]

IoTDeviceInfo

Nome Descrição Valor
autenticação Dispositivo IoT encriptado/dispositivo IoT edge cadeia de ligação. Autenticação
deviceId ID do dispositivo IoT/dispositivo edge. cadeia (obrigatório)
ioTHostHub Nome do anfitrião do hub IoT associado ao dispositivo. cadeia (obrigatório)
ioTHostHubId ID do hub IoT associado ao dispositivo. string

Autenticação

Nome Descrição Valor
symmetricKey Chave simétrica para autenticação. SymmetricKey

SymmetricKey

Nome Descrição Valor
connectionString Cadeia de ligação com base na chave simétrica. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Nome Descrição Valor
encryptionAlgorithm O algoritmo utilizado para encriptar "Valor". "AES256"
"Nenhum"
'RSAES_PKCS1_v_1_5' (obrigatório)
encryptionCertThumbprint Certificado thumbprint utilizado para encriptar "Valor". Se o valor não estiver encriptado, será nulo. string
valor O valor do segredo. cadeia (obrigatório)

IoTEdgeAgentInfo

Nome Descrição Valor
imageName Nome da imagem do agente do IoT Edge. cadeia (obrigatório)
imageRepository Detalhes do repositório de imagens. ImageRepositoryCredential
etiqueta Etiqueta de Imagem. cadeia (obrigatório)

ImageRepositoryCredential

Nome Descrição Valor
imageRepositoryUrl URL do repositório de imagens (por exemplo: mcr.microsoft.com). cadeia (obrigatório)
palavra-passe Palavra-passe de utilizador do repositório. AsymmetricEncryptedSecret
userName Nome de utilizador do repositório. cadeia (obrigatório)

MountPointMap

Nome Descrição Valor
shareId ID da partilha montada na VM de função. cadeia (obrigatório)

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso dataBoxEdgeDevices/roles pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, adicione o seguinte Terraform ao seu modelo.

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

objetos dataBoxEdgeDevices/roles

Defina a propriedade kind para especificar o tipo de objeto.

Para IOT, utilize:

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

Valores de propriedade

dataBoxEdgeDevices/roles

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: dataBoxEdgeDevices
tipo Definir o tipo de objeto IOT (obrigatório)

IoTRole

Nome Descrição Valor
tipo Tipo de função. "IOT" (obrigatório)
propriedades Propriedades específicas da função IoT. IoTRoleProperties

IoTRoleProperties

Nome Descrição Valor
hostPlatform SO anfitrião suportado pela função de IoT. "Linux"
"Windows" (obrigatório)
ioTDeviceDetails Metadados do dispositivo IoT aos quais o dispositivo de data box edge precisa de ser ligado. IoTDeviceInfo (obrigatório)
ioTEdgeAgentInfo Detalhes do agente do Iot Edge para transferir o agente e o runtime do iot bootstrap. IoTEdgeAgentInfo
ioTEdgeDeviceDetails Dispositivo IoT edge para o qual a função IoT precisa de ser configurada. IoTDeviceInfo (obrigatório)
roleStatus Estado da função. "Desativado"
"Ativado" (obrigatório)
shareMappings Montar pontos de partilha em funções. MountPointMap[]

IoTDeviceInfo

Nome Descrição Valor
autenticação Dispositivo IoT encriptado/dispositivo IoT edge cadeia de ligação. Autenticação
deviceId ID do dispositivo IoT/dispositivo edge. cadeia (obrigatório)
ioTHostHub Nome do anfitrião do hub IoT associado ao dispositivo. cadeia (obrigatório)
ioTHostHubId ID do hub IoT associado ao dispositivo. string

Autenticação

Nome Descrição Valor
symmetricKey Chave simétrica para autenticação. SymmetricKey

SymmetricKey

Nome Descrição Valor
connectionString Cadeia de ligação com base na chave simétrica. AsymmetricEncryptedSecret

AsymmetricEncryptedSecret

Nome Descrição Valor
encryptionAlgorithm O algoritmo utilizado para encriptar "Valor". "AES256"
"Nenhum"
"RSAES_PKCS1_v_1_5" (obrigatório)
encryptionCertThumbprint Certificado thumbprint utilizado para encriptar "Valor". Se o valor não estiver encriptado, será nulo. string
valor O valor do segredo. cadeia (obrigatório)

IoTEdgeAgentInfo

Nome Descrição Valor
imageName Nome da imagem do agente do IoT Edge. cadeia (obrigatório)
imageRepository Detalhes do repositório de imagens. ImageRepositoryCredential
etiqueta Etiqueta de Imagem. cadeia (obrigatório)

ImageRepositoryCredential

Nome Descrição Valor
imageRepositoryUrl Url do repositório de imagens (por exemplo, mcr.microsoft.com). cadeia (obrigatório)
palavra-passe Palavra-passe de utilizador do repositório. AsymmetricEncryptedSecret
userName Nome de utilizador do repositório. cadeia (obrigatório)

MountPointMap

Nome Descrição Valor
shareId ID da partilha montada na VM de função. cadeia (obrigatório)