Поделиться через

Изменения в управлении ролями IoT Edge для устройства Azure Stack Edge

Для управления ролями Azure IoT Edge на устройстве Azure Stack Edge следует использовать обновленные версии API, пакета SDK и Azure PowerShell, которые будут включены в обновление за январь 2021 года.

В этой статье подробно описаны изменения, которые придется внести для использования этой последней версии.

Обновление за январь 2021 года затрагивает только устройства Azure Stack Edge Pro: GPU, Azure Stack Edge Pro R и Azure Stack Edge Mini R. Сведения в этой статье применимы только к указанным устройствам.

Примечание

Обновление до версии за январь 2021 года не является обязательным. Вы можете и далее использовать текущую версию. В таком случае управление ролями IoT Edge никак не изменится. Но мы рекомендуем установить новую версию, чтобы использовать новые возможности и снизить риски безопасности.

Изменения в управлении ролями IoT Edge

После установки необязательного обновления за январь 2021 года на устройстве Azure Stack Edge для управления ролями IoT Edge потребуется использовать только последнюю версию API, пакета SDK и командлетов PowerShell.

Следующие изменения станут обязательными только после применения обновления за январь 2021 года.

  • Если вы используете API управления ролями версии 2019-08-01, выполните обновление до версии API, которая будет выпущена в январе 2021 г.
  • Если вы используете управление ролями с помощью пакета SDK версии 1.0.0, обновите ее до версии, которая будет выпущена в январе 2021 г.
  • Если вы используете для управления ролями командлеты Azure PowerShell (предварительная версия), такие как Get-AzStackEdgeRole, New-AzStackEdgeRole, Set-AzStackEdgeRole или Remove-AzStackEdgeRole, дождитесь выхода новых командлетов в феврале 2021 года.

Использование API

Если вы сейчас управляете ролями IoT Edge через API, следует использовать новую версию API 2020-12-01, которая будет опубликована позже. Если вы используете текущий API ролей, то после установки предстоящей версии программного обеспечения устройства необходимо перейти к ролям Kubernetes PUT, GET, DELETE, а затем добавить API надстройки IoT PUT.

Для метода PUT

Как выглядит HTTP-запрос сейчас

  • Вызовы API выполняются по следующему URI: https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1?api-version=2019-08-01

  • Текст запроса выглядит следующим образом:

    {
    "kind": "IOT",
    "properties": {
        "hostPlatform": "Linux",
        "ioTDeviceDetails": {
            "deviceId": "iotdevice",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {
                    "connectionString": {
                        "value": "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                        "encryptionCertThumbprint": "348586569999244",
                        "encryptionAlgorithm": "AES256"
                    }
                }
            }
        },
        "ioTEdgeDeviceDetails": {
            "deviceId": "iotEdge",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {
                    "connectionString": {
                        "value": "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                        "encryptionCertThumbprint": "1245475856069999244",
                        "encryptionAlgorithm": "AES256"
                    }
                }
            }
        },
        "shareMappings": [],
        "roleStatus": "Enabled"
    }
}

Как будет выглядеть HTTP-запрос

  • Вызовы API для роли Kubernetes выполняются по следующему URI:

    'https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/KubernetesRole1?api-version=2020-12-01'

    Текст запроса будет выглядеть так:

    {
    "kind": "Kubernetes",
    "properties": {
        "hostPlatform": "Linux",
        "kubernetesClusterInfo": {
            "version": "v1.17.3"
        },
        "kubernetesRoleResources": {
            "storage": {
                "endpoints": []
            },
            "compute": {
                "vmProfile": "DS1_v2"
            }
        }
    }
}

  • Вызовы API для надстройки IoT Edge выполняются по следующему URI:

    'https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/KubernetesRole1/addons/iotaddon?api-version=2020-12-01'

    Текст запроса будет выглядеть так:

    {
    "kind": "IoT",
    "properties": {
        "ioTDeviceDetails": {
            "deviceId": "iotdevice",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {
                    "connectionString": {
                        "value": "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                        "encryptionCertThumbprint": "348586569999244",
                        "encryptionAlgorithm": "AES256"
                    }
                }
            }
        },
        "ioTEdgeDeviceDetails": {
            "deviceId": "iotEdge",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {
                    "connectionString": {
                        "value": "Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>",
                        "encryptionCertThumbprint": "1245475856069999244",
                        "encryptionAlgorithm": "AES256"
                    }
                }
            }
        }
    }
}

Для метода GET

Как выглядит HTTP-ответ сейчас

  • Вызовы API выполняются по этому URI:

    'https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1?api-version=2019-08-01'

  • Текст ответа выглядит следующим образом:

        "kind": "IOT",
    "properties": {
        "hostPlatform": "Linux",
        "ioTDeviceDetails": {
            "deviceId": "iotdevice",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {}
            }
        },
        "ioTEdgeDeviceDetails": {
            "deviceId": "iotEdge",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {}
            }
        },
        "shareMappings": [],
        "roleStatus": "Enabled"
    },
    "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
    "name": "IoTRole1",
    "type": "dataBoxEdgeDevices/roles"
}

Как будет выглядеть HTTP-ответ

  • Вызовы API выполняются по этому URI:

    'https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/KubernetesRole1/addons/iotaddon?api-version=2020-12-01'

  • Текст ответа выглядит следующим образом:

    {
    "kind": "IoT",
    "properties": {
        "provisioningState": "Creating",
        "ioTDeviceDetails": {
            "deviceId": "iotdevice",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {}
            }
        },
        "ioTEdgeDeviceDetails": {
            "deviceId": "iotEdge",
            "ioTHostHub": "iothub.azure-devices.net",
            "ioTHostHubId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/Microsoft.Devices/IotHubs/testrxiothub",
            "authentication": {
                "symmetricKey": {}
            }
        },
        "version": "0.1.0-beta10"
    },
    "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/res1/roles/kubernetesRole/addons/iotName",
    "name": " iotName",
    "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addon",
}

Для метода DELETE

Как выглядят вызовы API сейчас

Вызовы API выполняются по этому URI:

'https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1?api-version=2019-08-01'

Как будут выглядеть вызовы API

Вызовы API выполняются по этому URI:

'https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/KubernetesRole1/addons/iotaddon?api-version=2020-12-01'

Использование пакета SDK

Если вы используете пакет SDK, после установки обновления за январь 2021 года придется изменить способ настройки роли IoT Edge, как показано в следующем примере. После этого следует скачать и установить следующую версию пакета NuGet, чтобы перейти к использованию нового пакета SDK, как показано в следующем примере.

Пример для текущей версии пакета SDK

var iotRoleStatus = "Enabled";
var iotHostPlatform = "Linux";
var id = $@"/subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/resourceGroups/resourceGroup/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceName/roles/iotrole"; 
var name = "iotrole";
var type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/role";
var iotRoleName = "iotrole";
var ioTDeviceDetails = new IoTDeviceInfo(...);
var ioTEdgeDeviceDetails = new IoTDeviceInfo(...);
var ioTEdgeAgentInfo = new IoTEdgeAgentInfo(...);
var shareMappings = new List<MountPointMap>(...);

var role = new IoTRole(roleStatus, 
    hostPlatform, 
    shareMappings, 
    ioTDeviceDetails, 
    ioTEdgeDeviceDetails, 
    ioTEdgeAgentInfo, 
    id, 
    name, 
    type);

DataBoxEdgeManagementClient.Roles.CreateOrUpdate(deviceName, iotRoleName, role, resourceGroup);

Пример для новой версии пакета SDK

var k8sRoleStatus = "Enabled";
var k8sHostPlatform = "Linux";
var k8sId = $@"/subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/resourceGroups/resourceGroup/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceName/roles/KubernetesRole"; 
var k8sRoleName = "KubernetesRole";
var k8sClusterVersion = "v1.17.3"; //Final values will be updated here around January 2021
var k8sVmProfile = "DS1_v2"; //Final values will be updated here around January 2021
var type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/role";
var k8sRole = new KubernetesRole(
    roleStatus,
    hostPlatform,
    shareMappings,
    k8sClusterVersion,
    k8sVmProfile,
    k8sId,
    k8sRoleName,
    type
);
DataBoxEdgeManagementClient.Roles.CreateOrUpdate(deviceName, k8sRoleName, k8sRole, resourceGroup); //Final usage will be updated here around January 2021

var ioTId = $@"/subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/resourceGroups/resourceGroup/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceName/roles/KubernetesRole/addons/iotaddon";
var ioTAddonName = "iotaddon";
var ioTAddonType = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons";
var addon = new IoTAddon(
    ioTDeviceDetails, 
    ioTEdgeDeviceDetails, 
    ioTEdgeAgentInfo, 
    ioTId, 
    ioTAddonName, 
    ioTAddonType);
DataBoxEdgeManagementClient.AddOns.CreateOrUpdate(deviceName, k8sRoleName, addonName, addon, resourceGroup); //Final usage will be updated here around January 2021

Использование командлетов

Если вы используете командлеты Get-AzStackEdgeRole, New-AzStackEdgeRole, Set-AzStackEdgeRole или Remove-AzStackEdgeRole, вам придется дождаться новой версии, выпуск которой запланирован на февраль 2021 года.

Часто задаваемые вопросы

Я использую Azure Stack Edge Pro — ППВМ. Влияет ли обновление за январь 2021 года на модель ППВМ?

Нет. Обновление за январь 2021 года затрагивает только устройства Azure Stack Edge Pro (ППВМ), Azure Stack Edge Pro R и Azure Stack Edge Mini R. Это обновление не затрагивает устройства Azure Stack Edge Pro (ППВМ) и не требует каких-либо изменений в управлении ролями IoT Edge.

Будут ли затронуты какие-либо из имеющихся служб после обновления Azure Stack Edge Pro (GPU) за январь 2021 года?

Нет. Установка обновления для устройств за январь 2021 года не затронет настроенные службы.

Каковы общие изменения в API, пакете SDK и командлетах для управления IoT Edge?

IoT Edge — это надстройка в роли Kubernetes, а значит вам придется сначала правильно настроить Kubernetes, а затем выполнить настройку IoT Edge.

Следующие шаги

  • Last updated on