{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-databoxedge","description":"DataBoxEdgeManagementClient","version":"2019-07-01","base_url":"https://management.azure.com","endpoints":49,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api DataBoxEdgeManagementClient\n@base https://management.azure.com\n@version 2019-07-01\n@auth OAuth2\n@common_fields {api-version: any # The API version., subscriptionId: any # The subscription ID., resourceGroupName: any # The resource group name.}\n@endpoints 49\n@hint download_for_search\n@toc providers(1), subscriptions(48)\n\n@group providers\n@endpoint GET /providers/Microsoft.DataBoxEdge/operations\n@desc List all the supported operations.\n@returns(200) List of supported operations.\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices\n@desc Gets all the Data Box Edge/Data Box Gateway devices in a subscription.\n@optional {$expand: any # Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.}\n@returns(200) The collection of Data Box Edge/Data Box Gateway devices.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices\n@desc Gets all the Data Box Edge/Data Box Gateway devices in a resource group.\n@optional {$expand: any # Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.}\n@returns(200) The collection of Data Box Edge/Data Box Gateway devices.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}\n@desc Gets the properties of the Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The Data Box Edge/Data Box Gateway device.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}\n@desc Creates or updates a Data Box Edge/Data Box Gateway resource.\n@required {deviceName: any # The device name., DataBoxEdgeDevice: map # The resource object.}\n@returns(200) Successfully created or updated the resource.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}\n@desc Deletes the Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) Successfully deleted the resource.\n@returns(202) Accepted the request to delete the resource.\n@returns(204) The resource is already deleted.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}\n@desc Modifies a Data Box Edge/Data Box Gateway resource.\n@required {deviceName: any # The device name., parameters: map # The resource parameters.}\n@returns(200) Successfully updated the resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts\n@desc Gets all the alerts for a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The collection of alerts.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}\n@desc Gets an alert by name.\n@required {deviceName: any # The device name., name: any # The alert name.}\n@returns(200) The alert details.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules\n@desc Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The collection of bandwidth schedules.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}\n@desc Gets the properties of the specified bandwidth schedule.\n@required {deviceName: any # The device name., name: any # The bandwidth schedule name.}\n@returns(200) The bandwidth schedule.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}\n@desc Creates or updates a bandwidth schedule.\n@required {deviceName: any # The device name., name: any # The bandwidth schedule name which needs to be added/updated., parameters: map # The bandwidth schedule to be added or updated.}\n@returns(200) Successfully created or updated the bandwidth schedule.\n@returns(202) Accepted the request to create or update the bandwidth schedule.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}\n@desc Deletes the specified bandwidth schedule.\n@required {deviceName: any # The device name., name: any # The bandwidth schedule name.}\n@returns(200) Successfully deleted the bandwidth schedule.\n@returns(202) Accepted the request to delete the bandwidth schedule.\n@returns(204) Successfully deleted the bandwidth schedule.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates\n@desc Downloads the updates on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) Successfully downloaded the updates on the device.\n@returns(202) Accepted the request to download the updates on the device.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation\n@desc Gets additional information for the specified Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The additional information.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates\n@desc Installs the updates on the Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) Successfully installed updates on the device.\n@returns(202) Accepted the request to install updates on the device.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}\n@desc Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name., name: any # The job name.}\n@returns(200) The job details.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default\n@desc Gets the network settings of the specified Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The device network settings.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes\n@desc Gets all the nodes currently configured under this Data Box Edge device\n@required {deviceName: any # The device name.}\n@returns(200) The collection of all nodes on the device.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}\n@desc Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name., name: any # The job name.}\n@returns(200) The job details.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders\n@desc Lists all the orders related to a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) Lists all the orders for the Data Box Edge Device\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default\n@desc Gets a specific order by name.\n@required {deviceName: any # The device name.}\n@returns(200) The order details of a device.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default\n@desc Creates or updates an order.\n@required {deviceName: any # The device name., order: map # The order to be created or updated.}\n@returns(200) Successfully created or updated the order.\n@returns(202) Accepted the request to create or update the order.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default\n@desc Deletes the order related to the device.\n@required {deviceName: any # The device name.}\n@returns(200) Successfully deleted the order.\n@returns(202) Accepted the request to delete the order.\n@returns(204) The order is already deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles\n@desc Lists all the roles configured in a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) List of all the roles configured in the device.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}\n@desc Gets a specific role by name.\n@required {deviceName: any # The device name., name: any # The role name.}\n@returns(200) The role with the specified name in the given device.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}\n@desc Create or update a role.\n@required {deviceName: any # The device name., name: any # The role name., role: map # The role properties.}\n@returns(200) Successfully created or updated the role.\n@returns(202) Accepted the request to create or update the role.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}\n@desc Deletes the role on the device.\n@required {deviceName: any # The device name., name: any # The role name.}\n@returns(200) Successfully deleted the role.\n@returns(202) Accepted the request to delete the role.\n@returns(204) The role is already deleted.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates\n@desc Scans for updates on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) Successfully scanned the device for updates.\n@returns(202) Accepted the request to scan for updates on the device.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update\n@desc Updates the security settings on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name., securitySettings: map # The security settings.}\n@returns(202) Accepted the request to update the security settings.\n@returns(204) Updated the security settings.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares\n@desc Lists all the shares in a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The collection of all the shares on the device.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}\n@desc Gets a share by name.\n@required {deviceName: any # The device name., name: any # The share name.}\n@returns(200) The share details.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}\n@desc Creates a new share or updates an existing share on the device.\n@required {deviceName: any # The device name., name: any # The share name., share: map # The share properties.}\n@returns(200) Successfully created or updated the share.\n@returns(202) Accepted the request to create or update the share.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}\n@desc Deletes the share on the Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name., name: any # The share name.}\n@returns(200) Successfully deleted the share.\n@returns(202) Accepted the request to delete the share.\n@returns(204) The share is already deleted.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh\n@desc Refreshes the share metadata with the data from the cloud.\n@required {deviceName: any # The device name., name: any # The share name.}\n@returns(200) Successfully refreshed the share on the device.\n@returns(202) Accepted the request to refresh the share on the device.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials\n@desc Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The collection of storage account credentials.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}\n@desc Gets the properties of the specified storage account credential.\n@required {deviceName: any # The device name., name: any # The storage account credential name.}\n@returns(200) The storage account credential properties.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}\n@desc Creates or updates the storage account credential.\n@required {deviceName: any # The device name., name: any # The storage account credential name., storageAccountCredential: map # The storage account credential.}\n@returns(200) Successfully created or updated the storage account credential.\n@returns(202) Accepted the request to create or update the storage account credential.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}\n@desc Deletes the storage account credential.\n@required {deviceName: any # The device name., name: any # The storage account credential name.}\n@returns(200) Successfully deleted the storage account credential.\n@returns(202) Accepted the request to delete the storage account credential.\n@returns(204) The storage account credential is already deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers\n@desc Lists all the triggers configured in the device.\n@required {deviceName: any # The device name.}\n@optional {$expand: any # Specify $filter='CustomContextTag eq ' to filter on custom context tag property}\n@returns(200) List all the triggers configured in the device\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}\n@desc Get a specific trigger by name.\n@required {deviceName: any # The device name., name: any # The trigger name.}\n@returns(200) The trigger.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}\n@desc Creates or updates a trigger.\n@required {deviceName: any # Creates or updates a trigger, name: any # The trigger name., trigger: map # The trigger.}\n@returns(200) Successfully created or updated the trigger.\n@returns(202) Accepted the request to create or update the trigger.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}\n@desc Deletes the trigger on the gateway device.\n@required {deviceName: any # The device name., name: any # The trigger name.}\n@returns(200) Successfully deleted the trigger.\n@returns(202) Accepted the request to delete the trigger.\n@returns(204) The trigger is already deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default\n@desc Gets 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.\n@required {deviceName: any # The device name.}\n@returns(200) The update summary.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate\n@desc Uploads registration certificate for the device.\n@required {deviceName: any # The device name., parameters: map # The upload certificate request.}\n@returns(200) Successfully uploaded the registration certificate.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users\n@desc Gets all the users registered on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name.}\n@returns(200) The collection of all users on the device.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}\n@desc Gets the properties of the specified user.\n@required {deviceName: any # The device name., name: any # The user name.}\n@returns(200) The user details.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}\n@desc Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.\n@required {deviceName: any # The device name., name: any # The user name., user: map # The user details.}\n@returns(200) Successfully created or updated the user.\n@returns(202) Accepted the request to create or update the user.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}\n@desc Deletes the user on a databox edge/gateway device.\n@required {deviceName: any # The device name., name: any # The user name.}\n@returns(200) Successfully deleted the user.\n@returns(202) Accepted the request to delete the user.\n@returns(204) The user is already deleted.\n\n@endgroup\n\n@end\n"}