Microsoft Azure

DataBoxEdgeManagementClient

DataBoxEdgeManagementClient endpoints from Microsoft Azure

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

DataBoxEdgeManagementClient endpoints from Microsoft Azure

Endpoints 48

Operations

  • GETList all the supported operations./providers/Microsoft.DataBoxEdge/operations?api-version=string

Devices

  • GETDevices_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices?api-version=string&$expand=stringGets all the data box edge/gateway devices in a subscription.
  • GETDevices_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices?api-version=string&$expand=stringGets all the data box edge/gateway devices in a resource group.
  • GETDevices_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName?api-version=stringGets the properties of the data box edge/gateway device.
  • PUTDevices_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName?api-version=stringCreates or updates a Data Box Edge/Gateway resource.
  • DELETEDevices_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName?api-version=stringDeletes the data box edge/gateway device.
  • PATCHDevices_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName?api-version=stringModifies a Data Box Edge/Gateway resource.
  • POSTDownloads the updates on a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/downloadUpdates?api-version=string
  • POSTDevices_GetExtendedInformation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/getExtendedInformation?api-version=stringGets additional information for the specified data box edge/gateway device.
  • POSTInstalls the updates on the data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/installUpdates?api-version=string
  • GETDevices_GetNetworkSettings/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/networkSettings/default?api-version=stringGets the network settings of the specified data box edge/gateway device.
  • POSTScans for updates on a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/scanForUpdates?api-version=string
  • POSTDevices_CreateOrUpdateSecuritySettings/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/securitySettings/default/update?api-version=stringUpdates the security settings on a data box edge/gateway device.
  • GETGets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/updateSummary/default?api-version=string
  • POSTDevices_UploadCertificate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/uploadCertificate?api-version=stringUploads registration certificate for the device.

Alerts

  • GETAlerts_ListByDataBoxEdgeDevice/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/alerts?api-version=stringGets all the alerts for a data box edge/gateway device.
  • GETGets an alert by name./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/alerts/:name?api-version=string

BandwidthSchedules

  • GETBandwidthSchedules_ListByDataBoxEdgeDevice/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules?api-version=stringGets all the bandwidth schedules for a data box edge/gateway device.
  • GETBandwidthSchedules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules/:name?api-version=stringGets the properties of the specified bandwidth schedule.
  • PUTBandwidthSchedules_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules/:name?api-version=stringCreates or updates a bandwidth schedule.
  • DELETEBandwidthSchedules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/bandwidthSchedules/:name?api-version=stringDeletes the specified bandwidth schedule.

Jobs

  • GETGets the details of a specified job on a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/jobs/:name?api-version=string

OperationsStatus

  • GETGets the details of a specified job on a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/operationsStatus/:name?api-version=string

Orders

  • GETLists all the orders related to a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders?api-version=string
  • GETGets a specific order by name./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders/default?api-version=string
  • PUTCreates or updates an order./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders/default?api-version=string
  • DELETEDeletes the order related to the device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/orders/default?api-version=string

Roles

  • GETRoles_ListByDataBoxEdgeDevice/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles?api-version=stringLists all the roles configured in a data box edge/gateway device.
  • GETRoles_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles/:name?api-version=stringGets a specific role by name.
  • PUTRoles_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles/:name?api-version=stringCreate or update a role.
  • DELETERoles_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/roles/:name?api-version=stringDeletes the role on the data box edge device.

Shares

  • GETLists all the shares in a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares?api-version=string
  • GETGets a share by name./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name?api-version=string
  • PUTCreates a new share or updates an existing share on the device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name?api-version=string
  • DELETEShares_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name?api-version=stringDeletes the share on the data box edge/gateway device.
  • POSTRefreshes the share metadata with the data from the cloud./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/shares/:name/refresh?api-version=string

StorageAccountCredentials

  • GETGets all the storage account credentials in a data box edge/gateway device./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials?api-version=string
  • GETStorageAccountCredentials_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials/:name?api-version=stringGets the properties of the specified storage account credential.
  • PUTStorageAccountCredentials_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials/:name?api-version=stringCreates or updates the storage account credential.
  • DELETEStorageAccountCredentials_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/storageAccountCredentials/:name?api-version=stringDeletes the storage account credential.

Triggers

  • GETTriggers_ListByDataBoxEdgeDevice/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers?api-version=string&$expand=stringLists all the triggers configured in the device.
  • GETTriggers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers/:name?api-version=stringGet a specific trigger by name.
  • PUTTriggers_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers/:name?api-version=stringCreates or updates a trigger.
  • DELETETriggers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/triggers/:name?api-version=stringDeletes the trigger on the gateway device.

Users

  • GETUsers_ListByDataBoxEdgeDevice/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users?api-version=stringGets all the users registered on a data box edge/gateway device.
  • GETUsers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users/:name?api-version=stringGets the properties of the specified user.
  • PUTUsers_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users/:name?api-version=stringCreates a new user or updates an existing user's information on a data box edge/gateway device.
  • DELETEUsers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/users/:name?api-version=stringDeletes the user on a databox edge/gateway device.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
48 operations on 31 pathsGET 24PUT 8DELETE 8POST 7PATCH 1
Main resources
Devices 14Shares 5BandwidthSchedules 4Orders 4Roles 4StorageAccountCredentials 4Triggers 4Users 4Alerts 2Jobs 1
Response formats
application/json
Description format
Swagger 2.0, API version 2019-03-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the DataBoxEdgeManagementClient in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DataBoxEdgeManagementClient collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List all the supported operations.” (GET /providers/Microsoft.DataBoxEdge/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DataBoxEdgeManagementClient?

DataBoxEdgeManagementClient endpoints from Microsoft Azure It is listed under Data & analytics and has 48 endpoints.

Who publishes the DataBoxEdgeManagementClient?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the DataBoxEdgeManagementClient?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the DataBoxEdgeManagementClient?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the DataBoxEdgeManagementClient have?

48 operations on 31 paths (24 GET, 8 PUT, 8 DELETE, 7 POST, 1 PATCH). The largest groups are Devices, Shares, BandwidthSchedules, Orders.

Is forking the DataBoxEdgeManagementClient free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.