Microsoft. DataBoxEdge dataBoxEdgeDevices/roles 2020-12-01
Artykuł
12/28/2022
1 współautor
Opinia
W tym artykule
Definicja zasobu Bicep
Typ zasobu dataBoxEdgeDevices/roles można wdrożyć w następujących elementach:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian .
Aby utworzyć Microsoft. Zasób DataBoxEdge/dataBoxEdgeDevices/roles dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-12-01' = {
name: 'string'
kind: 'string'
parent: resourceSymbolicName
// For remaining properties, see dataBoxEdgeDevices/roles objects
}
dataBoxEdgeDevices/roles objects
Ustaw właściwość kind , aby określić typ obiektu.
W przypadku rozwiązania CloudEdgeManagement użyj:
kind: 'CloudEdgeManagement'
properties: {
roleStatus: 'string'
}
W przypadku IOT użyj:
kind: 'IOT'
properties: {
computeResource: {
memoryInGB: int
processorCount: int
}
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'
}
]
}
W przypadku platformy Kubernetes użyj:
kind: 'Kubernetes'
properties: {
hostPlatform: 'string'
kubernetesClusterInfo: {
version: 'string'
}
kubernetesRoleResources: {
compute: {
vmProfile: 'string'
}
storage: {
endpoints: [
{
shareId: 'string'
}
]
}
}
roleStatus: 'string'
}
W przypadku usługi MEC użyj:
kind: 'MEC'
properties: {
connectionString: {
encryptionAlgorithm: 'string'
encryptionCertThumbprint: 'string'
value: 'string'
}
roleStatus: 'string'
}
Wartości właściwości
dataBoxEdgeDevices/roles
CloudEdgeManagementRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"CloudEdgeManagement" (wymagane)
properties
Właściwości specyficzne dla roli CloudEdgeManagementRole.
CloudEdgeManagementRoleProperties
CloudEdgeManagementRoleProperties
Nazwa
Opis
Wartość
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
IoTRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"IOT" (wymagane)
properties
Właściwości specyficzne dla roli IoT.
IoTRoleProperties
IoTRoleProperties
Nazwa
Opis
Wartość
computeResource
Alokacja zasobów
ComputeResource
hostPlatform
Hostowanie systemu operacyjnego obsługiwanego przez rolę IoT.
"Linux" "Windows" (wymagany)
ioTDeviceDetails
Metadane urządzenia IoT, z którymi urządzenie brzegowe urządzenia data box musi być połączone.
IoTDeviceInfo (wymagane)
ioTEdgeAgentInfo
Szczegóły agenta usługi Iot Edge w celu pobrania agenta i środowiska uruchomieniowego iot bootstrap.
IoTEdgeAgentInfo
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 []
ComputeResource
Nazwa
Opis
Wartość
memoryInGB
Pamięć w GB
int (wymagane)
processorCount
Liczba procesorów
int (wymagane)
IoTDeviceInfo
Nazwa
Opis
Wartość
uwierzytelnianie
Zaszyfrowane parametry połączenia urządzenia IoT/usługi IoT Edge.
Authentication
deviceId
Identyfikator urządzenia IoT/urządzenia brzegowego.
ciąg (wymagany)
ioTHostHub
Nazwa hosta centrum IoT skojarzonego z urządzeniem.
ciąg (wymagany)
ioTHostHubId
Identyfikator centrum IoT skojarzonego z urządzeniem.
ciąg
Authentication
Nazwa
Opis
Wartość
Symmetrickey
Klucz symetryczny na potrzeby uwierzytelniania.
Symmetrickey
Symmetrickey
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)
IoTEdgeAgentInfo
Nazwa
Opis
Wartość
Imagename
Nazwa obrazu agenta usługi IoT Edge.
ciąg (wymagany)
imageRepository
Szczegóły repozytorium obrazów.
ImageRepositoryCredential
tag
Tag obrazu.
ciąg (wymagany)
ImageRepositoryCredential
Nazwa
Opis
Wartość
imageRepositoryUrl
Adres URL repozytorium obrazów (np. mcr.microsoft.com).
ciąg (wymagany)
hasło
Hasło użytkownika repozytorium.
AsymetryczneSzyfrowanesecret
userName
Nazwa użytkownika repozytorium.
ciąg (wymagany)
MountPointMap
Nazwa
Opis
Wartość
shareId
Identyfikator udziału zainstalowanego na maszynie wirtualnej roli.
ciąg (wymagany)
KubernetesRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"Kubernetes" (wymagane)
properties
Właściwości specyficzne dla roli Kubernetes.
KubernetesRoleProperties
KubernetesRoleProperties
Nazwa
Opis
Wartość
hostPlatform
Hostowanie systemu operacyjnego obsługiwanego przez rolę Kubernetes.
"Linux" "Windows" (wymagany)
kubernetesClusterInfo
Konfiguracja klastra Kubernetes
KubernetesClusterInfo (wymagane)
kubernetesRoleResources
Zasoby roli platformy Kubernetes
KubernetesRoleResources (wymagane)
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
KubernetesClusterInfo
Nazwa
Opis
Wartość
Wersja
Wersja klastra Kubernetes
ciąg (wymagany)
KubernetesRoleResources
KubernetesRoleCompute
Nazwa
Opis
Wartość
vmProfile
Profil maszyny wirtualnej
ciąg (wymagany)
KubernetesRoleStorage
Nazwa
Opis
Wartość
Punkty końcowe
Instalowanie punktów udziałów w rolach.
MountPointMap []
MECRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"MEC" (wymagane)
properties
Właściwości specyficzne dla roli MEC.
MECRoleProperties
MECRoleProperties
Nazwa
Opis
Wartość
Parametry połączenia
Klucz aktywacji MEC.
AsymetryczneEncryptedSecret
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
Definicja zasobu szablonu usługi ARM
Typ zasobu dataBoxEdgeDevices/roles można wdrożyć w następujących elementach:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian .
Aby utworzyć Microsoft. Zasób DataBoxEdge/dataBoxEdgeDevices/roles dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles",
"apiVersion": "2020-12-01",
"name": "string",
"kind": "string",
// For remaining properties, see dataBoxEdgeDevices/roles objects
}
dataBoxEdgeDevices/roles objects
Ustaw właściwość kind , aby określić typ obiektu.
W przypadku rozwiązania CloudEdgeManagement użyj:
"kind": "CloudEdgeManagement",
"properties": {
"roleStatus": "string"
}
W przypadku IOT użyj:
"kind": "IOT",
"properties": {
"computeResource": {
"memoryInGB": "int",
"processorCount": "int"
},
"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"
}
]
}
W przypadku platformy Kubernetes użyj:
"kind": "Kubernetes",
"properties": {
"hostPlatform": "string",
"kubernetesClusterInfo": {
"version": "string"
},
"kubernetesRoleResources": {
"compute": {
"vmProfile": "string"
},
"storage": {
"endpoints": [
{
"shareId": "string"
}
]
}
},
"roleStatus": "string"
}
W przypadku usługi MEC użyj:
"kind": "MEC",
"properties": {
"connectionString": {
"encryptionAlgorithm": "string",
"encryptionCertThumbprint": "string",
"value": "string"
},
"roleStatus": "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
'2020-12-01'
name
Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON .
ciąg (wymagany)
Rodzaju
Ustawianie typu obiektu
CloudEdgeManagement IOT Kubernetes MEC (wymagane)
CloudEdgeManagementRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"CloudEdgeManagement" (wymagane)
properties
Właściwości specyficzne dla roli CloudEdgeManagementRole.
CloudEdgeManagementRoleProperties
CloudEdgeManagementRoleProperties
Nazwa
Opis
Wartość
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
IoTRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"IOT" (wymagane)
properties
Właściwości specyficzne dla roli IoT.
IoTRoleProperties
IoTRoleProperties
Nazwa
Opis
Wartość
computeResource
Alokacja zasobów
ComputeResource
hostPlatform
Hostowanie systemu operacyjnego obsługiwanego przez rolę IoT.
"Linux" "Windows" (wymagany)
ioTDeviceDetails
Metadane urządzenia IoT, z którymi urządzenie brzegowe urządzenia data box musi być połączone.
IoTDeviceInfo (wymagane)
ioTEdgeAgentInfo
Szczegóły agenta usługi Iot Edge w celu pobrania agenta i środowiska uruchomieniowego iot bootstrap.
IoTEdgeAgentInfo
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 []
ComputeResource
Nazwa
Opis
Wartość
memoryInGB
Pamięć w GB
int (wymagane)
processorCount
Liczba procesorów
int (wymagane)
IoTDeviceInfo
Nazwa
Opis
Wartość
uwierzytelnianie
Zaszyfrowane parametry połączenia urządzenia IoT/usługi IoT Edge.
Authentication
deviceId
Identyfikator urządzenia IoT/urządzenia brzegowego.
ciąg (wymagany)
ioTHostHub
Nazwa hosta centrum IoT skojarzonego z urządzeniem.
ciąg (wymagany)
ioTHostHubId
Identyfikator centrum IoT skojarzonego z urządzeniem.
ciąg
Authentication
Nazwa
Opis
Wartość
Symmetrickey
Klucz symetryczny do uwierzytelniania.
Symmetrickey
Symmetrickey
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)
IoTEdgeAgentInfo
Nazwa
Opis
Wartość
Imagename
Nazwa obrazu agenta usługi IoT Edge.
ciąg (wymagany)
imageRepository
Szczegóły repozytorium obrazów.
ImageRepositoryCredential
tag
Tag obrazu.
ciąg (wymagany)
ImageRepositoryCredential
Nazwa
Opis
Wartość
imageRepositoryUrl
Adres URL repozytorium obrazów (np. mcr.microsoft.com).
ciąg (wymagany)
hasło
Hasło użytkownika repozytorium.
AsymetryczneEncryptedSecret
userName
Nazwa użytkownika repozytorium.
ciąg (wymagany)
MountPointMap
Nazwa
Opis
Wartość
shareId
Identyfikator udziału zainstalowanego na maszynie wirtualnej roli.
ciąg (wymagany)
KubernetesRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"Kubernetes" (wymagane)
properties
Właściwości specyficzne dla roli Kubernetes.
KubernetesRoleProperties
KubernetesRoleProperties
Nazwa
Opis
Wartość
hostPlatform
Hostowanie systemu operacyjnego obsługiwanego przez rolę Kubernetes.
"Linux" "Windows" (wymagany)
kubernetesClusterInfo
Konfiguracja klastra Kubernetes
KubernetesClusterInfo (wymagane)
kubernetesRoleResources
Zasoby roli platformy Kubernetes
KubernetesRoleResources (wymagane)
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
KubernetesClusterInfo
Nazwa
Opis
Wartość
Wersja
Wersja klastra Kubernetes
ciąg (wymagany)
KubernetesRoleResources
KubernetesRoleCompute
Nazwa
Opis
Wartość
vmProfile
Profil maszyny wirtualnej
ciąg (wymagany)
KubernetesRoleStorage
Nazwa
Opis
Wartość
Punkty końcowe
Instalowanie punktów udziałów w rolach.
MountPointMap []
MECRole
Właściwości MECRoleProperties
Nazwa
Opis
Wartość
Parametry połączenia
Klucz aktywacji mec.
AsymetryczneSzyfrowanesecret
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
Typ zasobu dataBoxEdgeDevices/roles można wdrożyć w następujących elementach:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian .
Aby utworzyć Microsoft. Zasób DataBoxEdge/dataBoxEdgeDevices/roles dodaj następujący element Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-12-01"
name = "string"
parent_id = "string"
// For remaining properties, see dataBoxEdgeDevices/roles objects
body = jsonencode({
kind = "string"
})
}
dataBoxEdgeDevices/roles , obiekty
Ustaw właściwość kind , aby określić typ obiektu.
W przypadku rozwiązania CloudEdgeManagement użyj:
kind = "CloudEdgeManagement"
properties = {
roleStatus = "string"
}
W przypadku IOT użyj:
kind = "IOT"
properties = {
computeResource = {
memoryInGB = int
processorCount = int
}
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"
}
]
}
W przypadku platformy Kubernetes użyj:
kind = "Kubernetes"
properties = {
hostPlatform = "string"
kubernetesClusterInfo = {
version = "string"
}
kubernetesRoleResources = {
compute = {
vmProfile = "string"
}
storage = {
endpoints = [
{
shareId = "string"
}
]
}
}
roleStatus = "string"
}
W przypadku usługi MEC użyj:
kind = "MEC"
properties = {
connectionString = {
encryptionAlgorithm = "string"
encryptionCertThumbprint = "string"
value = "string"
}
roleStatus = "string"
}
Wartości właściwości
dataBoxEdgeDevices/roles
Nazwa
Opis
Wartość
typ
Typ zasobu
"Microsoft. DataBoxEdge/dataBoxEdgeDevices/roles@2020-12-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
CloudEdgeManagement IOT Kubernetes MEC (wymagane)
CloudEdgeManagementRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"CloudEdgeManagement" (wymagane)
properties
Właściwości specyficzne dla roli CloudEdgeManagementRole.
CloudEdgeManagementRoleProperties
CloudEdgeManagementRoleProperties
Nazwa
Opis
Wartość
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
IoTRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"IOT" (wymagane)
properties
Właściwości specyficzne dla roli IoT.
IoTRoleProperties
IoTRoleProperties
Nazwa
Opis
Wartość
computeResource
Alokacja zasobów
ComputeResource
hostPlatform
Hostowanie systemu operacyjnego obsługiwanego 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)
ioTEdgeAgentInfo
Szczegóły agenta usługi Iot Edge w celu pobrania agenta i środowiska uruchomieniowego iot bootstrap.
IoTEdgeAgentInfo
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 []
ComputeResource
Nazwa
Opis
Wartość
memoryInGB
Pamięć w GB
int (wymagane)
processorCount
Liczba procesorów
int (wymagane)
IoTDeviceInfo
Nazwa
Opis
Wartość
uwierzytelnianie
Zaszyfrowane parametry połączenia urządzenia IoT/usługi IoT Edge.
Authentication
deviceId
Identyfikator urządzenia IoT/urządzenia brzegowego.
ciąg (wymagany)
ioTHostHub
Nazwa hosta centrum IoT skojarzonego z urządzeniem.
ciąg (wymagany)
ioTHostHubId
Identyfikator centrum IoT skojarzonego z urządzeniem.
ciąg
Authentication
Nazwa
Opis
Wartość
Symmetrickey
Klucz symetryczny na potrzeby uwierzytelniania.
Symmetrickey
Symmetrickey
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)
IoTEdgeAgentInfo
Nazwa
Opis
Wartość
Imagename
Nazwa obrazu agenta usługi IoT Edge.
ciąg (wymagany)
imageRepository
Szczegóły repozytorium obrazów.
ImageRepositoryCredential
tag
Tag obrazu.
ciąg (wymagany)
ImageRepositoryCredential
Nazwa
Opis
Wartość
imageRepositoryUrl
Adres URL repozytorium obrazów (np. mcr.microsoft.com).
ciąg (wymagany)
hasło
Hasło użytkownika repozytorium.
AsymetryczneSzyfrowanesecret
userName
Nazwa użytkownika repozytorium.
ciąg (wymagany)
MountPointMap
Nazwa
Opis
Wartość
shareId
Identyfikator udziału zainstalowanego na maszynie wirtualnej roli.
ciąg (wymagany)
KubernetesRole
Nazwa
Opis
Wartość
Rodzaju
Typ roli.
"Kubernetes" (wymagane)
properties
Właściwości specyficzne dla roli Kubernetes.
KubernetesRoleProperties
KubernetesRoleProperties
Nazwa
Opis
Wartość
hostPlatform
Hostuj system operacyjny obsługiwany przez rolę Kubernetes.
"Linux" "Windows" (wymagane)
kubernetesClusterInfo
Konfiguracja klastra Kubernetes
KubernetesClusterInfo (wymagane)
kubernetesRoleResources
Zasoby roli platformy Kubernetes
KubernetesRoleResources (wymagane)
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)
KubernetesClusterInfo
Nazwa
Opis
Wartość
Wersja
Wersja klastra Kubernetes
ciąg (wymagany)
KubernetesRoleResources
KubernetesRoleCompute
Nazwa
Opis
Wartość
vmProfile
Profil maszyny wirtualnej
ciąg (wymagany)
KubernetesRoleStorage
Nazwa
Opis
Wartość
Punkty końcowe
Instalowanie punktów udziałów w rolach.
MountPointMap []
MECRole
Właściwości MECRoleProperties
Nazwa
Opis
Wartość
Parametry połączenia
Klucz aktywacji mec.
AsymetryczneSzyfrowanesecret
roleStatus
Stan roli.
"Wyłączone" "Włączone" (wymagane)