Microsoft.DataBoxEdge DataBoxEdgeDevices/roles 2019-03-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu dataBoxEdgeDevices/roles można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, dodaj następujący kod Bicep do szablonu.

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

dataBoxEdgeDevices/roles , obiekty

Ustaw właściwość kind , aby określić typ obiektu.

W przypadku IOT użyj:

  kind: 'IOT'
  properties: {
    hostPlatform: 'string'
    ioTDeviceDetails: {
      authentication: {
        symmetricKey: {
          connectionString: {
            encryptionAlgorithm: 'string'
            encryptionCertThumbprint: 'string'
            value: 'string'
          }
        }
      }
      deviceId: 'string'
      ioTHostHub: 'string'
    }
    ioTEdgeDeviceDetails: {
      authentication: {
        symmetricKey: {
          connectionString: {
            encryptionAlgorithm: 'string'
            encryptionCertThumbprint: 'string'
            value: 'string'
          }
        }
      }
      deviceId: 'string'
      ioTHostHub: 'string'
    }
    roleStatus: 'string'
    shareMappings: [
      {
        shareId: 'string'
      }
    ]
  }

Wartości właściwości

dataBoxEdgeDevices/roles

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
Rodzaju Ustawianie typu obiektu IOT (wymagane)
Nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: dataBoxEdgeDevices

IoTRole

Nazwa Opis Wartość
Rodzaju Typ roli. "IOT" (wymagane)
properties Właściwości specyficzne dla roli IoT. IoTRoleProperties

IoTRoleProperties

Nazwa Opis Wartość
hostPlatform System operacyjny hosta obsługiwany przez rolę IoT. "Linux"
"Windows" (wymagane)
ioTDeviceDetails Metadane urządzenia IoT, z którymi urządzenie data box edge musi być połączone. IoTDeviceInfo (wymagane)
ioTEdgeDeviceDetails Urządzenie usługi IoT Edge, do którego należy skonfigurować rolę IoT. IoTDeviceInfo (wymagane)
roleStatus Stan roli. "Wyłączone"
"Włączone" (wymagane)
shareMappings Instalowanie punktów udziałów w rolach. MountPointMap[]

IoTDeviceInfo

Nazwa Opis Wartość
uwierzytelnianie Informacje o uwierzytelnianiu urządzenia IoT. Authentication
deviceId Identyfikator urządzenia IoT/urządzenia brzegowego. ciąg (wymagany)
ioTHostHub Nazwa hosta centrum IoT skojarzonego z urządzeniem. ciąg (wymagany)

Authentication

Nazwa Opis Wartość
Symmetrickey Klucz symetryczny na potrzeby uwierzytelniania. Symmetrickey

Symmetrickey

Nazwa Opis Wartość
Parametry połączenia Parametry połączenia oparte na kluczu symetrycznym. AsymetryczneSzyfrowanesecret

AsymetryczneSzyfrowanesecret

Nazwa Opis Wartość
encryptionAlgorithm Algorytm używany do szyfrowania wartości. "AES256"
"Brak"
"RSAES_PKCS1_v_1_5" (wymagane)
encryptionCertThumbprint Certyfikat odcisku palca używany do szyfrowania wartości. Jeśli wartość jest niezaszyfrowana, będzie mieć wartość null. ciąg
wartość Wartość wpisu tajnego. ciąg (wymagany)

MountPointMap

Nazwa Opis Wartość
shareId Identyfikator udziału zainstalowanego na maszynie wirtualnej roli. ciąg (wymagany)

Definicja zasobu szablonu usługi ARM

Typ zasobu dataBoxEdgeDevices/roles można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, dodaj następujący kod JSON do szablonu.

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

dataBoxEdgeDevices/roles , obiekty

Ustaw właściwość kind , aby określić typ obiektu.

W przypadku IOT użyj:

  "kind": "IOT",
  "properties": {
    "hostPlatform": "string",
    "ioTDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string"
    },
    "ioTEdgeDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string"
    },
    "roleStatus": "string",
    "shareMappings": [
      {
        "shareId": "string"
      }
    ]
  }

Wartości właściwości

dataBoxEdgeDevices/roles

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles"
apiVersion Wersja interfejsu API zasobów '2019-03-01'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 ciąg (wymagany)
Rodzaju Ustawianie typu obiektu IOT (wymagane)

IoTRole

Nazwa Opis Wartość
Rodzaju Typ roli. "IOT" (wymagane)
properties Właściwości specyficzne dla roli IoT. IoTRoleProperties

IoTRoleProperties

Nazwa Opis Wartość
hostPlatform System operacyjny hosta obsługiwany przez rolę IoT. "Linux"
"Windows" (wymagane)
ioTDeviceDetails Metadane urządzenia IoT, z którymi urządzenie data box edge musi być połączone. IoTDeviceInfo (wymagane)
ioTEdgeDeviceDetails Urządzenie usługi IoT Edge, do którego należy skonfigurować rolę IoT. IoTDeviceInfo (wymagane)
roleStatus Stan roli. "Wyłączone"
"Włączone" (wymagane)
shareMappings Instalowanie punktów udziałów w rolach. MountPointMap[]

IoTDeviceInfo

Nazwa Opis Wartość
uwierzytelnianie Informacje o uwierzytelnianiu urządzenia IoT. Authentication
deviceId Identyfikator urządzenia IoT/urządzenia brzegowego. ciąg (wymagany)
ioTHostHub Nazwa hosta centrum IoT skojarzonego z urządzeniem. ciąg (wymagany)

Authentication

Nazwa Opis Wartość
Symmetrickey Klucz symetryczny do uwierzytelniania. Symmetrickey

Symmetrickey

Nazwa Opis Wartość
Parametry połączenia Parametry połączenia oparte na kluczu symetrycznym. AsymetryczneEncryptedSecret

AsymetryczneEncryptedSecret

Nazwa Opis Wartość
encryptionAlgorithm Algorytm używany do szyfrowania wartości. "AES256"
"Brak"
"RSAES_PKCS1_v_1_5" (wymagane)
encryptionCertThumbprint Certyfikat odcisku palca używany do szyfrowania wartości. Jeśli wartość jest niezaszyfrowana, będzie mieć wartość null. ciąg
wartość Wartość wpisu tajnego. ciąg (wymagany)

MountPointMap

Nazwa Opis Wartość
shareId Identyfikator udziału zainstalowanego na maszynie wirtualnej roli. ciąg (wymagany)

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu dataBoxEdgeDevices/roles można wdrożyć za pomocą operacji docelowych:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, dodaj następujący program Terraform do szablonu.

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

dataBoxEdgeDevices/roles objects

Ustaw właściwość kind , aby określić typ obiektu.

W przypadku IOT użyj:

  kind = "IOT"
  properties = {
    hostPlatform = "string"
    ioTDeviceDetails = {
      authentication = {
        symmetricKey = {
          connectionString = {
            encryptionAlgorithm = "string"
            encryptionCertThumbprint = "string"
            value = "string"
          }
        }
      }
      deviceId = "string"
      ioTHostHub = "string"
    }
    ioTEdgeDeviceDetails = {
      authentication = {
        symmetricKey = {
          connectionString = {
            encryptionAlgorithm = "string"
            encryptionCertThumbprint = "string"
            value = "string"
          }
        }
      }
      deviceId = "string"
      ioTHostHub = "string"
    }
    roleStatus = "string"
    shareMappings = [
      {
        shareId = "string"
      }
    ]
  }

Wartości właściwości

dataBoxEdgeDevices/roles

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-03-01"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: dataBoxEdgeDevices
Rodzaju Ustawianie typu obiektu IOT (wymagane)

IoTRole

Nazwa Opis Wartość
Rodzaju Typ roli. "IOT" (wymagane)
properties Właściwości specyficzne dla roli IoT. IoTRoleProperties

IoTRoleProperties

Nazwa Opis Wartość
hostPlatform Hostowanie systemu operacyjnego obsługiwanego przez rolę IoT. "Linux"
"Windows" (wymagane)
ioTDeviceDetails Metadane urządzenia IoT, z którymi urządzenie brzegowe urządzenia data box musi być połączone. IoTDeviceInfo (wymagane)
ioTEdgeDeviceDetails Urządzenie usługi IoT Edge, do którego należy skonfigurować rolę IoT. IoTDeviceInfo (wymagane)
roleStatus Stan roli. "Wyłączone"
"Włączone" (wymagane)
shareMappings Instalowanie punktów udziałów w rolach. MountPointMap[]

IoTDeviceInfo

Nazwa Opis Wartość
uwierzytelnianie Informacje o uwierzytelnianiu urządzenia IoT. Authentication
deviceId Identyfikator urządzenia IoT/urządzenia brzegowego. ciąg (wymagany)
ioTHostHub Nazwa hosta centrum IoT skojarzonego z urządzeniem. ciąg (wymagany)

Authentication

Nazwa Opis Wartość
Symmetrickey Klucz symetryczny do uwierzytelniania. Symmetrickey

Symmetrickey

Nazwa Opis Wartość
Parametry połączenia Parametry połączenia oparte na kluczu symetrycznym. AsymetryczneEncryptedSecret

AsymetryczneEncryptedSecret

Nazwa Opis Wartość
encryptionAlgorithm Algorytm używany do szyfrowania wartości. "AES256"
"Brak"
"RSAES_PKCS1_v_1_5" (wymagane)
encryptionCertThumbprint Certyfikat odcisku palca używany do szyfrowania wartości. Jeśli wartość jest niezaszyfrowana, będzie mieć wartość null. ciąg
wartość Wartość wpisu tajnego. ciąg (wymagany)

MountPointMap

Nazwa Opis Wartość
shareId Identyfikator udziału zainstalowanego na maszynie wirtualnej roli. ciąg (wymagany)