|
| 1 | +# Azure CLI databoxedge Extension # |
| 2 | +This is the extension for databoxedge |
| 3 | + |
| 4 | +### How to use ### |
| 5 | +Install this extension using the below CLI command |
| 6 | +``` |
| 7 | +az extension add --name databoxedge |
| 8 | +``` |
| 9 | + |
| 10 | +### Included Features ### |
| 11 | +#### databoxedge available-sku #### |
| 12 | +##### List ##### |
| 13 | +``` |
| 14 | +az databoxedge available-sku list |
| 15 | +``` |
| 16 | +#### databoxedge device #### |
| 17 | +##### Create ##### |
| 18 | +``` |
| 19 | +az databoxedge device create --location "WUS" --sku name="Edge" tier="Standard" --name "testedgedevice" \ |
| 20 | + --resource-group "GroupForEdgeAutomation" |
| 21 | +``` |
| 22 | +##### Show ##### |
| 23 | +``` |
| 24 | +az databoxedge device show --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 25 | +``` |
| 26 | +##### List ##### |
| 27 | +``` |
| 28 | +az databoxedge device list --resource-group "GroupForEdgeAutomation" |
| 29 | +``` |
| 30 | +##### Update ##### |
| 31 | +``` |
| 32 | +az databoxedge device update --name "testedgedevice" \ |
| 33 | + --id "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/rapvs-rg/providers/Microsoft.AzureStack/linkedSubscriptions/ca014ddc-5cf2-45f8-b390-e901e4a0ae87" \ |
| 34 | + --resource-group "GroupForEdgeAutomation" |
| 35 | +``` |
| 36 | +##### Create-or-update-security-setting ##### |
| 37 | +``` |
| 38 | +az databoxedge device create-or-update-security-setting --name "testedgedevice" --resource-group "AzureVM" \ |
| 39 | + --device-admin-password encryption-algorithm="AES256" encryption-cert-thumbprint="<encryptionThumprint>" value="<deviceAdminPassword>" |
| 40 | +``` |
| 41 | +##### Download-update ##### |
| 42 | +``` |
| 43 | +az databoxedge device download-update --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 44 | +``` |
| 45 | +##### Generate-certificate ##### |
| 46 | +``` |
| 47 | +az databoxedge device generate-certificate --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 48 | +``` |
| 49 | +##### Get-extended-information ##### |
| 50 | +``` |
| 51 | +az databoxedge device get-extended-information --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 52 | +``` |
| 53 | +##### Install-update ##### |
| 54 | +``` |
| 55 | +az databoxedge device install-update --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 56 | +``` |
| 57 | +##### Scan-for-update ##### |
| 58 | +``` |
| 59 | +az databoxedge device scan-for-update --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 60 | +``` |
| 61 | +##### Show-network-setting ##### |
| 62 | +``` |
| 63 | +az databoxedge device show-network-setting --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 64 | +``` |
| 65 | +##### Show-update-summary ##### |
| 66 | +``` |
| 67 | +az databoxedge device show-update-summary --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 68 | +``` |
| 69 | +##### Update-extended-information ##### |
| 70 | +``` |
| 71 | +az databoxedge device update-extended-information --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 72 | +``` |
| 73 | +##### Upload-certificate ##### |
| 74 | +``` |
| 75 | +az databoxedge device upload-certificate --name "testedgedevice" \ |
| 76 | + --certificate "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" \ |
| 77 | + --resource-group "GroupForEdgeAutomation" |
| 78 | +``` |
| 79 | +##### Delete ##### |
| 80 | +``` |
| 81 | +az databoxedge device delete --name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 82 | +``` |
| 83 | +#### databoxedge alert #### |
| 84 | +##### List ##### |
| 85 | +``` |
| 86 | +az databoxedge alert list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 87 | +``` |
| 88 | +##### Show ##### |
| 89 | +``` |
| 90 | +az databoxedge alert show --name "159a00c7-8543-4343-9435-263ac87df3bb" --device-name "testedgedevice" \ |
| 91 | + --resource-group "GroupForEdgeAutomation" |
| 92 | +``` |
| 93 | +#### databoxedge bandwidth-schedule #### |
| 94 | +##### Create ##### |
| 95 | +``` |
| 96 | +az databoxedge bandwidth-schedule create --name "bandwidth-1" --device-name "testedgedevice" --days "Sunday" "Monday" \ |
| 97 | + --rate-in-mbps 100 --start "0:0:0" --stop "13:59:0" --resource-group "GroupForEdgeAutomation" |
| 98 | +``` |
| 99 | +##### Show ##### |
| 100 | +``` |
| 101 | +az databoxedge bandwidth-schedule show --name "bandwidth-1" --device-name "testedgedevice" \ |
| 102 | + --resource-group "GroupForEdgeAutomation" |
| 103 | +``` |
| 104 | +##### List ##### |
| 105 | +``` |
| 106 | +az databoxedge bandwidth-schedule list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 107 | +``` |
| 108 | +##### Delete ##### |
| 109 | +``` |
| 110 | +az databoxedge bandwidth-schedule delete --name "bandwidth-1" --device-name "testedgedevice" \ |
| 111 | + --resource-group "GroupForEdgeAutomation" |
| 112 | +``` |
| 113 | +#### databoxedge job #### |
| 114 | +##### Show ##### |
| 115 | +``` |
| 116 | +az databoxedge job show --name "159a00c7-8543-4343-9435-263ac87df3bb" --device-name "testedgedevice" \ |
| 117 | + --resource-group "GroupForEdgeAutomation" |
| 118 | +``` |
| 119 | +#### databoxedge node #### |
| 120 | +##### List ##### |
| 121 | +``` |
| 122 | +az databoxedge node list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 123 | +``` |
| 124 | +#### databoxedge operation-status #### |
| 125 | +##### Show ##### |
| 126 | +``` |
| 127 | +az databoxedge operation-status show --name "159a00c7-8543-4343-9435-263ac87df3bb" --device-name "testedgedevice" \ |
| 128 | + --resource-group "GroupForEdgeAutomation" |
| 129 | +``` |
| 130 | +#### databoxedge order #### |
| 131 | +##### Create ##### |
| 132 | +``` |
| 133 | +az databoxedge order create --device-name "testedgedevice" \ |
| 134 | + --contact-information company-name="Microsoft" contact-person="John Mcclane" email-list="[email protected]" phone="(800) 426-9400" \ |
| 135 | + --shipping-address address-line1="Microsoft Corporation" address-line2="One Microsoft Way" address-line3="Redmond" city="WA" country="USA" postal-code="98052" state="WA" \ |
| 136 | + --resource-group "GroupForEdgeAutomation" |
| 137 | +``` |
| 138 | +##### Show ##### |
| 139 | +``` |
| 140 | +az databoxedge order show --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 141 | +``` |
| 142 | +##### List ##### |
| 143 | +``` |
| 144 | +az databoxedge order list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 145 | +``` |
| 146 | +##### List-dc-access-code ##### |
| 147 | +``` |
| 148 | +az databoxedge order list-dc-access-code --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 149 | +``` |
| 150 | +##### Delete ##### |
| 151 | +``` |
| 152 | +az databoxedge order delete --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 153 | +``` |
| 154 | +#### databoxedge role #### |
| 155 | +##### Create ##### |
| 156 | +``` |
| 157 | +az databoxedge role create --name "IoTRole1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 158 | + --role "{\\"kind\\":\\"IOT\\",\\"properties\\":{\\"hostPlatform\\":\\"Linux\\",\\"ioTDeviceDetails\\":{\\"authentication\\":{\\"symmetricKey\\":{\\"connectionString\\":{\\"encryptionAlgorithm\\":\\"AES256\\",\\"encryptionCertThumbprint\\":\\"348586569999244\\",\\"value\\":\\"Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotDevice;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>\\"}}},\\"deviceId\\":\\"iotdevice\\",\\"ioTHostHub\\":\\"iothub.azure-devices.net\\"},\\"ioTEdgeDeviceDetails\\":{\\"authentication\\":{\\"symmetricKey\\":{\\"connectionString\\":{\\"encryptionAlgorithm\\":\\"AES256\\",\\"encryptionCertThumbprint\\":\\"1245475856069999244\\",\\"value\\":\\"Encrypted<<HostName=iothub.azure-devices.net;DeviceId=iotEdge;SharedAccessKey=2C750FscEas3JmQ8Bnui5yQWZPyml0/UiRt1bQwd8=>>\\"}}},\\"deviceId\\":\\"iotEdge\\",\\"ioTHostHub\\":\\"iothub.azure-devices.net\\"},\\"roleStatus\\":\\"Enabled\\",\\"shareMappings\\":[]}}" |
| 159 | +``` |
| 160 | +##### Show ##### |
| 161 | +``` |
| 162 | +az databoxedge role show --name "IoTRole1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 163 | +``` |
| 164 | +##### List ##### |
| 165 | +``` |
| 166 | +az databoxedge role list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 167 | +``` |
| 168 | +##### Delete ##### |
| 169 | +``` |
| 170 | +az databoxedge role delete --name "IoTRole1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 171 | +``` |
| 172 | +#### databoxedge addon #### |
| 173 | +##### Create ##### |
| 174 | +``` |
| 175 | +az databoxedge addon create \ |
| 176 | + --addon "{\\"kind\\":\\"ArcForKubernetes\\",\\"properties\\":{\\"resourceGroupName\\":\\"GroupForEdgeAutomation\\",\\"resourceLocation\\":\\"EastUS\\",\\"resourceName\\":\\"testedgedevice\\",\\"subscriptionId\\":\\"4385cf00-2d3a-425a-832f-f4285b1c9dce\\"}}" \ |
| 177 | + --name "arcName" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 178 | + --role-name "KubernetesRole" |
| 179 | +``` |
| 180 | +##### Show ##### |
| 181 | +``` |
| 182 | +az databoxedge addon show --name "arcName" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 183 | + --role-name "KubernetesRole" |
| 184 | +``` |
| 185 | +##### List ##### |
| 186 | +``` |
| 187 | +az databoxedge addon list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 188 | + --role-name "IoTRole1" |
| 189 | +``` |
| 190 | +##### Delete ##### |
| 191 | +``` |
| 192 | +az databoxedge addon delete --name "arcName" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 193 | + --role-name "KubernetesRole" |
| 194 | +``` |
| 195 | +#### databoxedge monitoring-config #### |
| 196 | +##### Create ##### |
| 197 | +``` |
| 198 | +az databoxedge monitoring-config create --device-name "testedgedevice" \ |
| 199 | + --metric-configurations "[{\\"counterSets\\":[{\\"counters\\":[{\\"name\\":\\"test\\"}]}],\\"mdmAccount\\":\\"test\\",\\"metricNameSpace\\":\\"test\\",\\"resourceId\\":\\"test\\"}]" \ |
| 200 | + --resource-group "GroupForEdgeAutomation" --role-name "testrole" |
| 201 | +``` |
| 202 | +##### Show ##### |
| 203 | +``` |
| 204 | +az databoxedge monitoring-config show --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 205 | + --role-name "testrole" |
| 206 | +``` |
| 207 | +##### List ##### |
| 208 | +``` |
| 209 | +az databoxedge monitoring-config list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 210 | + --role-name "testrole" |
| 211 | +``` |
| 212 | +##### Delete ##### |
| 213 | +``` |
| 214 | +az databoxedge monitoring-config delete --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 215 | + --role-name "testrole" |
| 216 | +``` |
| 217 | +#### databoxedge share #### |
| 218 | +##### Create ##### |
| 219 | +``` |
| 220 | +az databoxedge share create --name "smbshare" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 221 | + --description "" --access-protocol "SMB" \ |
| 222 | + --azure-container-info container-name="testContainerSMB" data-format="BlockBlob" storage-account-credential-id="/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1" \ |
| 223 | + --data-policy "Cloud" --monitoring-status "Enabled" --share-status "Online" \ |
| 224 | + --user-access-rights access-type="Change" user-id="/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2" |
| 225 | +``` |
| 226 | +##### Show ##### |
| 227 | +``` |
| 228 | +az databoxedge share show --name "smbshare" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 229 | +``` |
| 230 | +##### List ##### |
| 231 | +``` |
| 232 | +az databoxedge share list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 233 | +``` |
| 234 | +##### Refresh ##### |
| 235 | +``` |
| 236 | +az databoxedge share refresh --name "smbshare" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 237 | +``` |
| 238 | +##### Delete ##### |
| 239 | +``` |
| 240 | +az databoxedge share delete --name "smbshare" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 241 | +``` |
| 242 | +#### databoxedge storage-account-credentials #### |
| 243 | +##### List ##### |
| 244 | +``` |
| 245 | +az databoxedge storage-account-credentials list --device-name "testedgedevice" \ |
| 246 | + --resource-group "GroupForEdgeAutomation" |
| 247 | +``` |
| 248 | +##### Show ##### |
| 249 | +``` |
| 250 | +az databoxedge storage-account-credentials show --name "sac1" --device-name "testedgedevice" \ |
| 251 | + --resource-group "GroupForEdgeAutomation" |
| 252 | +``` |
| 253 | +##### Delete ##### |
| 254 | +``` |
| 255 | +az databoxedge storage-account-credentials delete --name "sac1" --device-name "testedgedevice" \ |
| 256 | + --resource-group "GroupForEdgeAutomation" |
| 257 | +``` |
| 258 | +#### databoxedge storage-account #### |
| 259 | +##### List ##### |
| 260 | +``` |
| 261 | +az databoxedge storage-account list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 262 | +``` |
| 263 | +##### Show ##### |
| 264 | +``` |
| 265 | +az databoxedge storage-account show --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 266 | + --name "blobstorageaccount1" |
| 267 | +``` |
| 268 | +##### Delete ##### |
| 269 | +``` |
| 270 | +az databoxedge storage-account delete --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 271 | + --name "storageaccount1" |
| 272 | +``` |
| 273 | +#### databoxedge container #### |
| 274 | +##### Create ##### |
| 275 | +``` |
| 276 | +az databoxedge container create --data-format "BlockBlob" --name "blobcontainer1" --device-name "testedgedevice" \ |
| 277 | + --resource-group "GroupForEdgeAutomation" --storage-account-name "storageaccount1" |
| 278 | +``` |
| 279 | +##### Show ##### |
| 280 | +``` |
| 281 | +az databoxedge container show --name "blobcontainer1" --device-name "testedgedevice" \ |
| 282 | + --resource-group "GroupForEdgeAutomation" --storage-account-name "storageaccount1" |
| 283 | +``` |
| 284 | +##### List ##### |
| 285 | +``` |
| 286 | +az databoxedge container list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 287 | + --storage-account-name "storageaccount1" |
| 288 | +``` |
| 289 | +##### Refresh ##### |
| 290 | +``` |
| 291 | +az databoxedge container refresh --name "blobcontainer1" --device-name "testedgedevice" \ |
| 292 | + --resource-group "GroupForEdgeAutomation" --storage-account-name "storageaccount1" |
| 293 | +``` |
| 294 | +##### Delete ##### |
| 295 | +``` |
| 296 | +az databoxedge container delete --name "blobcontainer1" --device-name "testedgedevice" \ |
| 297 | + --resource-group "GroupForEdgeAutomation" --storage-account-name "storageaccount1" |
| 298 | +``` |
| 299 | +#### databoxedge trigger #### |
| 300 | +##### Create ##### |
| 301 | +``` |
| 302 | +az databoxedge trigger create --name "trigger1" --device-name "testedgedevice" \ |
| 303 | + --resource-group "GroupForEdgeAutomation" \ |
| 304 | + --file-event-trigger custom-context-tag="CustomContextTags-1235346475" role-id="/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" share-id="/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" |
| 305 | +``` |
| 306 | +##### Show ##### |
| 307 | +``` |
| 308 | +az databoxedge trigger show --name "trigger1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 309 | +``` |
| 310 | +##### List ##### |
| 311 | +``` |
| 312 | +az databoxedge trigger list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 313 | +``` |
| 314 | +##### Delete ##### |
| 315 | +``` |
| 316 | +az databoxedge trigger delete --name "trigger1" --device-name "testedgedevice" \ |
| 317 | + --resource-group "GroupForEdgeAutomation" |
| 318 | +``` |
| 319 | +#### databoxedge user #### |
| 320 | +##### Create ##### |
| 321 | +``` |
| 322 | +az databoxedge user create --name "user1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" \ |
| 323 | + --encrypted-password encryption-algorithm="None" encryption-cert-thumbprint="blah" value="<value>" \ |
| 324 | + --user-type "Share" |
| 325 | +``` |
| 326 | +##### Show ##### |
| 327 | +``` |
| 328 | +az databoxedge user show --name "user1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 329 | +``` |
| 330 | +##### List ##### |
| 331 | +``` |
| 332 | +az databoxedge user list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 333 | +``` |
| 334 | +##### Delete ##### |
| 335 | +``` |
| 336 | +az databoxedge user delete --name "user1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" |
| 337 | +``` |
0 commit comments