Operations - List

Reference

Service:: Data Box Edge/Data Box Gateway

API Version:: 2021-02-01

List all the supported operations.

GET https://management.azure.com/providers/Microsoft.DataBoxEdge/operations?api-version=2021-02-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version.

Responses

Name	Type	Description
200 OK	OperationsList	List of supported operations.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

OperationsGet

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.DataBoxEdge/operations?api-version=2021-02-01

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "share users",
        "operation": "List share users",
        "description": "Lists or gets the share users"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "share users",
        "operation": "List share users",
        "description": "Lists or gets the share users"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "share users",
        "operation": "Creates or updates share users",
        "description": "Creates or updates the share users"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "share users",
        "operation": "Delete share users",
        "description": "Deletes the share users"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "bandwidth schedules",
        "operation": "List bandwidth schedules",
        "description": "Lists or gets the bandwidth schedules"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "bandwidth schedules",
        "operation": "List bandwidth schedules",
        "description": "Lists or gets the bandwidth schedules"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "bandwidth schedules",
        "operation": "Creates or updates bandwidth schedules",
        "description": "Creates or updates the bandwidth schedules"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "bandwidth schedules",
        "operation": "Delete bandwidth schedules",
        "description": "Deletes the bandwidth schedules"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "ArmApiRes_roles",
        "operation": "List ArmApiRes_roles",
        "description": "Lists or gets the ArmApiRes_roles"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "ArmApiRes_roles",
        "operation": "List ArmApiRes_roles",
        "description": "Lists or gets the ArmApiRes_roles"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "ArmApiRes_roles",
        "operation": "Creates or updates ArmApiRes_roles",
        "description": "Creates or updates the ArmApiRes_roles"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "ArmApiRes_roles",
        "operation": "Delete ArmApiRes_roles",
        "description": "Deletes the ArmApiRes_roles"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "shares",
        "operation": "List shares",
        "description": "Lists or gets the shares"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "shares",
        "operation": "List shares",
        "description": "Lists or gets the shares"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "shares",
        "operation": "Creates or updates shares",
        "description": "Creates or updates the shares"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "shares",
        "operation": "ArmApiOp_action_refresh_shares",
        "description": "ArmApiDesc_action_refresh_shares"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "shares",
        "operation": "Delete shares",
        "description": "Deletes the shares"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Upload certificates",
        "description": "Upload certificate for device registration"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Creates or updates Data Box Edge devices",
        "description": "Creates or updates the Data Box Edge devices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "List Data Box Edge devices",
        "description": "Lists or gets the Data Box Edge devices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Delete Data Box Edge devices",
        "description": "Deletes the Data Box Edge devices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "List Data Box Edge devices",
        "description": "Lists or gets the Data Box Edge devices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "List Data Box Edge devices",
        "description": "Lists or gets the Data Box Edge devices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Creates or updates Data Box Edge devices",
        "description": "Creates or updates the Data Box Edge devices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices",
        "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Gets resource extended information",
        "description": "Retrieves resource extended information"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Device network settings",
        "operation": "List Device network settings",
        "description": "Lists or gets the Device network settings"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Device security settings",
        "operation": "Update security settings",
        "description": "Update security settings"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "update summary",
        "operation": "List update summary",
        "description": "Lists or gets the update summary"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Scan for updates",
        "description": "Scan for updates"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Download Updates",
        "description": "Download Updates in device"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge devices",
        "operation": "Install Updates",
        "description": "Install Updates on device"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "jobs",
        "operation": "List jobs",
        "description": "Lists or gets the jobs"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "storage account credentials",
        "operation": "Creates or updates storage account credentials",
        "description": "Creates or updates the storage account credentials"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "storage account credentials",
        "operation": "List storage account credentials",
        "description": "Lists or gets the storage account credentials"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "storage account credentials",
        "operation": "List storage account credentials",
        "description": "Lists or gets the storage account credentials"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "storage account credentials",
        "operation": "Delete storage account credentials",
        "description": "Deletes the storage account credentials"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "alerts",
        "operation": "List alerts",
        "description": "Lists or gets the alerts"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "alerts",
        "operation": "List alerts",
        "description": "Lists or gets the alerts"
      },
      "origin": "user"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge device",
        "operation": "Read Data Box Edge device metric definition",
        "description": "Gets the available Data Box Edge device level metrics"
      },
      "origin": "system",
      "properties": {
        "serviceSpecification": {
          "metricSpecifications": [
            {
              "name": "NICReadThroughput",
              "displayName": "Read Throughput (Network)",
              "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.",
              "unit": "BytesPerSecond",
              "aggregationType": "Average",
              "dimensions": [
                {
                  "name": "InstanceName",
                  "displayName": "Name",
                  "toBeExportedForShoebox": true
                }
              ],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT1M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "NICWriteThroughput",
              "displayName": "Write Throughput (Network)",
              "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.",
              "unit": "BytesPerSecond",
              "aggregationType": "Average",
              "dimensions": [
                {
                  "name": "InstanceName",
                  "displayName": "Name",
                  "toBeExportedForShoebox": true
                }
              ],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT1M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "CloudReadThroughputPerShare",
              "displayName": "Cloud Download Throughput (Share)",
              "displayDescription": "The download throughput to Azure from a share during the reporting period.",
              "unit": "BytesPerSecond",
              "aggregationType": "Average",
              "dimensions": [
                {
                  "name": "Share",
                  "displayName": "Share",
                  "toBeExportedForShoebox": true
                }
              ],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT1M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "CloudUploadThroughputPerShare",
              "displayName": "Cloud Upload Throughput (Share)",
              "displayDescription": "The upload throughput to Azure from a share during the reporting period.",
              "unit": "BytesPerSecond",
              "aggregationType": "Average",
              "dimensions": [
                {
                  "name": "Share",
                  "displayName": "Share",
                  "toBeExportedForShoebox": true
                }
              ],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT1M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "BytesUploadedToCloudPerShare",
              "displayName": "Cloud Bytes Uploaded (Share)",
              "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.",
              "unit": "Bytes",
              "aggregationType": "Average",
              "dimensions": [
                {
                  "name": "Share",
                  "displayName": "Share",
                  "toBeExportedForShoebox": true
                }
              ],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT1M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "TotalCapacity",
              "displayName": "Total Capacity",
              "displayDescription": "Total Capacity",
              "unit": "Bytes",
              "aggregationType": "Average",
              "dimensions": [],
              "fillGapWithZero": false,
              "category": "Capacity",
              "supportedTimeGrainTypes": [
                "PT5M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "AvailableCapacity",
              "displayName": "Available Capacity",
              "displayDescription": "The available capacity in bytes during the reporting period.",
              "unit": "Bytes",
              "aggregationType": "Average",
              "dimensions": [],
              "fillGapWithZero": false,
              "category": "Capacity",
              "supportedTimeGrainTypes": [
                "PT5M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "CloudUploadThroughput",
              "displayName": "Cloud Upload Throughput",
              "displayDescription": "The cloud upload throughput during the reporting period.",
              "unit": "BytesPerSecond",
              "aggregationType": "Average",
              "dimensions": [],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT5M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "CloudReadThroughput",
              "displayName": "Cloud Read Throughput",
              "displayDescription": "The cloud download throughput during the reporting period.",
              "unit": "BytesPerSecond",
              "aggregationType": "Average",
              "dimensions": [],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT5M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            },
            {
              "name": "BytesUploadedToCloud",
              "displayName": "Cloud Bytes Uploaded (Device)",
              "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.",
              "unit": "Bytes",
              "aggregationType": "Average",
              "dimensions": [],
              "fillGapWithZero": false,
              "category": "Transaction",
              "supportedTimeGrainTypes": [
                "PT5M",
                "PT15M",
                "PT1H"
              ],
              "supportedAggregationTypes": [
                "Average",
                "Minimum",
                "Maximum"
              ]
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge device",
        "operation": "Write diagnostics setting",
        "description": "Creates or updates the diagnostics setting for the resource"
      },
      "origin": "system"
    },
    {
      "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft.DataBoxEdge",
        "resource": "Data Box Edge device",
        "operation": "Read diagnostics setting",
        "description": "Gets the diagnostic setting for the resource"
      },
      "origin": "system"
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
MetricAggregationType	Metric aggregation type.
MetricCategory	Metric category.
MetricDimension_V1	Metric Dimension v1.
MetricSpecification_V1	Metric specification version 1.
MetricUnit	Metric units.
Operation	Operations.
OperationDisplay	Operation display properties.
OperationsList	The list of operations used for the discovery of available provider operations.
ServiceSpecification	Service specification.
TimeGrain	Support granularity of metrics.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	The error details.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.

MetricAggregationType

Metric aggregation type.

Name	Type	Description
Average	string
Count	string
Maximum	string
Minimum	string
None	string
NotSpecified	string
Total	string

MetricCategory

Metric category.

Name	Type	Description
Capacity	string
Transaction	string

MetricDimension_V1

Metric Dimension v1.

Name	Type	Description
displayName	string	Display name of the metrics dimension.
name	string	Name of the metrics dimension.
toBeExportedForShoebox	boolean	To be exported to shoe box.

MetricSpecification_V1

Metric specification version 1.

Name	Type	Description
aggregationType	MetricAggregationType	Metric aggregation type.
category	MetricCategory	Metric category.
dimensions	MetricDimension_V1[]	Metric dimensions, other than default dimension which is resource.
displayDescription	string	Description of the metric to be displayed.
displayName	string	Display name of the metric.
fillGapWithZero	boolean	Set true to fill the gaps with zero.
name	string	Name of the metric.
resourceIdDimensionNameOverride	string	Resource name override.
supportedAggregationTypes	MetricAggregationType[]	Support metric aggregation type.
supportedTimeGrainTypes	TimeGrain[]	Support granularity of metrics.
unit	MetricUnit	Metric units.

MetricUnit

Metric units.

Name	Type	Description
Bytes	string
BytesPerSecond	string
Count	string
CountPerSecond	string
Milliseconds	string
NotSpecified	string
Percent	string
Seconds	string

Operation

Operations.

Name	Type	Description
display	OperationDisplay	Properties displayed for the operation.
isDataAction	boolean	Is data action.
name	string	Name of the operation.
origin	string	Origin of the operation.
properties.serviceSpecification	ServiceSpecification	Service specification.

OperationDisplay

Operation display properties.

Name	Type	Description
description	string	Description of the operation to be performed.
operation	string	Operation to be performed on the resource.
provider	string	Provider name.
resource	string	The type of resource in which the operation is performed.

OperationsList

The list of operations used for the discovery of available provider operations.

Name	Type	Description
nextLink	string	Link to the next set of results.
value	Operation[]	The value.

ServiceSpecification

Service specification.

Name	Type	Description
metricSpecifications	MetricSpecification_V1[]	Metric specification as defined by shoebox.

TimeGrain

Support granularity of metrics.

Name	Type	Description
PT12H	string
PT15M	string
PT1D	string
PT1H	string
PT1M	string
PT30M	string
PT5M	string
PT6H	string

Share via